org.apache.lucene.document
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 | |
---|---|
protected | AbstractField() |
protected | 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 | 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.
|
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. |
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
stored
attribute instead.
See Also: IndexReader
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