org.apache.lucene.queryParser.standard.config
Class BoostAttributeImpl

java.lang.Object
  extended by org.apache.lucene.util.AttributeImpl
      extended by org.apache.lucene.queryParser.standard.config.BoostAttributeImpl
All Implemented Interfaces:
Serializable, Cloneable, BoostAttribute, Attribute

public class BoostAttributeImpl
extends AttributeImpl
implements BoostAttribute

This attribute is used by MultiFieldQueryNodeProcessor processor and it should be defined in a FieldConfig. This processor uses this attribute to define which boost a specific field should have when none is defined to it.

See Also:
BoostAttribute, Serialized Form

Field Summary
 
Fields inherited from class org.apache.lucene.util.AttributeImpl
enableBackwards
 
Constructor Summary
BoostAttributeImpl()
           
 
Method Summary
 void clear()
          Clears the values in this AttributeImpl and resets it to its default value.
 void copyTo(AttributeImpl target)
          Copies the values from this Attribute into the passed-in target attribute.
 boolean equals(Object other)
           
 float getBoost()
           
 int hashCode()
           
 void setBoost(float boost)
           
 String toString()
          Returns a string representation of the object.
 
Methods inherited from class org.apache.lucene.util.AttributeImpl
clone, reflectAsString, reflectWith
 
Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait
 

Constructor Detail

BoostAttributeImpl

public BoostAttributeImpl()
Method Detail

setBoost

public void setBoost(float boost)
Specified by:
setBoost in interface BoostAttribute

getBoost

public float getBoost()
Specified by:
getBoost in interface BoostAttribute

clear

public void clear()
Description copied from class: AttributeImpl
Clears 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:
clear in class AttributeImpl

copyTo

public void copyTo(AttributeImpl target)
Description copied from class: AttributeImpl
Copies the values from this Attribute into the passed-in target attribute. The target implementation must support all the Attributes this implementation supports.

Specified by:
copyTo in class AttributeImpl

equals

public boolean equals(Object other)
Overrides:
equals in class Object

hashCode

public int hashCode()
Overrides:
hashCode in class Object

toString

public String toString()
Description copied from class: AttributeImpl
Returns a string representation of the object. In general, the toString method returns a string that "textually represents" this object.

WARNING: For backwards compatibility this method is implemented as return reflectAsString(false). In Lucene 4.0 this default implementation will be removed. The reason for this is the problem of CharTermAttributeImpl.toString() that must return a string representation of the term's char sequence.

It is recommeneded to use AttributeImpl.reflectAsString(boolean) or AttributeImpl.reflectWith(org.apache.lucene.util.AttributeReflector) to get a well-defined output of AttributeImpl's internals.

Overrides:
toString in class AttributeImpl


Copyright © 2000-2011 Apache Software Foundation. All Rights Reserved.