org.apache.lucene.document
Interface Fieldable

All Superinterfaces:

Serializable

All Known Implementing Classes:

AbstractField, Field

public interface Fieldable
extends Serializable

Synonymous with Field.

Method Summary

byte[]	binaryValue() The value of the field in Binary, or null.
float	getBoost() Returns the boost factor for hits for this field.
boolean	getOmitNorms() True if norms are omitted for this indexed field
boolean	isBinary() True iff the value of the filed is stored as binary
boolean	isCompressed() True if the value of the field is stored and compressed within the index
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	isStored() True iff the value of the field is to be stored in the index for return with search hits.
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	isTermVectorStored() True iff the term or terms used to index this field are stored as a term vector, available from IndexReader.getTermFreqVector(int,String).
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.
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.
String	stringValue() The value of the field as a String, or null.
TokenStream	tokenStreamValue() The value of the field as a TokenStream, or null.

Method Detail

setBoost

void setBoost(float boost)

Sets the boost factor hits on this field. This value will be multiplied into the score of all hits on this this field of this document.

The boost is multiplied by Document.getBoost() of the document containing this field. If a document has multiple fields with the same name, all such values are multiplied together. This product is then multipled by the value Similarity.lengthNorm(String,int), and rounded by Similarity.encodeNorm(float) before it is stored in the index. One should attempt to ensure that this product does not overflow the range of that encoding.

See Also:

Document.setBoost(float), Similarity.lengthNorm(String, int), Similarity.encodeNorm(float)

getBoost

float getBoost()

Returns the boost factor for hits for this field.

The default value is 1.0.

Note: this value is not stored directly with the document in the index. Documents returned from IndexReader.document(int) and Hits.doc(int) may thus not have the same value present as when this field was indexed.

See Also:

setBoost(float)

name

String name()

Returns the name of the field as an interned string. For example "date", "title", "body", ...

stringValue

String stringValue()

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.

readerValue

Reader readerValue()

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.

binaryValue

byte[] binaryValue()

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.

tokenStreamValue

TokenStream tokenStreamValue()

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.

isStored

boolean isStored()

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.

isIndexed

boolean isIndexed()

True iff the value of the field is to be indexed, so that it may be searched on.

isTokenized

boolean isTokenized()

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.

isCompressed

boolean isCompressed()

True if the value of the field is stored and compressed within the index

isTermVectorStored

boolean isTermVectorStored()

True iff the term or terms used to index this field are stored as a term vector, available from IndexReader.getTermFreqVector(int,String). These methods do not provide access to the original content of the field, only to terms used to index it. If the original content must be preserved, use the stored attribute instead.

See Also:

IndexReader.getTermFreqVector(int, String)

isStoreOffsetWithTermVector

boolean isStoreOffsetWithTermVector()

True iff terms are stored as term vector together with their offsets (start and end positon in source text).

isStorePositionWithTermVector

boolean isStorePositionWithTermVector()

True iff terms are stored as term vector together with their token positions.

isBinary

boolean isBinary()

True iff the value of the filed is stored as binary

getOmitNorms

boolean getOmitNorms()

True if norms are omitted for this indexed field

setOmitNorms

void setOmitNorms(boolean omitNorms)

Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.

isLazy

boolean isLazy()

Indicates whether a Field is Lazy or not. The semantics of Lazy loading are such that if a Field is lazily loaded, retrieving it's values via stringValue() or binaryValue() is only valid as long as the IndexReader that retrieved the Document is still open.

Returns:

true if this field can be loaded lazily