public class PackedTokenAttributeImpl extends CharTermAttributeImpl implements TypeAttribute, PositionIncrementAttribute, PositionLengthAttribute, OffsetAttribute, TermFrequencyAttribute
builder
DEFAULT_TYPE
Constructor and Description |
---|
PackedTokenAttributeImpl()
Constructs the attribute implementation.
|
Modifier and Type | Method and Description |
---|---|
void |
clear()
Resets the attributes
|
PackedTokenAttributeImpl |
clone()
In most cases the clone is, and should be, deep in order to be able to
properly capture the state of all attributes.
|
void |
copyTo(AttributeImpl target)
Copies the values from this Attribute into the passed-in
target attribute.
|
void |
end()
Resets the attributes at end
|
int |
endOffset()
Returns this Token's ending offset, one greater than the position of the
last character corresponding to this token in the source text.
|
boolean |
equals(Object obj) |
int |
getPositionIncrement()
Returns the position increment of this Token.
|
int |
getPositionLength()
Returns the position length of this Token.
|
int |
getTermFrequency()
Returns the custom term frequencey.
|
int |
hashCode() |
void |
reflectWith(AttributeReflector reflector)
This method is for introspection of attributes, it should simply
add the key/values this attribute holds to the given
AttributeReflector . |
void |
setOffset(int startOffset,
int endOffset)
Set the starting and ending offset.
|
void |
setPositionIncrement(int positionIncrement)
Set the position increment.
|
void |
setPositionLength(int positionLength)
Set the position length of this Token.
|
void |
setTermFrequency(int termFrequency)
Set the custom term frequency of the current term within one document.
|
void |
setType(String type)
Set the lexical type.
|
int |
startOffset()
Returns this Token's starting offset, the position of the first character
corresponding to this token in the source text.
|
String |
type()
Returns this Token's lexical type.
|
append, append, append, append, append, append, buffer, charAt, copyBuffer, getBytesRef, length, resizeBuffer, setEmpty, setLength, subSequence, toString
reflectAsString
finalize, getClass, notify, notifyAll, wait, wait, wait
chars, codePoints
public PackedTokenAttributeImpl()
public void setPositionIncrement(int positionIncrement)
setPositionIncrement
in interface PositionIncrementAttribute
positionIncrement
- the distance from the prior termPositionIncrementAttribute
public int getPositionIncrement()
getPositionIncrement
in interface PositionIncrementAttribute
PositionIncrementAttribute
public void setPositionLength(int positionLength)
The default value is one.
setPositionLength
in interface PositionLengthAttribute
positionLength
- how many positions this token
spans.PositionLengthAttribute
public int getPositionLength()
getPositionLength
in interface PositionLengthAttribute
PositionLengthAttribute
public final int startOffset()
Note that the difference between OffsetAttribute.endOffset()
and startOffset()
may not be equal to termText.length(), as the term text may have been altered by a
stemmer or some other filter.
startOffset
in interface OffsetAttribute
OffsetAttribute
public final int endOffset()
endOffset()
- OffsetAttribute.startOffset()
).endOffset
in interface OffsetAttribute
OffsetAttribute
public void setOffset(int startOffset, int endOffset)
setOffset
in interface OffsetAttribute
OffsetAttribute
public final String type()
type
in interface TypeAttribute
TypeAttribute
public final void setType(String type)
setType
in interface TypeAttribute
TypeAttribute
public final void setTermFrequency(int termFrequency)
TermFrequencyAttribute
setTermFrequency
in interface TermFrequencyAttribute
public final int getTermFrequency()
TermFrequencyAttribute
getTermFrequency
in interface TermFrequencyAttribute
public void clear()
clear
in class CharTermAttributeImpl
public void end()
end
in class AttributeImpl
public PackedTokenAttributeImpl clone()
AttributeImpl
clone
in class CharTermAttributeImpl
public boolean equals(Object obj)
equals
in class CharTermAttributeImpl
public int hashCode()
hashCode
in class CharTermAttributeImpl
public void copyTo(AttributeImpl target)
AttributeImpl
copyTo
in class CharTermAttributeImpl
public void reflectWith(AttributeReflector reflector)
AttributeImpl
AttributeReflector
.
Implementations look like this (e.g. for a combined attribute implementation):
public void reflectWith(AttributeReflector reflector) { reflector.reflect(CharTermAttribute.class, "term", term()); reflector.reflect(PositionIncrementAttribute.class, "positionIncrement", getPositionIncrement()); }
If you implement this method, make sure that for each invocation, the same set of Attribute
interfaces and keys are passed to AttributeReflector.reflect(java.lang.Class<? extends org.apache.lucene.util.Attribute>, java.lang.String, java.lang.Object)
in the same order, but possibly
different values. So don't automatically exclude e.g. null
properties!
reflectWith
in class CharTermAttributeImpl
AttributeImpl.reflectAsString(boolean)
Copyright © 2000-2019 Apache Software Foundation. All Rights Reserved.