Package org.apache.lucene.index
Class FieldInvertState
- java.lang.Object
-
- org.apache.lucene.index.FieldInvertState
-
public final class FieldInvertState extends java.lang.Object
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
Fields Modifier and Type Field Description (package private) AttributeSource
attributeSource
(package private) int
indexCreatedVersionMajor
(package private) IndexOptions
indexOptions
(package private) int
lastPosition
(package private) int
lastStartOffset
(package private) int
length
(package private) int
maxTermFrequency
(package private) java.lang.String
name
(package private) int
numOverlap
(package private) int
offset
(package private) OffsetAttribute
offsetAttribute
(package private) PayloadAttribute
payloadAttribute
(package private) PositionIncrementAttribute
posIncrAttribute
(package private) int
position
(package private) TermToBytesRefAttribute
termAttribute
(package private) TermFrequencyAttribute
termFreqAttribute
(package private) int
uniqueTermCount
-
Constructor Summary
Constructors Constructor Description FieldInvertState(int indexCreatedVersionMajor, java.lang.String name, IndexOptions indexOptions)
Creates {code FieldInvertState} for the specified field name.FieldInvertState(int indexCreatedVersionMajor, java.lang.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
All Methods Instance Methods Concrete Methods Modifier and Type Method Description AttributeSource
getAttributeSource()
Returns theAttributeSource
from theTokenStream
that provided the indexed tokens for this field.int
getIndexCreatedVersionMajor()
Return the version that was used to create the index, or 6 if it was created before 7.0.IndexOptions
getIndexOptions()
Get the index options for this fieldint
getLength()
Get total number of terms in this field.int
getMaxTermFrequency()
Get the maximum term-frequency encountered for any term in the field.java.lang.String
getName()
Return the field's nameint
getNumOverlap()
Get the number of terms withpositionIncrement == 0
.int
getOffset()
Get end offset of the last processed term.int
getPosition()
Get the last processed term position.int
getUniqueTermCount()
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 Detail
-
indexCreatedVersionMajor
final int indexCreatedVersionMajor
-
name
final java.lang.String name
-
indexOptions
final IndexOptions 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 Detail
-
FieldInvertState
public FieldInvertState(int indexCreatedVersionMajor, java.lang.String name, IndexOptions indexOptions)
Creates {code FieldInvertState} for the specified field name.
-
FieldInvertState
public FieldInvertState(int indexCreatedVersionMajor, java.lang.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 Detail
-
reset
void reset()
Re-initialize the state
-
setAttributeSource
void setAttributeSource(AttributeSource attributeSource)
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
public AttributeSource getAttributeSource()
Returns theAttributeSource
from theTokenStream
that provided the indexed tokens for this field.
-
getName
public java.lang.String 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
public IndexOptions getIndexOptions()
Get the index options for this field
-
-