org.sindice.siren.qparser.json.dsl

Class TwigQuery

java.lang.Object

org.sindice.siren.qparser.json.dsl.AbstractQuery

org.sindice.siren.qparser.json.dsl.AbstractNodeQuery

org.sindice.siren.qparser.json.dsl.TwigQuery

public class TwigQuery
extends AbstractNodeQuery

Class that represents a twig object of the JSON query syntax.

Field Summary

Fields inherited from class org.sindice.siren.qparser.json.dsl.AbstractQuery

mapper

Constructor Summary

Constructors

Constructor and Description
TwigQuery(org.codehaus.jackson.map.ObjectMapper mapper, KeywordQueryParser parser)

Method Summary

Methods

Modifier and Type	Method and Description
TwigQuery	optional(AbstractNodeQuery child) Adds a child clause with a NodeBooleanClause.Occur#SHOULD operator.
TwigQuery	optional(AbstractNodeQuery descendant, int level) Adds a descendant clause with a NodeBooleanClause.Occur#SHOULD operator.
TwigQuery	setBoost(float boost) Sets the boost for this query.
TwigQuery	setLevel(int level) Sets the node level constraint.
TwigQuery	setRange(int lowerBound, int upperBound) Sets the node range constraint.
org.apache.lucene.search.Query	toQuery(boolean proxy) Convert the constructed query into a Query.
TwigQuery	with(AbstractNodeQuery child) Adds a child clause with a NodeBooleanClause.Occur#MUST operator.
TwigQuery	with(AbstractNodeQuery descendant, int level) Adds a descendant clause with a NodeBooleanClause.Occur#MUST operator.
TwigQuery	without(AbstractNodeQuery child) Adds a child clause with a NodeBooleanClause.Occur#MUST_NOT operator.
TwigQuery	without(AbstractNodeQuery descendant, int level) Adds a descendant clause with a NodeBooleanClause.Occur#MUST_NOT operator.

Methods inherited from class org.sindice.siren.qparser.json.dsl.AbstractNodeQuery

getLevel, getLowerBound, getUpperBound, hasLevel, hasRange

Methods inherited from class org.sindice.siren.qparser.json.dsl.AbstractQuery

toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TwigQuery

public TwigQuery(org.codehaus.jackson.map.ObjectMapper mapper,
         KeywordQueryParser parser)

Method Detail

setLevel

public TwigQuery setLevel(int level)

Description copied from class: AbstractNodeQuery

Sets the node level constraint.

Overrides:

setLevel in class AbstractNodeQuery

See Also:

org.sindice.siren.search.node.NodeQuery#setLevelConstraint(int)}

setRange

public TwigQuery setRange(int lowerBound,
                 int upperBound)

Description copied from class: AbstractNodeQuery

Sets the node range constraint.

Overrides:

setRange in class AbstractNodeQuery

See Also:

org.sindice.siren.search.node.NodeQuery#setNodeConstraint(int, int)}

setBoost

public TwigQuery setBoost(float boost)

Description copied from class: AbstractQuery

Sets the boost for this query.

Overrides:

setBoost in class AbstractQuery

See Also:

Query#setBoost(float)}

with

public TwigQuery with(AbstractNodeQuery child)

Adds a child clause with a NodeBooleanClause.Occur#MUST operator.

Use this method for child clauses that must appear in the matching twigs.

See Also:

NodeBooleanClause.Occur#MUST, TwigQuery.addChild(NodeQuery, NodeBooleanClause.Occur)

with

public TwigQuery with(AbstractNodeQuery descendant,
             int level)

Adds a descendant clause with a NodeBooleanClause.Occur#MUST operator.

Use this method for descendant clauses that must appear in the matching twigs.

See Also:

NodeBooleanClause.Occur#MUST, TwigQuery.addDescendant(int, NodeQuery, NodeBooleanClause.Occur)

without

public TwigQuery without(AbstractNodeQuery child)

Adds a child clause with a NodeBooleanClause.Occur#MUST_NOT operator.

Use this method for child clauses that must not appear in the matching twigs.

See Also:

NodeBooleanClause.Occur#MUST_NOT, TwigQuery.addChild(NodeQuery, NodeBooleanClause.Occur)

without

public TwigQuery without(AbstractNodeQuery descendant,
                int level)

Adds a descendant clause with a NodeBooleanClause.Occur#MUST_NOT operator.

Use this method for descendant clauses that must not appear in the matching twigs.

See Also:

NodeBooleanClause.Occur#MUST_NOT, TwigQuery.addDescendant(int, NodeQuery, NodeBooleanClause.Occur)

optional

public TwigQuery optional(AbstractNodeQuery child)

Adds a child clause with a NodeBooleanClause.Occur#SHOULD operator.

Use this method for child clauses that should appear in the matching twigs.

See Also:

NodeBooleanClause.Occur#SHOULD, TwigQuery.addChild(NodeQuery, NodeBooleanClause.Occur)

optional

public TwigQuery optional(AbstractNodeQuery descendant,
                 int level)

Adds a descendant clause with a NodeBooleanClause.Occur#SHOULD operator.

Use this method for descendant clauses that should appear in the matching twigs.

See Also:

NodeBooleanClause.Occur#SHOULD, TwigQuery.addDescendant(int, NodeQuery, NodeBooleanClause.Occur)

toQuery

public org.apache.lucene.search.Query toQuery(boolean proxy)
                                       throws org.apache.lucene.queryparser.flexible.core.QueryNodeException

Description copied from class: AbstractQuery

Convert the constructed query into a Query.

Specified by:

toQuery in class AbstractNodeQuery

Parameters:

proxy - Should the query be wrapped into a LuceneProxyNodeQuery ?

Throws:

org.apache.lucene.queryparser.flexible.core.QueryNodeException