org.apache.lucene.document
Class AbstractField
- Fieldable, Serializable
public abstract class AbstractField
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.
|
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
AbstractField
protected AbstractField()
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.document(int)
and
Hits.doc(int)
may thus not have the same value present as when
this field was indexed.
- getBoost in interface Fieldable
getOmitNorms
public boolean getOmitNorms()
True if norms are omitted for this indexed field
- getOmitNorms in interface Fieldable
isBinary
public final boolean isBinary()
True iff the value of the filed is stored as binary
- isBinary in interface Fieldable
isCompressed
public final boolean isCompressed()
True if the value of the field is stored and compressed within the index
- 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.
- isIndexed 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).
- isStoreOffsetWithTermVector in interface Fieldable
isStorePositionWithTermVector
public boolean isStorePositionWithTermVector()
True iff terms are stored as term vector together with their token positions.
- 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.
- 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.
- 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.
- isTokenized in interface Fieldable
name
public String name()
Returns the name of the field as an interned string.
For example "date", "title", "body", ...
- 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.
- 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.
- 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.