org.elasticsearch.index.query

Class SpanNearQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.SpanNearQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder<SpanNearQueryBuilder>, SpanQueryBuilder<SpanNearQueryBuilder>

public class SpanNearQueryBuilder
extends AbstractQueryBuilder<SpanNearQueryBuilder>
implements SpanQueryBuilder<SpanNearQueryBuilder>

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.io.stream.Writeable

Writeable.Reader<R>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_IN_ORDER Default for flag controlling whether matches are required to be in-order
static java.lang.String	NAME
static ParseField	QUERY_NAME_FIELD

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

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

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

EMPTY_PARAMS

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
SpanNearQueryBuilder	clause(SpanQueryBuilder<?> clause)
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(QueryParseContext parseContext)
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, convertToBytesRefIfString, convertToStringIfBytesRef, doRewrite, equals, getName, hashCode, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

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, rewriteQuery, toFilter, toQuery

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

writeTo

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

toXContent

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

QUERY_NAME_FIELD

public static final ParseField QUERY_NAME_FIELD

DEFAULT_IN_ORDER

public static boolean DEFAULT_IN_ORDER

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

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

clause

public SpanNearQueryBuilder clause(SpanQueryBuilder<?> clause)

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(QueryParseContext parseContext)
                                         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