Class BytesTermAttributeImpl
- java.lang.Object
-
- org.apache.lucene.util.AttributeImpl
-
- org.apache.lucene.analysis.tokenattributes.BytesTermAttributeImpl
-
- All Implemented Interfaces:
Cloneable,BytesTermAttribute,TermToBytesRefAttribute,Attribute
public class BytesTermAttributeImpl extends AttributeImpl implements BytesTermAttribute, TermToBytesRefAttribute
Implementation class forBytesTermAttribute.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
-
Constructor Summary
Constructors Constructor Description BytesTermAttributeImpl()Initialize this attribute with no bytes.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description voidclear()Clears the values in this AttributeImpl and resets it to its default value.AttributeImplclone()In most cases the clone is, and should be, deep in order to be able to properly capture the state of all attributes.voidcopyTo(AttributeImpl target)Copies the values from this Attribute into the passed-in target attribute.booleanequals(Object o)BytesRefgetBytesRef()Retrieve this attribute's BytesRef.inthashCode()voidreflectWith(AttributeReflector reflector)This method is for introspection of attributes, it should simply add the key/values this attribute holds to the givenAttributeReflector.voidsetBytesRef(BytesRef bytes)Sets theBytesRefof the term-
Methods inherited from class org.apache.lucene.util.AttributeImpl
end, reflectAsString
-
-
-
-
Method Detail
-
getBytesRef
public BytesRef getBytesRef()
Description copied from interface:TermToBytesRefAttributeRetrieve this attribute's BytesRef. The bytes are updated from the current term. The implementation may return a new instance or keep the previous one.- Specified by:
getBytesRefin interfaceTermToBytesRefAttribute- Returns:
- a BytesRef to be indexed (only stays valid until token stream gets incremented)
-
setBytesRef
public void setBytesRef(BytesRef bytes)
Description copied from interface:BytesTermAttributeSets theBytesRefof the term- Specified by:
setBytesRefin interfaceBytesTermAttribute
-
clear
public void clear()
Description copied from class:AttributeImplClears the values in this AttributeImpl and resets it to its default value. If this implementation implements more than one Attribute interface it clears all.- Specified by:
clearin classAttributeImpl
-
copyTo
public void copyTo(AttributeImpl target)
Description copied from class:AttributeImplCopies the values from this Attribute into the passed-in target attribute. The target implementation must support all the Attributes this implementation supports.- Specified by:
copyToin classAttributeImpl
-
clone
public AttributeImpl clone()
Description copied from class:AttributeImplIn most cases the clone is, and should be, deep in order to be able to properly capture the state of all attributes.- Overrides:
clonein classAttributeImpl
-
reflectWith
public void reflectWith(AttributeReflector reflector)
Description copied from class:AttributeImplThis method is for introspection of attributes, it should simply add the key/values this attribute holds to the givenAttributeReflector.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
Attributeinterfaces and keys are passed toAttributeReflector.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.nullproperties!- Specified by:
reflectWithin classAttributeImpl- See Also:
AttributeImpl.reflectAsString(boolean)
-
-