Class BoostQueryNode
- java.lang.Object
-
- org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl
-
- org.apache.lucene.queryparser.flexible.core.nodes.BoostQueryNode
-
public class BoostQueryNode extends QueryNodeImpl
ABoostQueryNodeboosts 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.
-
-
Field Summary
-
Fields inherited from class org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl
PLAINTEXT_FIELD_NAME, toQueryStringIgnoreFields
-
-
Constructor Summary
Constructors Constructor Description BoostQueryNode(QueryNode query, float value)Constructs a boost node
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description QueryNodecloneTree()Recursive clone the QueryNode tree The tags are not copied to the new tree when you call the cloneTree() methodQueryNodegetChild()Returns the single child which this node boosts.floatgetValue()Returns the boost value.CharSequencetoQueryString(EscapeQuerySyntax escapeSyntaxParser)convert to a query string understood by the query parserStringtoString()Every implementation of this class should return pseudo xml like this:-
Methods inherited from class org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl
add, add, allocate, clone, containsTag, getChildren, getParent, getTag, getTagMap, isDefaultField, isLeaf, isRoot, removeChildren, removeFromParent, set, setLeaf, setTag, unsetTag
-
-
-
-
Constructor Detail
-
BoostQueryNode
public BoostQueryNode(QueryNode query, float value)
Constructs a boost node- Parameters:
query- the query to be boostedvalue- the boost value, it may vary from 0.0 to 1.0
-
-
Method Detail
-
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:QueryNodeImplEvery implementation of this class should return pseudo xml like this:For FieldQueryNode: <field start='1' end='2' field='subject' text='foo'/>
- Specified by:
toStringin interfaceQueryNode- Overrides:
toStringin classQueryNodeImpl- See Also:
QueryNode.toString()
-
toQueryString
public CharSequence toQueryString(EscapeQuerySyntax escapeSyntaxParser)
Description copied from interface:QueryNodeconvert to a query string understood by the query parser
-
cloneTree
public QueryNode cloneTree() throws CloneNotSupportedException
Description copied from interface:QueryNodeRecursive clone the QueryNode tree The tags are not copied to the new tree when you call the cloneTree() method- Specified by:
cloneTreein interfaceQueryNode- Overrides:
cloneTreein classQueryNodeImpl- Returns:
- the cloned tree
- Throws:
CloneNotSupportedException
-
-