Module org.elasticsearch.server

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, VersionedNamedWriteable, Writeable, QueryBuilder, Rewriteable<QueryBuilder>, SpanQueryBuilder, ToXContent, ToXContentObject

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

Modifier and Type	Class	Description
static class	SpanNearQueryBuilder.SpanGapQueryBuilder	SpanGapQueryBuilder enables gaps in a SpanNearQuery.

Nested classes/interfaces inherited from interface org.elasticsearch.index.query.SpanQueryBuilder

SpanQueryBuilder.SpanQueryBuilderUtil

Nested classes/interfaces inherited from interface org.elasticsearch.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 final 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.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
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(SearchExecutionContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
static SpanNearQueryBuilder	fromXContent(XContentParser parser)
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
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, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, 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, toQuery

Methods inherited from interface org.elasticsearch.xcontent.ToXContent

toXContent

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

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

writeTo

Field Details

NAME

public static final 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 Details

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 IOException

Read from a stream.

Throws:

IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out)
                  throws IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<SpanNearQueryBuilder>

Throws:

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 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 IOException

Specified by:

doXContent in class AbstractQueryBuilder<SpanNearQueryBuilder>

Throws:

IOException

fromXContent

public static SpanNearQueryBuilder fromXContent(XContentParser parser)
                                         throws IOException

Throws:

IOException

doToQuery

protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context)
                                            throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<SpanNearQueryBuilder>

Throws:

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 String getWriteableName()

Description copied from interface: VersionedNamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable

Specified by:

getWriteableName in interface VersionedNamedWriteable

getMinimalSupportedVersion

public Version getMinimalSupportedVersion()

Description copied from interface: VersionedNamedWriteable

The minimal version of the recipient this object can be sent to

Specified by:

getMinimalSupportedVersion in interface VersionedNamedWriteable