Save This Page
Home » lucene-3.0.1-src » org.apache.lucene.queryParser.core.nodes » [javadoc | source]
org.apache.lucene.queryParser.core.nodes
public class: BoostQueryNode [javadoc | source]
java.lang.Object
   org.apache.lucene.queryParser.core.nodes.QueryNodeImpl
      org.apache.lucene.queryParser.core.nodes.BoostQueryNode

All Implemented Interfaces:
    Cloneable, QueryNode

A BoostQueryNode boosts the QueryNode tree which is under this node. So, it must only and always have one child. The boost value may vary from 0.0 to 1.0.
Fields inherited from org.apache.lucene.queryParser.core.nodes.QueryNodeImpl:
PLAINTEXT_FIELD_NAME,  toQueryStringIgnoreFields
Constructor:
 public BoostQueryNode(QueryNode query,
    float value) throws QueryNodeException 
    Constructs a boost node
    Parameters:
    query - the query to be boosted
    value - the boost value, it may vary from 0.0 to 1.0
    Throws:
    QueryNodeException -
Method from org.apache.lucene.queryParser.core.nodes.BoostQueryNode Summary:
cloneTree,   getChild,   getValue,   toQueryString,   toString
Methods from org.apache.lucene.queryParser.core.nodes.QueryNodeImpl:
add,   add,   allocate,   clone,   cloneTree,   containsTag,   getChildren,   getParent,   getTag,   getTags,   isDefaultField,   isLeaf,   isRoot,   set,   setLeaf,   setTag,   toString,   unsetTag
Methods from java.lang.Object:
clone,   equals,   finalize,   getClass,   hashCode,   notify,   notifyAll,   toString,   wait,   wait,   wait
Method from org.apache.lucene.queryParser.core.nodes.BoostQueryNode Detail:
 public QueryNode cloneTree() throws CloneNotSupportedException 
 public QueryNode getChild() 
    Returns the single child which this node boosts.
 public float getValue() 
    Returns the boost value. It may vary from 0.0 to 1.0.
 public CharSequence toQueryString(EscapeQuerySyntax escapeSyntaxParser) 
 public String toString()