Module org.elasticsearch.server

Package org.elasticsearch.index.query

Class SpanNearQueryBuilder.SpanGapQueryBuilder

java.lang.Object

org.elasticsearch.index.query.SpanNearQueryBuilder.SpanGapQueryBuilder

All Implemented Interfaces:

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

Enclosing class:

SpanNearQueryBuilder

public static class SpanNearQueryBuilder.SpanGapQueryBuilder
extends Object
implements SpanQueryBuilder

SpanGapQueryBuilder enables gaps in a SpanNearQuery. Since, SpanGapQuery is private to SpanNearQuery, SpanGapQueryBuilder cannot be used to generate a Query (SpanGapQuery) like another QueryBuilder. Instead, it just identifies a span_gap clause so that SpanNearQuery.addGap(int) can be invoked for it. This QueryBuilder is only applicable as a clause in SpanGapQueryBuilder but yet to enforce this restriction.

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 interface org.elasticsearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.elasticsearch.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SpanGapQueryBuilder(String fieldName, int width)	Constructs a new SpanGapQueryBuilder term query.
SpanGapQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
float	boost()	Returns the boost for this query.
QueryBuilder	boost(float boost)	Sets the boost for this query.
final boolean	equals(Object obj)
String	fieldName()
static SpanNearQueryBuilder.SpanGapQueryBuilder	fromXContent(XContentParser parser)
Version	getMinimalSupportedVersion()	The minimal version of the recipient this object can be sent to
String	getName()	Returns the name that identifies uniquely the query
String	getWriteableName()	Returns the name of the writeable object
final int	hashCode()
String	queryName()	Returns the arbitrary name assigned to the query (see named queries).
QueryBuilder	queryName(String queryName)	Sets the arbitrary name to be assigned to the query (see named queries).
protected static void	throwParsingExceptionOnMultipleFields(String queryName, XContentLocation contentLocation, String processedFieldName, String currentFieldName)
org.apache.lucene.search.Query	toQuery(SearchExecutionContext context)	Converts this QueryBuilder to a lucene Query.
final String	toString()
XContentBuilder	toXContent(XContentBuilder builder, ToXContent.Params params)
int	width()
final void	writeTo(StreamOutput out)	Write this into the StreamOutput.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface org.elasticsearch.index.query.QueryBuilder

rewrite

Methods inherited from interface org.elasticsearch.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

SpanGapQueryBuilder

public SpanGapQueryBuilder(String fieldName,
 int width)

Constructs a new SpanGapQueryBuilder term query.

Parameters:

fieldName - The name of the field

width - The width of the gap introduced

SpanGapQueryBuilder

public SpanGapQueryBuilder(StreamInput in)
                    throws IOException

Read from a stream.

Throws:

IOException

Method Details

fieldName

public String fieldName()

Returns:

fieldName The name of the field

width

public int width()

Returns:

width The width of the gap introduced

toQuery

public org.apache.lucene.search.Query toQuery(SearchExecutionContext context)
                                       throws IOException

Description copied from interface: QueryBuilder

Converts this QueryBuilder to a lucene Query. Returns null if this query should be ignored in the context of parent queries.

Specified by:

toQuery in interface QueryBuilder

Parameters:

context - additional information needed to construct the queries

Returns:

the Query or null if this query should be ignored upstream

Throws:

IOException

queryName

public String queryName()

Description copied from interface: QueryBuilder

Returns the arbitrary name assigned to the query (see named queries).

Specified by:

queryName in interface QueryBuilder

queryName

public QueryBuilder queryName(String queryName)

Description copied from interface: QueryBuilder

Sets the arbitrary name to be assigned to the query (see named queries). Implementers should return the concrete type of the QueryBuilder so that calls can be chained. This is done automatically when extending AbstractQueryBuilder.

Specified by:

queryName in interface QueryBuilder

boost

public float boost()

Description copied from interface: QueryBuilder

Returns the boost for this query.

Specified by:

boost in interface QueryBuilder

boost

public QueryBuilder boost(float boost)

Description copied from interface: QueryBuilder

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided. Implementers should return the concrete type of the QueryBuilder so that calls can be chained. This is done automatically when extending AbstractQueryBuilder.

Specified by:

boost in interface QueryBuilder

getName

public String getName()

Description copied from interface: QueryBuilder

Returns the name that identifies uniquely the query

Specified by:

getName in interface QueryBuilder

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

writeTo

public final void writeTo(StreamOutput out)
                   throws IOException

Description copied from interface: Writeable

Write this into the StreamOutput.

Specified by:

writeTo in interface Writeable

Throws:

IOException

toXContent

public XContentBuilder toXContent(XContentBuilder builder,
 ToXContent.Params params)
                           throws IOException

Specified by:

toXContent in interface ToXContent

Throws:

IOException

fromXContent

public static SpanNearQueryBuilder.SpanGapQueryBuilder fromXContent(XContentParser parser)
                                                             throws IOException

Throws:

IOException

equals

public final boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object

toString

public final String toString()

Overrides:

toString in class Object

throwParsingExceptionOnMultipleFields

protected static void throwParsingExceptionOnMultipleFields(String queryName,
 XContentLocation contentLocation,
 String processedFieldName,
 String currentFieldName)