Class TermFrequencyAttributeImpl
java.lang.Object
org.apache.lucene.util.AttributeImpl
org.apache.lucene.analysis.tokenattributes.TermFrequencyAttributeImpl
- All Implemented Interfaces:
Cloneable,TermFrequencyAttribute,Attribute
Default implementation of
TermFrequencyAttribute.-
Constructor Summary
ConstructorsConstructorDescriptionInitialize this attribute with term frequency of 1 -
Method Summary
Modifier and TypeMethodDescriptionvoidclear()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.booleanintReturns the custom term frequency.inthashCode()voidreflectWith(AttributeReflector reflector) This method is for introspection of attributes, it should simply add the key/values this attribute holds to the givenAttributeReflector.voidsetTermFrequency(int termFrequency) Set the custom term frequency of the current term within one document.Methods inherited from class org.apache.lucene.util.AttributeImpl
clone, reflectAsString
-
Constructor Details
-
TermFrequencyAttributeImpl
public TermFrequencyAttributeImpl()Initialize this attribute with term frequency of 1
-
-
Method Details
-
setTermFrequency
public void setTermFrequency(int termFrequency) Description copied from interface:TermFrequencyAttributeSet the custom term frequency of the current term within one document.- Specified by:
setTermFrequencyin interfaceTermFrequencyAttribute
-
getTermFrequency
public int getTermFrequency()Description copied from interface:TermFrequencyAttributeReturns the custom term frequency.- Specified by:
getTermFrequencyin interfaceTermFrequencyAttribute
-
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
-
equals
-
hashCode
public int hashCode() -
copyTo
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
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:
-