org.apache.lucene.document
Interface Fieldable
- Serializable
- AbstractField, Field
public interface Fieldable
extends Serializable
byte[] | binaryValue() - The value of the field in Binary, or null.
|
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() - Indicates whether a Field is Lazy or not.
|
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.
|
Reader | readerValue() - The value of the field as a Reader, or null.
|
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.
|
String | stringValue() - The value of the field as a String, or null.
|
binaryValue
public byte[] binaryValue()
The value of the field in Binary, or null. If null, the Reader or
String value is used. Exactly one of stringValue(), readerValue() and
binaryValue() must be set.
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.
getOmitNorms
public boolean getOmitNorms()
True if norms are omitted for this indexed field
isBinary
public boolean isBinary()
True iff the value of the filed is stored as binary
isCompressed
public boolean isCompressed()
True if the value of the field is stored and compressed within the index
isIndexed
public boolean isIndexed()
True iff the value of the field is to be indexed, so that it may be
searched on.
isLazy
public boolean isLazy()
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
stringValue()
or
binaryValue()
is only valid as long as the
IndexReader
that
retrieved the
Document
is still open.
- true if this field can be loaded lazily
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.
isStored
public 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.
isTermVectorStored
public 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.
isTokenized
public 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", ...
readerValue
public Reader readerValue()
The value of the field as a Reader, or null. If null, the String value
or binary value is used. Exactly one of stringValue(), readerValue(),
and binaryValue() must be set.
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.
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.
stringValue
public String stringValue()
The value of the field as a String, or null. If null, the Reader value
or binary value is used. Exactly one of stringValue(), readerValue(), and
binaryValue() must be set.
Copyright © 2000-2007 Apache Software Foundation. All Rights Reserved.