| org.apache.lucene.document.Fieldable
All known Subclasses: org.apache.lucene.document.AbstractField, org.apache.lucene.document.Field,
| Method Summary | |
| public byte[] | binaryValue()
The value of the field in Binary, or null. | | float | getBoost()
Returns the boost factor for hits for this field. | | boolean | getOmitNorms()
| | boolean | isBinary()
| | boolean | isCompressed()
| | boolean | isIndexed()
True iff the value of the field is to be indexed, so that it may be
searched on. | | boolean | isLazy()
Indicates whether a Field is Lazy or not. | | boolean | isStoreOffsetWithTermVector()
True iff terms are stored as term vector together with their offsets
(start and end positon in source text). | | boolean | isStorePositionWithTermVector()
True iff terms are stored as term vector together with their token positions. | | boolean | isStored()
True iff the value of the field is to be stored in the index for return
with search hits. | | boolean | isTermVectorStored()
True iff the term or terms used to index this field are stored as a term
vector, available from
org.apache.lucene.index.IndexReader.getTermFreqVector(intString) .
These methods do not provide access to the original content of the field,
only to terms used to index it. | | boolean | isTokenized()
True iff the value of the field should be tokenized as text prior to
indexing. | | String | name()
Returns the name of the field as an interned string. | | public Reader | readerValue()
The value of the field as a Reader, or null. | | void | setBoost(float boost)
Sets the boost factor hits on this field. | | void | setOmitNorms(boolean omitNorms)
Expert:
If set, omit normalization factors associated with this indexed field. | | public String | stringValue()
The value of the field as a String, or null. | | public TokenStream | tokenStreamValue()
The value of the field as a TokenStream, or null. |
| binaryValue | | public byte[] binaryValue()(Code) | | The value of the field in Binary, or null. If null, the Reader value,
String value, or TokenStream value is used. Exactly one of stringValue(),
readerValue(), binaryValue(), and tokenStreamValue() must be set.
|
| getOmitNorms | | boolean getOmitNorms()(Code) | | True if norms are omitted for this indexed field
|
| isBinary | | boolean isBinary()(Code) | | True iff the value of the filed is stored as binary
|
| isCompressed | | boolean isCompressed()(Code) | | True if the value of the field is stored and compressed within the index
|
| isIndexed | | boolean isIndexed()(Code) | | True iff the value of the field is to be indexed, so that it may be
searched on.
|
| isStoreOffsetWithTermVector | | boolean isStoreOffsetWithTermVector()(Code) | | True iff terms are stored as term vector together with their offsets
(start and end positon in source text).
|
| isStorePositionWithTermVector | | boolean isStorePositionWithTermVector()(Code) | | True iff terms are stored as term vector together with their token positions.
|
| isStored | | boolean isStored()(Code) | | True iff the value of the field is to be stored in the index for return
with search hits. It is an error for this to be true if a field is
Reader-valued.
|
| isTokenized | | boolean isTokenized()(Code) | | True iff the value of the field should be tokenized as text prior to
indexing. Un-tokenized fields are indexed as a single word and may not be
Reader-valued.
|
| name | | String name()(Code) | | Returns the name of the field as an interned string.
For example "date", "title", "body", ...
|
| readerValue | | public Reader readerValue()(Code) | | The value of the field as a Reader, or null. If null, the String value,
binary value, or TokenStream value is used. Exactly one of stringValue(),
readerValue(), binaryValue(), and tokenStreamValue() must be set.
|
| setOmitNorms | | void setOmitNorms(boolean omitNorms)(Code) | | Expert:
If set, omit normalization factors associated with this indexed field.
This effectively disables indexing boosts and length normalization for this field.
|
| stringValue | | public String stringValue()(Code) | | The value of the field as a String, or null. If null, the Reader value,
binary value, or TokenStream value is used. Exactly one of stringValue(),
readerValue(), binaryValue(), and tokenStreamValue() must be set.
|
| tokenStreamValue | | public TokenStream tokenStreamValue()(Code) | | The value of the field as a TokenStream, or null. If null, the Reader value,
String value, or binary value is used. Exactly one of stringValue(),
readerValue(), binaryValue(), and tokenStreamValue() must be set.
|
|
|