Package org.elasticsearch.index.query
Class SpanNearQueryBuilder.SpanGapQueryBuilder
java.lang.Object
org.elasticsearch.index.query.SpanNearQueryBuilder.SpanGapQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
,SpanQueryBuilder
- Enclosing class:
- SpanNearQueryBuilder
public static class SpanNearQueryBuilder.SpanGapQueryBuilder extends java.lang.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.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 java.lang.String
NAME
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 SpanGapQueryBuilder(java.lang.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.boolean
equals(java.lang.Object obj)
java.lang.String
fieldName()
static SpanNearQueryBuilder.SpanGapQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String
getName()
Returns the name that identifies uniquely the queryjava.lang.String
getWriteableName()
Returns the name of the writeable objectint
hashCode()
java.lang.String
queryName()
Returns the arbitrary name assigned to the query (see named queries).QueryBuilder
queryName(java.lang.String queryName)
Sets the arbitrary name to be assigned to the query (see named queries).protected static void
throwParsingExceptionOnMultipleFields(java.lang.String queryName, org.elasticsearch.common.xcontent.XContentLocation contentLocation, java.lang.String processedFieldName, java.lang.String currentFieldName)
org.apache.lucene.search.Query
toQuery(SearchExecutionContext context)
Converts this QueryBuilder to a luceneQuery
.java.lang.String
toString()
org.elasticsearch.common.xcontent.XContentBuilder
toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
int
width()
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.common.xcontent.ToXContentObject
isFragment
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
-
Constructor Details
-
SpanGapQueryBuilder
public SpanGapQueryBuilder(java.lang.String fieldName, int width)Constructs a new SpanGapQueryBuilder term query.- Parameters:
fieldName
- The name of the fieldwidth
- The width of the gap introduced
-
SpanGapQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
fieldName
public java.lang.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 java.io.IOExceptionDescription copied from interface:QueryBuilder
Converts this QueryBuilder to a luceneQuery
. Returnsnull
if this query should be ignored in the context of parent queries.- Specified by:
toQuery
in interfaceQueryBuilder
- Parameters:
context
- additional information needed to construct the queries- Returns:
- the
Query
ornull
if this query should be ignored upstream - Throws:
java.io.IOException
-
queryName
public java.lang.String queryName()Description copied from interface:QueryBuilder
Returns the arbitrary name assigned to the query (see named queries).- Specified by:
queryName
in interfaceQueryBuilder
-
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 theQueryBuilder
so that calls can be chained. This is done automatically when extendingAbstractQueryBuilder
.- Specified by:
queryName
in interfaceQueryBuilder
-
boost
public float boost()Description copied from interface:QueryBuilder
Returns the boost for this query.- Specified by:
boost
in interfaceQueryBuilder
-
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 theQueryBuilder
so that calls can be chained. This is done automatically when extendingAbstractQueryBuilder
.- Specified by:
boost
in interfaceQueryBuilder
-
getName
public java.lang.String getName()Description copied from interface:QueryBuilder
Returns the name that identifies uniquely the query- Specified by:
getName
in interfaceQueryBuilder
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
-
writeTo
Description copied from interface:Writeable
Write this into the StreamOutput. -
toXContent
public org.elasticsearch.common.xcontent.XContentBuilder toXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
toXContent
in interfaceorg.elasticsearch.common.xcontent.ToXContent
- Throws:
java.io.IOException
-
fromXContent
public static SpanNearQueryBuilder.SpanGapQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
equals
public final boolean equals(java.lang.Object obj)- Overrides:
equals
in classjava.lang.Object
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classjava.lang.Object
-
toString
public final java.lang.String toString()- Overrides:
toString
in classjava.lang.Object
-
throwParsingExceptionOnMultipleFields
protected static void throwParsingExceptionOnMultipleFields(java.lang.String queryName, org.elasticsearch.common.xcontent.XContentLocation contentLocation, java.lang.String processedFieldName, java.lang.String currentFieldName)
-