org.apache.lucene.document

Class AbstractField

public abstract class AbstractField extends Object implements Fieldable

Field Summary
protected floatboost
protected ObjectfieldsData
protected booleanisBinary
protected booleanisCompressed
protected booleanisIndexed
protected booleanisStored
protected booleanisTokenized
protected booleanlazy
protected Stringname
protected booleanomitNorms
protected booleanstoreOffsetWithTermVector
protected booleanstorePositionWithTermVector
protected booleanstoreTermVector
Constructor Summary
protected AbstractField()
protected AbstractField(String name, Field.Store store, Field.Index index, Field.TermVector termVector)
Method Summary
floatgetBoost()
Returns the boost factor for hits for this field.
booleangetOmitNorms()
True if norms are omitted for this indexed field
booleanisBinary()
True iff the value of the filed is stored as binary
booleanisCompressed()
True if the value of the field is stored and compressed within the index
booleanisIndexed()
True iff the value of the field is to be indexed, so that it may be searched on.
booleanisLazy()
booleanisStored()
True iff the value of the field is to be stored in the index for return with search hits.
booleanisStoreOffsetWithTermVector()
True iff terms are stored as term vector together with their offsets (start and end positon in source text).
booleanisStorePositionWithTermVector()
True iff terms are stored as term vector together with their token positions.
booleanisTermVectorStored()
True iff the term or terms used to index this field are stored as a term vector, available from IndexReader.
booleanisTokenized()
True iff the value of the field should be tokenized as text prior to indexing.
Stringname()
Returns the name of the field as an interned string.
voidsetBoost(float boost)
Sets the boost factor hits on this field.
voidsetOmitNorms(boolean omitNorms)
Expert: If set, omit normalization factors associated with this indexed field.
protected voidsetStoreTermVector(Field.TermVector termVector)
StringtoString()
Prints a Field for human consumption.

Field Detail

boost

protected float boost

fieldsData

protected Object fieldsData

isBinary

protected boolean isBinary

isCompressed

protected boolean isCompressed

isIndexed

protected boolean isIndexed

isStored

protected boolean isStored

isTokenized

protected boolean isTokenized

lazy

protected boolean lazy

name

protected String name

omitNorms

protected boolean omitNorms

storeOffsetWithTermVector

protected boolean storeOffsetWithTermVector

storePositionWithTermVector

protected boolean storePositionWithTermVector

storeTermVector

protected boolean storeTermVector

Constructor Detail

AbstractField

protected AbstractField()

AbstractField

protected AbstractField(String name, Field.Store store, Field.Index index, Field.TermVector termVector)

Method Detail

getBoost

public 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 and Hits may thus not have the same value present as when this field was indexed.

See Also: AbstractField

getOmitNorms

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

isBinary

public final boolean isBinary()
True iff the value of the filed is stored as binary

isCompressed

public final boolean isCompressed()
True if the value of the field is stored and compressed within the index

isIndexed

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

isLazy

public boolean isLazy()

isStored

public final 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.

isStoreOffsetWithTermVector

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

isStorePositionWithTermVector

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

isTermVectorStored

public final boolean isTermVectorStored()
True iff the term or terms used to index this field are stored as a term vector, available from IndexReader. 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

isTokenized

public final 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.

name

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

setBoost

public 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 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, and rounded by Similarity 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 Similarity Similarity

setOmitNorms

public 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.

setStoreTermVector

protected void setStoreTermVector(Field.TermVector termVector)

toString

public final String toString()
Prints a Field for human consumption.
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.