Package org.elasticsearch.index.query

Class SpanNearQueryBuilder

java.lang.Object

org.elasticsearch.index.query.AbstractQueryBuilder<SpanNearQueryBuilder>

org.elasticsearch.index.query.SpanNearQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>, SpanQueryBuilder

public class SpanNearQueryBuilder
extends AbstractQueryBuilder<SpanNearQueryBuilder>
implements SpanQueryBuilder

Matches spans which are near one another. One can specify slop, the maximum number of intervening unmatched positions, as well as whether matches are required to be in-order. The span near query maps to Lucene SpanNearQuery.

Nested Class Summary

Nested classes/interfaces inherited from interface org.elasticsearch.common.xcontent.ToXContent

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Nested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable

Writeable.Reader<V>, Writeable.Writer<V>

Field Summary

Fields

Modifier and Type	Field	Description
static boolean	DEFAULT_IN_ORDER	Default for flag controlling whether matches are required to be in-order
static int	DEFAULT_SLOP	Default slop value, this is the same that lucene SpanNearQuery uses if no slop is provided
static java.lang.String	NAME

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SpanNearQueryBuilder(StreamInput in)	Read from a stream.
SpanNearQueryBuilder(SpanQueryBuilder initialClause, int slop)

Method Summary

Modifier and Type	Method	Description
SpanNearQueryBuilder	addClause(SpanQueryBuilder clause)	Add a span clause to the current list of clauses
java.util.List<SpanQueryBuilder>	clauses()
protected boolean	doEquals(SpanNearQueryBuilder other)	Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected org.apache.lucene.search.Query	doToQuery(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
static SpanNearQueryBuilder	fromXContent(XContentParser parser)
java.lang.String	getWriteableName()	Returns the name of the writeable object
boolean	inOrder()
SpanNearQueryBuilder	inOrder(boolean inOrder)	When inOrder is true, the spans from each clause must be in the same order as in clauses and must be non-overlapping.
int	slop()

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

addValidationError, boost, boost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQuery, toString, toXContent, writeTo

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.index.query.QueryBuilder

boost, boost, getName, queryName, queryName, rewrite, toFilter, toQuery

Methods inherited from interface org.elasticsearch.index.query.Rewriteable

rewrite, rewrite, rewrite, rewriteAndFetch, rewriteAndFetch

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.elasticsearch.common.io.stream.Writeable

writeTo

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

DEFAULT_IN_ORDER

public static boolean DEFAULT_IN_ORDER

Default for flag controlling whether matches are required to be in-order

DEFAULT_SLOP

public static int DEFAULT_SLOP

Default slop value, this is the same that lucene SpanNearQuery uses if no slop is provided

Constructor Detail

SpanNearQueryBuilder

public SpanNearQueryBuilder(SpanQueryBuilder initialClause,
                            int slop)

Parameters:

initialClause - an initial span query clause

slop - controls the maximum number of intervening unmatched positions permitted

SpanNearQueryBuilder

public SpanNearQueryBuilder(StreamInput in)
                     throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws java.io.IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<SpanNearQueryBuilder>

Throws:

java.io.IOException

slop

public int slop()

Returns:

the maximum number of intervening unmatched positions permitted

addClause

public SpanNearQueryBuilder addClause(SpanQueryBuilder clause)

Add a span clause to the current list of clauses

clauses

public java.util.List<SpanQueryBuilder> clauses()

Returns:

the SpanQueryBuilder clauses that were set for this query

inOrder

public SpanNearQueryBuilder inOrder(boolean inOrder)

When inOrder is true, the spans from each clause must be in the same order as in clauses and must be non-overlapping. Defaults to true

inOrder

public boolean inOrder()

See Also:

inOrder(boolean)

doXContent

protected void doXContent(XContentBuilder builder,
                          ToXContent.Params params)
                   throws java.io.IOException

Specified by:

doXContent in class AbstractQueryBuilder<SpanNearQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static SpanNearQueryBuilder fromXContent(XContentParser parser)
                                         throws java.io.IOException

Throws:

java.io.IOException

doToQuery

protected org.apache.lucene.search.Query doToQuery(QueryShardContext context)
                                            throws java.io.IOException

Specified by:

doToQuery in class AbstractQueryBuilder<SpanNearQueryBuilder>

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<SpanNearQueryBuilder>

doEquals

protected boolean doEquals(SpanNearQueryBuilder other)

Description copied from class: AbstractQueryBuilder

Indicates whether some other QueryBuilder object of the same type is "equal to" this one.

Specified by:

doEquals in class AbstractQueryBuilder<SpanNearQueryBuilder>

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable