Package org.elasticsearch.index.query

Class SpanOrQueryBuilder

java.lang.Object

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

org.elasticsearch.index.query.SpanOrQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, org.elasticsearch.common.xcontent.ToXContent, org.elasticsearch.common.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>, SpanQueryBuilder

public class SpanOrQueryBuilder
extends AbstractQueryBuilder<SpanOrQueryBuilder>
implements SpanQueryBuilder

Span query that matches the union of its clauses. Maps to SpanOrQuery.

Nested Class Summary

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

SpanQueryBuilder.SpanQueryBuilderUtil

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

org.elasticsearch.common.xcontent.ToXContent.DelegatingMapParams, org.elasticsearch.common.xcontent.ToXContent.MapParams, org.elasticsearch.common.xcontent.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 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
SpanOrQueryBuilder(StreamInput in)	Read from a stream.
SpanOrQueryBuilder(SpanQueryBuilder initialClause)

Method Summary

Modifier and Type	Method	Description
SpanOrQueryBuilder	addClause(SpanQueryBuilder clause)	Add a span clause to the current list of clauses
List<SpanQueryBuilder>	clauses()
protected boolean	doEquals(SpanOrQueryBuilder 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(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
static SpanOrQueryBuilder	fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
String	getWriteableName()	Returns the name of the writeable object

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

addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, parseInnerQueryBuilder, parseInnerQueryBuilder, printBoostAndQueryName, queryName, queryName, requireValue, rewrite, throwParsingExceptionOnMultipleFields, 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, toQuery

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 Details

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Details

SpanOrQueryBuilder

public SpanOrQueryBuilder(SpanQueryBuilder initialClause)

SpanOrQueryBuilder

public SpanOrQueryBuilder(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<SpanOrQueryBuilder>

Throws:

IOException

addClause

public SpanOrQueryBuilder 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

doXContent

protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder,
 org.elasticsearch.common.xcontent.ToXContent.Params params)
                   throws IOException

Specified by:

doXContent in class AbstractQueryBuilder<SpanOrQueryBuilder>

Throws:

IOException

fromXContent

public static SpanOrQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
                                       throws IOException

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<SpanOrQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<SpanOrQueryBuilder>

doEquals

protected boolean doEquals(SpanOrQueryBuilder 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<SpanOrQueryBuilder>

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable