Class FieldQueryNode
java.lang.Object
org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl
org.apache.lucene.queryparser.flexible.core.nodes.FieldQueryNode
- All Implemented Interfaces:
Cloneable,FieldableNode,FieldValuePairQueryNode<CharSequence>,QueryNode,TextableQueryNode,ValueQueryNode<CharSequence>
- Direct Known Subclasses:
FuzzyQueryNode,QuotedFieldQueryNode,WildcardQueryNode
public class FieldQueryNode
extends QueryNodeImpl
implements FieldValuePairQueryNode<CharSequence>, TextableQueryNode
A
FieldQueryNode represents a element that contains field/text tuple-
Field Summary
FieldsModifier and TypeFieldDescriptionprotected intThe term's begin position.protected intThe term's end position.protected CharSequenceThe term's fieldprotected intThe term's position increment.protected CharSequenceThe term's text.Fields inherited from class org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl
PLAINTEXT_FIELD_NAME, toQueryStringIgnoreFields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionRecursive clone the QueryNode tree The tags are not copied to the new tree when you call the cloneTree() methodintgetBegin()intgetEnd()getField()Returns the field associated to the node and every node under it.returns null if the field was not specified in the query stringintprotected CharSequencegetTermEscaped(EscapeQuerySyntax escaper) protected CharSequencegetTermEscapeQuoted(EscapeQuerySyntax escaper) getText()Returns the term.getValue()voidsetBegin(int begin) voidsetEnd(int end) voidsetField(CharSequence field) Associates the node to a field.voidsetPositionIncrement(int pi) voidsetText(CharSequence text) voidsetValue(CharSequence value) toQueryString(EscapeQuerySyntax escaper) convert to a query string understood by the query parsertoString()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, unsetTagMethods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, waitMethods inherited from interface org.apache.lucene.queryparser.flexible.core.nodes.QueryNode
add, add, containsTag, getChildren, getParent, getTag, getTagMap, isLeaf, removeChildren, removeFromParent, set, setTag, unsetTag
-
Field Details
-
field
The term's field -
text
The term's text. -
begin
protected int beginThe term's begin position. -
end
protected int endThe term's end position. -
positionIncrement
protected int positionIncrementThe term's position increment.
-
-
Constructor Details
-
FieldQueryNode
- Parameters:
field- - field nametext- - valuebegin- - position in the query stringend- - position in the query string
-
-
Method Details
-
getTermEscaped
-
getTermEscapeQuoted
-
toQueryString
Description copied from interface:QueryNodeconvert to a query string understood by the query parser- Specified by:
toQueryStringin interfaceQueryNode
-
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:
-
getTextAsString
- Returns:
- the term
-
getFieldAsString
returns null if the field was not specified in the query string- Returns:
- the field
-
getBegin
public int getBegin() -
setBegin
public void setBegin(int begin) -
getEnd
public int getEnd() -
setEnd
public void setEnd(int end) -
getField
Description copied from interface:FieldableNodeReturns the field associated to the node and every node under it.- Specified by:
getFieldin interfaceFieldableNode- Returns:
- the field name
-
setField
Description copied from interface:FieldableNodeAssociates the node to a field.- Specified by:
setFieldin interfaceFieldableNode- Parameters:
field- the field name
-
getPositionIncrement
public int getPositionIncrement() -
setPositionIncrement
public void setPositionIncrement(int pi) -
getText
Returns the term.- Specified by:
getTextin interfaceTextableQueryNode- Returns:
- The "original" form of the term.
-
setText
- Specified by:
setTextin interfaceTextableQueryNode- Parameters:
text- the text to set
-
cloneTree
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
-
getValue
- Specified by:
getValuein interfaceValueQueryNode<CharSequence>
-
setValue
- Specified by:
setValuein interfaceValueQueryNode<CharSequence>
-