Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class SpanTermQueryBuilder

java.lang.Object

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

org.elasticsearch.index.query.BaseTermQueryBuilder<SpanTermQueryBuilder>

org.elasticsearch.index.query.SpanTermQueryBuilder

All Implemented Interfaces:

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

public class SpanTermQueryBuilder
extends BaseTermQueryBuilder<SpanTermQueryBuilder>
implements SpanQueryBuilder

A Span Query that matches documents containing a term.

See Also:

• SpanTermQuery

Nested Class Summary

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 final String	NAME

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

fieldName, value, VALUE_FIELD

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
SpanTermQueryBuilder(String name, double value)
SpanTermQueryBuilder(String name, float value)
SpanTermQueryBuilder(String name, int value)
SpanTermQueryBuilder(String name, long value)
SpanTermQueryBuilder(String name, Object value)
SpanTermQueryBuilder(String name, String value)
SpanTermQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected org.apache.lucene.queries.spans.SpanQuery	doToQuery(SearchExecutionContext context)
static SpanTermQueryBuilder	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

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

addExtraXContent, doEquals, doHashCode, doWriteTo, doXContent, fieldName, value

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

Constructor Details

SpanTermQueryBuilder

public SpanTermQueryBuilder(String name,
 String value)

See Also:

• BaseTermQueryBuilder(String, String)

SpanTermQueryBuilder

public SpanTermQueryBuilder(String name,
 int value)

See Also:

• BaseTermQueryBuilder(String, int)

SpanTermQueryBuilder

public SpanTermQueryBuilder(String name,
 long value)

See Also:

• BaseTermQueryBuilder(String, long)

SpanTermQueryBuilder

public SpanTermQueryBuilder(String name,
 float value)

See Also:

• BaseTermQueryBuilder(String, float)

SpanTermQueryBuilder

public SpanTermQueryBuilder(String name,
 double value)

See Also:

• BaseTermQueryBuilder(String, double)

SpanTermQueryBuilder

public SpanTermQueryBuilder(String name,
 Object value)

See Also:

• BaseTermQueryBuilder(String, Object)

SpanTermQueryBuilder

public SpanTermQueryBuilder(StreamInput in)
                     throws IOException

Read from a stream.

Throws:

IOException

Method Details

doToQuery

protected org.apache.lucene.queries.spans.SpanQuery doToQuery(SearchExecutionContext context)
                                                       throws IOException

Specified by:

doToQuery in class AbstractQueryBuilder<SpanTermQueryBuilder>

Throws:

IOException

fromXContent

public static SpanTermQueryBuilder fromXContent(XContentParser parser)
                                         throws IOException,
ParsingException

Throws:

IOException

ParsingException

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