java.lang.Object | |
↳ | org.apache.lucene.document.AbstractField |
Known Direct Subclasses |
Fields | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
binaryLength | |||||||||||
binaryOffset | |||||||||||
boost | |||||||||||
fieldsData | |||||||||||
isBinary | |||||||||||
isIndexed | |||||||||||
isStored | |||||||||||
isTokenized | |||||||||||
lazy | |||||||||||
name | |||||||||||
omitNorms | |||||||||||
omitTermFreqAndPositions | |||||||||||
storeOffsetWithTermVector | |||||||||||
storePositionWithTermVector | |||||||||||
storeTermVector | |||||||||||
tokenStream |
Protected Constructors | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Public Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
Returns length of byte[] segment that is used as value, if Field is not binary
returned value is undefined
| |||||||||||
Returns offset into byte[] segment that is used as value, if Field is not binary
returned value is undefined
| |||||||||||
Return the raw byte[] for the binary field.
| |||||||||||
Return the raw byte[] for the binary field.
| |||||||||||
Returns the boost factor for hits for this field.
| |||||||||||
True if norms are omitted for this indexed field
| |||||||||||
True iff the value of the filed is stored as binary
| |||||||||||
True iff the value of the field is to be indexed, so that it may be
searched on.
| |||||||||||
Indicates whether a Field is Lazy or not.
| |||||||||||
True iff terms are stored as term vector together with their offsets
(start and end position in source text).
| |||||||||||
True iff terms are stored as term vector together with their token positions.
| |||||||||||
True iff the value of the field is to be stored in the index for return
with search hits.
| |||||||||||
True iff the term or terms used to index this field are stored as a term
vector, available from
getTermFreqVector(int, String) . | |||||||||||
True iff the value of the field should be tokenized as text prior to
indexing.
| |||||||||||
Returns the name of the field as an interned string.
| |||||||||||
Sets the boost factor hits on this field.
| |||||||||||
Expert:
If set, omit normalization factors associated with this indexed field.
| |||||||||||
Expert:
If set, omit term freq, positions and payloads from
postings for this field.
| |||||||||||
Prints a Field for human consumption.
|
Protected Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
[Expand]
Inherited Methods | |||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
From class
java.lang.Object
| |||||||||||
From interface
org.apache.lucene.document.Fieldable
|
Returns length of byte[] segment that is used as value, if Field is not binary returned value is undefined
Returns offset into byte[] segment that is used as value, if Field is not binary returned value is undefined
Return the raw byte[] for the binary field. Note that
you must also call getBinaryLength()
and getBinaryOffset()
to know which range of bytes in this
returned array belong to the field.
About reuse: if you pass in the result byte[] and it is
used, likely the underlying implementation will hold
onto this byte[] and return it in future calls to
getBinaryValue()
.
So if you subsequently re-use the same byte[] elsewhere
it will alter this Fieldable's value.
result | User defined buffer that will be used if possible. If this is null or not large enough, a new buffer is allocated |
---|
Return the raw byte[] for the binary field. Note that
you must also call getBinaryLength()
and getBinaryOffset()
to know which range of bytes in this
returned array belong to the field.
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 document(int)
and
doc(int)
may thus not have the same value present as when
this field was indexed.
True if norms are omitted for this indexed field
True iff the value of the filed is stored as binary
True iff the value of the field is to be indexed, so that it may be searched on.
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 getBinaryValue()
is only valid as long as the IndexReader
that
retrieved the Document
is still open.
True iff terms are stored as term vector together with their offsets (start and end position in source text).
True iff terms are stored as term vector together with their token positions.
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.
True iff the term or terms used to index this field are stored as a term
vector, available from 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.
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.
Returns the name of the field as an interned string. For example "date", "title", "body", ...
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
used to compute the norm factor for the field. By
default, in the computeNorm(String, FieldInvertState)
method, the boost value is multipled
by the lengthNorm(String, int)
and then
rounded by 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.
Expert: If set, omit normalization factors associated with this indexed field. This effectively disables indexing boosts and length normalization for this field.
Expert: If set, omit term freq, positions and payloads from postings for this field.
NOTE: While this option reduces storage space
required in the index, it also means any query
requiring positional information, such as PhraseQuery
or SpanQuery
subclasses will
silently fail to find results.