Package org.apache.lucene.search
Class BoostAttributeImpl
java.lang.Object
org.apache.lucene.util.AttributeImpl
org.apache.lucene.search.BoostAttributeImpl
- All Implemented Interfaces:
Cloneable,BoostAttribute,Attribute
Implementation class for
BoostAttribute.- NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.
-
Field Summary
Fields inherited from interface org.apache.lucene.search.BoostAttribute
DEFAULT_BOOST -
Constructor Summary
Constructors -
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.floatgetBoost()Retrieves the boost, default is1.0f.voidreflectWith(AttributeReflector reflector) This method is for introspection of attributes, it should simply add the key/values this attribute holds to the givenAttributeReflector.voidsetBoost(float boost) Sets the boost in this attributeMethods inherited from class org.apache.lucene.util.AttributeImpl
clone, end, reflectAsString
-
Constructor Details
-
BoostAttributeImpl
public BoostAttributeImpl()
-
-
Method Details
-
setBoost
public void setBoost(float boost) Description copied from interface:BoostAttributeSets the boost in this attribute- Specified by:
setBoostin interfaceBoostAttribute
-
getBoost
public float getBoost()Description copied from interface:BoostAttributeRetrieves the boost, default is1.0f.- Specified by:
getBoostin interfaceBoostAttribute
-
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
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:
-