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
AFieldQueryNoderepresents a element that contains field/text tuple
-
-
Field Summary
Fields Modifier and Type Field Description protected intbeginThe term's begin position.protected intendThe term's end position.protected CharSequencefieldThe term's fieldprotected intpositionIncrementThe term's position increment.protected CharSequencetextThe term's text.-
Fields inherited from class org.apache.lucene.queryparser.flexible.core.nodes.QueryNodeImpl
PLAINTEXT_FIELD_NAME, toQueryStringIgnoreFields
-
-
Constructor Summary
Constructors Constructor Description FieldQueryNode(CharSequence field, CharSequence text, int begin, int end)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description FieldQueryNodecloneTree()Recursive clone the QueryNode tree The tags are not copied to the new tree when you call the cloneTree() methodintgetBegin()intgetEnd()CharSequencegetField()Returns the field associated to the node and every node under it.StringgetFieldAsString()returns null if the field was not specified in the query stringintgetPositionIncrement()protected CharSequencegetTermEscaped(EscapeQuerySyntax escaper)protected CharSequencegetTermEscapeQuoted(EscapeQuerySyntax escaper)CharSequencegetText()Returns the term.StringgetTextAsString()CharSequencegetValue()voidsetBegin(int begin)voidsetEnd(int end)voidsetField(CharSequence field)Associates the node to a field.voidsetPositionIncrement(int pi)voidsetText(CharSequence text)voidsetValue(CharSequence value)CharSequencetoQueryString(EscapeQuerySyntax escaper)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
-
Methods inherited from class java.lang.Object
equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
-
Methods 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 Detail
-
field
protected CharSequence field
The term's field
-
text
protected CharSequence text
The term's text.
-
begin
protected int begin
The term's begin position.
-
end
protected int end
The term's end position.
-
positionIncrement
protected int positionIncrement
The term's position increment.
-
-
Constructor Detail
-
FieldQueryNode
public FieldQueryNode(CharSequence field, CharSequence text, int begin, int end)
- Parameters:
field- - field nametext- - valuebegin- - position in the query stringend- - position in the query string
-
-
Method Detail
-
getTermEscaped
protected CharSequence getTermEscaped(EscapeQuerySyntax escaper)
-
getTermEscapeQuoted
protected CharSequence getTermEscapeQuoted(EscapeQuerySyntax escaper)
-
toQueryString
public CharSequence toQueryString(EscapeQuerySyntax escaper)
Description copied from interface:QueryNodeconvert to a query string understood by the query parser- Specified by:
toQueryStringin interfaceQueryNode
-
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()
-
getTextAsString
public String getTextAsString()
- Returns:
- the term
-
getFieldAsString
public String 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
public CharSequence 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
public void setField(CharSequence field)
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
public CharSequence getText()
Returns the term.- Specified by:
getTextin interfaceTextableQueryNode- Returns:
- The "original" form of the term.
-
setText
public void setText(CharSequence text)
- Specified by:
setTextin interfaceTextableQueryNode- Parameters:
text- the text to set
-
cloneTree
public FieldQueryNode 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
-
getValue
public CharSequence getValue()
- Specified by:
getValuein interfaceValueQueryNode<CharSequence>
-
setValue
public void setValue(CharSequence value)
- Specified by:
setValuein interfaceValueQueryNode<CharSequence>
-
-