java.lang.Object
org.apache.lucene.index.FieldInvertState
This class tracks the number and position / offset parameters of terms being added to the index.
The information collected in this class is also used to calculate the normalization factor for a
field.
-
Field Summary
FieldsModifier and TypeFieldDescription(package private) AttributeSource
(package private) final int
(package private) final IndexOptions
(package private) int
(package private) int
(package private) int
(package private) int
(package private) final String
(package private) int
(package private) int
(package private) OffsetAttribute
(package private) PayloadAttribute
(package private) PositionIncrementAttribute
(package private) int
(package private) TermToBytesRefAttribute
(package private) TermFrequencyAttribute
(package private) int
-
Constructor Summary
ConstructorsConstructorDescriptionFieldInvertState
(int indexCreatedVersionMajor, String name, IndexOptions indexOptions) Creates {code FieldInvertState} for the specified field name.FieldInvertState
(int indexCreatedVersionMajor, String name, IndexOptions indexOptions, int position, int length, int numOverlap, int offset, int maxTermFrequency, int uniqueTermCount) Creates {code FieldInvertState} for the specified field name and values for all fields. -
Method Summary
Modifier and TypeMethodDescriptionReturns theAttributeSource
from theTokenStream
that provided the indexed tokens for this field.int
Return the version that was used to create the index, or 6 if it was created before 7.0.Get the index options for this fieldint
Get total number of terms in this field.int
Get the maximum term-frequency encountered for any term in the field.getName()
Return the field's nameint
Get the number of terms withpositionIncrement == 0
.int
Get end offset of the last processed term.int
Get the last processed term position.int
Return the number of unique terms encountered in this field.(package private) void
reset()
Re-initialize the state(package private) void
setAttributeSource
(AttributeSource attributeSource) Sets attributeSource to a new instance.void
setLength
(int length) Set length value.void
setNumOverlap
(int numOverlap) Set number of terms withpositionIncrement == 0
.
-
Field Details
-
indexCreatedVersionMajor
final int indexCreatedVersionMajor -
name
-
indexOptions
-
position
int position -
length
int length -
numOverlap
int numOverlap -
offset
int offset -
maxTermFrequency
int maxTermFrequency -
uniqueTermCount
int uniqueTermCount -
lastStartOffset
int lastStartOffset -
lastPosition
int lastPosition -
attributeSource
AttributeSource attributeSource -
offsetAttribute
OffsetAttribute offsetAttribute -
posIncrAttribute
PositionIncrementAttribute posIncrAttribute -
payloadAttribute
PayloadAttribute payloadAttribute -
termAttribute
TermToBytesRefAttribute termAttribute -
termFreqAttribute
TermFrequencyAttribute termFreqAttribute
-
-
Constructor Details
-
FieldInvertState
Creates {code FieldInvertState} for the specified field name. -
FieldInvertState
public FieldInvertState(int indexCreatedVersionMajor, String name, IndexOptions indexOptions, int position, int length, int numOverlap, int offset, int maxTermFrequency, int uniqueTermCount) Creates {code FieldInvertState} for the specified field name and values for all fields.
-
-
Method Details
-
reset
void reset()Re-initialize the state -
setAttributeSource
Sets attributeSource to a new instance. -
getPosition
public int getPosition()Get the last processed term position.- Returns:
- the position
-
getLength
public int getLength()Get total number of terms in this field.- Returns:
- the length
-
setLength
public void setLength(int length) Set length value. -
getNumOverlap
public int getNumOverlap()Get the number of terms withpositionIncrement == 0
.- Returns:
- the numOverlap
-
setNumOverlap
public void setNumOverlap(int numOverlap) Set number of terms withpositionIncrement == 0
. -
getOffset
public int getOffset()Get end offset of the last processed term.- Returns:
- the offset
-
getMaxTermFrequency
public int getMaxTermFrequency()Get the maximum term-frequency encountered for any term in the field. A field containing "the quick brown fox jumps over the lazy dog" would have a value of 2, because "the" appears twice. -
getUniqueTermCount
public int getUniqueTermCount()Return the number of unique terms encountered in this field. -
getAttributeSource
Returns theAttributeSource
from theTokenStream
that provided the indexed tokens for this field. -
getName
Return the field's name -
getIndexCreatedVersionMajor
public int getIndexCreatedVersionMajor()Return the version that was used to create the index, or 6 if it was created before 7.0. -
getIndexOptions
Get the index options for this field
-