FileDocCategorySizeDatePackage
Fieldable.javaAPI DocApache Lucene 2.2.05912Sat Jun 16 22:20:38 BST 2007org.apache.lucene.document

Fieldable

public interface Fieldable implements Serializable
Synonymous with {@link Field}.

Fields Summary
Constructors Summary
Methods Summary
public 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.

public floatgetBoost()
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 {@link org.apache.lucene.index.IndexReader#document(int)} and {@link org.apache.lucene.search.Hits#doc(int)} may thus not have the same value present as when this field was indexed.

see
#setBoost(float)

public booleangetOmitNorms()
True if norms are omitted for this indexed field

public booleanisBinary()
True iff the value of the filed is stored as binary

public booleanisCompressed()
True if the value of the field is stored and compressed within the index

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

public booleanisLazy()
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 {@link #stringValue()} or {@link #binaryValue()} is only valid as long as the {@link org.apache.lucene.index.IndexReader} that retrieved the {@link Document} is still open.

return
true if this field can be loaded lazily

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

public booleanisStorePositionWithTermVector()
True iff terms are stored as term vector together with their token positions.

public booleanisStored()
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.

public booleanisTermVectorStored()
True iff the term or terms used to index this field are stored as a term vector, available from {@link org.apache.lucene.index.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
org.apache.lucene.index.IndexReader#getTermFreqVector(int, String)

public booleanisTokenized()
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.

public java.lang.Stringname()
Returns the name of the field as an interned string. For example "date", "title", "body", ...

public java.io.ReaderreaderValue()
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.

public voidsetBoost(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 {@link org.apache.lucene.document.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 {@link org.apache.lucene.search.Similarity#lengthNorm(String,int)}, and rounded by {@link org.apache.lucene.search.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
org.apache.lucene.document.Document#setBoost(float)
see
org.apache.lucene.search.Similarity#lengthNorm(String, int)
see
org.apache.lucene.search.Similarity#encodeNorm(float)

public voidsetOmitNorms(boolean omitNorms)
Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.

public java.lang.StringstringValue()
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.

public org.apache.lucene.analysis.TokenStreamtokenStreamValue()
The value of the field as a TokesStream, 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.