org.elasticsearch.index.query

Class SpanTermQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

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

org.elasticsearch.index.query.SpanTermQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder, SpanQueryBuilder

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

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

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 java.lang.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.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
SpanTermQueryBuilder(StreamInput in) Read from a stream.
SpanTermQueryBuilder(java.lang.String name, double value)
SpanTermQueryBuilder(java.lang.String name, float value)
SpanTermQueryBuilder(java.lang.String name, int value)
SpanTermQueryBuilder(java.lang.String name, long value)
SpanTermQueryBuilder(java.lang.String name, java.lang.Object value)
SpanTermQueryBuilder(java.lang.String name, java.lang.String value)

Method Summary

Modifier and Type	Method and Description
protected org.apache.lucene.search.spans.SpanQuery	doToQuery(QueryShardContext context)
static java.util.Optional<SpanTermQueryBuilder>	fromXContent(QueryParseContext parseContext)
java.lang.String	getWriteableName() Returns the name of the writeable object

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

doEquals, doHashCode, doWriteTo, doXContent, fieldName, value

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, throwParsingExceptionOnMultipleFields, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

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

buildAsBytes, buildAsBytes, toString, 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

Constructor Detail

SpanTermQueryBuilder

public SpanTermQueryBuilder(java.lang.String name,
                            java.lang.String value)

See Also:

BaseTermQueryBuilder.BaseTermQueryBuilder(String, String)

SpanTermQueryBuilder

public SpanTermQueryBuilder(java.lang.String name,
                            int value)

See Also:

BaseTermQueryBuilder.BaseTermQueryBuilder(String, int)

SpanTermQueryBuilder

public SpanTermQueryBuilder(java.lang.String name,
                            long value)

See Also:

BaseTermQueryBuilder.BaseTermQueryBuilder(String, long)

SpanTermQueryBuilder

public SpanTermQueryBuilder(java.lang.String name,
                            float value)

See Also:

BaseTermQueryBuilder.BaseTermQueryBuilder(String, float)

SpanTermQueryBuilder

public SpanTermQueryBuilder(java.lang.String name,
                            double value)

See Also:

BaseTermQueryBuilder.BaseTermQueryBuilder(String, double)

SpanTermQueryBuilder

public SpanTermQueryBuilder(java.lang.String name,
                            java.lang.Object value)

See Also:

BaseTermQueryBuilder.BaseTermQueryBuilder(String, Object)

SpanTermQueryBuilder

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

Read from a stream.

Throws:

java.io.IOException

Method Detail

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<SpanTermQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static java.util.Optional<SpanTermQueryBuilder> fromXContent(QueryParseContext parseContext)
                                                             throws java.io.IOException,
                                                                    ParsingException

Throws:

java.io.IOException

ParsingException

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable