org.apache.lucene.document

Class AbstractField

Implemented Interfaces:
Fieldable, Serializable
Known Direct Subclasses:
Field

public abstract class AbstractField
extends Object
implements Fieldable

Field Summary

protected float
boost
protected Object
fieldsData
protected boolean
isBinary
protected boolean
isCompressed
protected boolean
isIndexed
protected boolean
isStored
protected boolean
isTokenized
protected boolean
lazy
protected String
name
protected boolean
omitNorms
protected boolean
storeOffsetWithTermVector
protected boolean
storePositionWithTermVector
protected boolean
storeTermVector

Constructor Summary

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

Method Summary

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()
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 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.
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.
protected void
setStoreTermVector(Field.TermVector termVector)
String
toString()
Prints a Field for human consumption.

Field Details

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 Details

AbstractField

protected AbstractField()

AbstractField

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

Method Details

getBoost

public float getBoost()
Specified by:
getBoost in interface Fieldable

getOmitNorms

public boolean getOmitNorms()
True if norms are omitted for this indexed field
Specified by:
getOmitNorms in interface Fieldable

isBinary

public final boolean isBinary()
True iff the value of the filed is stored as binary
Specified by:
isBinary in interface Fieldable

isCompressed

public final boolean isCompressed()
True if the value of the field is stored and compressed within the index
Specified by:
isCompressed in interface Fieldable

isIndexed

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

isLazy

public boolean isLazy()
Specified by:
isLazy in interface Fieldable

isStoreOffsetWithTermVector

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

isStorePositionWithTermVector

public boolean isStorePositionWithTermVector()
True iff terms are stored as term vector together with their token positions.
Specified by:
isStorePositionWithTermVector in interface Fieldable

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.
Specified by:
isStored in interface Fieldable

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.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.
Specified by:
isTermVectorStored in interface Fieldable

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.
Specified by:
isTokenized in interface Fieldable

name

public String name()
Returns the name of the field as an interned string. For example "date", "title", "body", ...
Specified by:
name in interface Fieldable

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

Specified by:
setBoost in interface Fieldable

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.
Specified by:
setOmitNorms in interface Fieldable

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.