Package org.apache.lucene.queryparser.flexible.core.nodes

Class BoostQueryNode

java.lang.Object
org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl
org.apache.lucene.queryparser.flexible.core.nodes.BoostQueryNode
All Implemented Interfaces:
Cloneable, QueryNode
public class BoostQueryNode extends QueryNodeImpl
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.

  • Constructor Details

    • BoostQueryNode

      public BoostQueryNode(QueryNode query, float value)
      Constructs a boost node
      Parameters:
      query - the query to be boosted
      value - the boost value, it may vary from 0.0 to 1.0

  • Method Details

    • getChild

      public QueryNode getChild()
      Returns the single child which this node boosts.
      Returns:
      the single child which this node boosts

    • getValue

      public float getValue()
      Returns the boost value. It may vary from 0.0 to 1.0.
      Returns:
      the boost value

    • toString

      public String toString()
      Description copied from class: QueryNodeImpl
      Every implementation of this class should return pseudo xml like this:

      For FieldQueryNode: <field start='1' end='2' field='subject' text='foo'/>

      Specified by:
      toString in interface QueryNode
      Overrides:
      toString in class QueryNodeImpl
      See Also:

    • toQueryString

      public CharSequence toQueryString(EscapeQuerySyntax escapeSyntaxParser)
      Description copied from interface: QueryNode
      convert to a query string understood by the query parser

    • cloneTree

      public QueryNode cloneTree() throws CloneNotSupportedException
      Description copied from interface: QueryNode
      Recursive clone the QueryNode tree The tags are not copied to the new tree when you call the cloneTree() method
      Specified by:
      cloneTree in interface QueryNode
      Overrides:
      cloneTree in class QueryNodeImpl
      Returns:
      the cloned tree
      Throws:
      CloneNotSupportedException