Class PositionIncrementAttributeImpl
- java.lang.Object
-
- org.apache.lucene.util.AttributeImpl
-
- org.apache.lucene.analysis.tokenattributes.PositionIncrementAttributeImpl
-
- All Implemented Interfaces:
Cloneable,PositionIncrementAttribute,Attribute
public class PositionIncrementAttributeImpl extends AttributeImpl implements PositionIncrementAttribute
Default implementation ofPositionIncrementAttribute.
-
-
Constructor Summary
Constructors Constructor Description PositionIncrementAttributeImpl()Initialize this attribute with position increment of 1
-
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.voidcopyTo(AttributeImpl target)Copies the values from this Attribute into the passed-in target attribute.voidend()Clears the values in this AttributeImpl and resets it to its value at the end of the field.booleanequals(Object other)intgetPositionIncrement()Returns the position increment of this Token.inthashCode()voidreflectWith(AttributeReflector reflector)This method is for introspection of attributes, it should simply add the key/values this attribute holds to the givenAttributeReflector.voidsetPositionIncrement(int positionIncrement)Set the position increment.-
Methods inherited from class org.apache.lucene.util.AttributeImpl
clone, reflectAsString
-
-
-
-
Method Detail
-
setPositionIncrement
public void setPositionIncrement(int positionIncrement)
Description copied from interface:PositionIncrementAttributeSet the position increment. The default value is one.- Specified by:
setPositionIncrementin interfacePositionIncrementAttribute- Parameters:
positionIncrement- the distance from the prior term- See Also:
PositionIncrementAttribute.getPositionIncrement()
-
getPositionIncrement
public int getPositionIncrement()
Description copied from interface:PositionIncrementAttributeReturns the position increment of this Token.- Specified by:
getPositionIncrementin interfacePositionIncrementAttribute- See Also:
PositionIncrementAttribute.setPositionIncrement(int)
-
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
-
end
public void end()
Description copied from class:AttributeImplClears the values in this AttributeImpl and resets it to its value at the end of the field. If this implementation implements more than one Attribute interface it clears all.The default implementation simply calls
AttributeImpl.clear()- Overrides:
endin 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
-
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)
-
-