|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.lucene.document.AbstractField
org.apache.lucene.document.Field
A field is a section of a Document. Each field has two parts, a name and a value. Values may be free text, provided as a String or as a Reader, or they may be atomic keywords, which are not further processed. Such keywords may be used to represent dates, urls, etc. Fields are optionally stored in the index, so that they may be returned with hits on the document.
Nested Class Summary | |
static class |
Field.Index
Specifies whether and how a field should be indexed. |
static class |
Field.Store
Specifies whether and how a field should be stored. |
static class |
Field.TermVector
Specifies whether and how a field should have term vectors. |
Field Summary |
Fields inherited from class org.apache.lucene.document.AbstractField |
boost, fieldsData, isBinary, isCompressed, isIndexed, isStored, isTokenized, lazy, name, omitNorms, storeOffsetWithTermVector, storePositionWithTermVector, storeTermVector |
Constructor Summary | |
Field(String name,
byte[] value,
Field.Store store)
Create a stored field with binary value. |
|
Field(String name,
Reader reader)
Create a tokenized and indexed field that is not stored. |
|
Field(String name,
Reader reader,
Field.TermVector termVector)
Create a tokenized and indexed field that is not stored, optionally with storing term vectors. |
|
Field(String name,
String value,
Field.Store store,
Field.Index index)
Create a field by specifying its name, value and how it will be saved in the index. |
|
Field(String name,
String value,
Field.Store store,
Field.Index index,
Field.TermVector termVector)
Create a field by specifying its name, value and how it will be saved in the index. |
Method Summary | |
byte[] |
binaryValue()
The value of the field in Binary, or null. |
Reader |
readerValue()
The value of the field as a Reader, or null. |
String |
stringValue()
The value of the field as a String, or null. |
Methods inherited from class org.apache.lucene.document.AbstractField |
getBoost, getOmitNorms, isBinary, isCompressed, isIndexed, isLazy, isStored, isStoreOffsetWithTermVector, isStorePositionWithTermVector, isTermVectorStored, isTokenized, name, setBoost, setOmitNorms, setStoreTermVector, toString |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait |
Methods inherited from interface org.apache.lucene.document.Fieldable |
getBoost, getOmitNorms, isBinary, isCompressed, isIndexed, isLazy, isStored, isStoreOffsetWithTermVector, isStorePositionWithTermVector, isTermVectorStored, isTokenized, name, setBoost, setOmitNorms |
Constructor Detail |
public Field(String name, String value, Field.Store store, Field.Index index)
name
- The name of the fieldvalue
- The string to processstore
- Whether value
should be stored in the indexindex
- Whether the field should be indexed, and if so, if it should
be tokenized before indexing
NullPointerException
- if name or value is null
IllegalArgumentException
- if the field is neither stored nor indexedpublic Field(String name, String value, Field.Store store, Field.Index index, Field.TermVector termVector)
name
- The name of the fieldvalue
- The string to processstore
- Whether value
should be stored in the indexindex
- Whether the field should be indexed, and if so, if it should
be tokenized before indexingtermVector
- Whether term vector should be stored
NullPointerException
- if name or value is null
IllegalArgumentException
- in any of the following situations:
TermVector.YES
public Field(String name, Reader reader)
name
- The name of the fieldreader
- The reader with the content
NullPointerException
- if name or reader is null
public Field(String name, Reader reader, Field.TermVector termVector)
name
- The name of the fieldreader
- The reader with the contenttermVector
- Whether term vector should be stored
NullPointerException
- if name or reader is null
public Field(String name, byte[] value, Field.Store store)
name
- The name of the fieldvalue
- The binary valuestore
- How value
should be stored (compressed or not)
IllegalArgumentException
- if store is Store.NO
Method Detail |
public String stringValue()
stringValue
in interface Fieldable
public Reader readerValue()
readerValue
in interface Fieldable
public byte[] binaryValue()
binaryValue
in interface Fieldable
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |