Package org.elasticsearch.index.query
Class SpanNearQueryBuilder
java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<SpanNearQueryBuilder>
org.elasticsearch.index.query.SpanNearQueryBuilder
- All Implemented Interfaces:
NamedWriteable
,Writeable
,org.elasticsearch.common.xcontent.ToXContent
,org.elasticsearch.common.xcontent.ToXContentObject
,QueryBuilder
,Rewriteable<QueryBuilder>
,SpanQueryBuilder
public class SpanNearQueryBuilder extends AbstractQueryBuilder<SpanNearQueryBuilder> implements SpanQueryBuilder
Matches spans which are near one another. One can specify slop, the maximum number
of intervening unmatched positions, as well as whether matches are required to be in-order.
The span near query maps to Lucene
SpanNearQuery
.-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
SpanNearQueryBuilder.SpanGapQueryBuilder
SpanGapQueryBuilder enables gaps in a SpanNearQuery.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 boolean
DEFAULT_IN_ORDER
Default for flag controlling whether matches are required to be in-orderstatic int
DEFAULT_SLOP
Default slop value, this is the same that luceneSpanNearQuery
uses if no slop is providedstatic java.lang.String
NAME
Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName
-
Constructor Summary
Constructors Constructor Description SpanNearQueryBuilder(StreamInput in)
Read from a stream.SpanNearQueryBuilder(SpanQueryBuilder initialClause, int slop)
-
Method Summary
Modifier and Type Method Description SpanNearQueryBuilder
addClause(SpanQueryBuilder clause)
Add a span clause to the current list of clausesjava.util.List<SpanQueryBuilder>
clauses()
protected boolean
doEquals(SpanNearQueryBuilder other)
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.protected int
doHashCode()
protected org.apache.lucene.search.Query
doToQuery(QueryShardContext context)
protected void
doWriteTo(StreamOutput out)
protected void
doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params)
static SpanNearQueryBuilder
fromXContent(org.elasticsearch.common.xcontent.XContentParser parser)
java.lang.String
getWriteableName()
Returns the name of the writeable objectboolean
inOrder()
SpanNearQueryBuilder
inOrder(boolean inOrder)
WheninOrder
is true, the spans from each clause must be in the same order as inclauses
and must be non-overlapping.int
slop()
Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, checkNegativeBoost, declareStandardFields, doRewrite, equals, extractInnerHitBuilders, getName, hashCode, 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
-
Field Details
-
NAME
public static final java.lang.String NAME- See Also:
- Constant Field Values
-
DEFAULT_IN_ORDER
public static boolean DEFAULT_IN_ORDERDefault for flag controlling whether matches are required to be in-order -
DEFAULT_SLOP
public static int DEFAULT_SLOPDefault slop value, this is the same that luceneSpanNearQuery
uses if no slop is provided
-
-
Constructor Details
-
SpanNearQueryBuilder
- Parameters:
initialClause
- an initial span query clauseslop
- controls the maximum number of intervening unmatched positions permitted
-
SpanNearQueryBuilder
Read from a stream.- Throws:
java.io.IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteTo
in classAbstractQueryBuilder<SpanNearQueryBuilder>
- Throws:
java.io.IOException
-
slop
public int slop()- Returns:
- the maximum number of intervening unmatched positions permitted
-
addClause
Add a span clause to the current list of clauses -
clauses
- Returns:
- the
SpanQueryBuilder
clauses that were set for this query
-
inOrder
WheninOrder
is true, the spans from each clause must be in the same order as inclauses
and must be non-overlapping. Defaults totrue
-
inOrder
public boolean inOrder()- See Also:
inOrder(boolean)
-
doXContent
protected void doXContent(org.elasticsearch.common.xcontent.XContentBuilder builder, org.elasticsearch.common.xcontent.ToXContent.Params params) throws java.io.IOException- Specified by:
doXContent
in classAbstractQueryBuilder<SpanNearQueryBuilder>
- Throws:
java.io.IOException
-
fromXContent
public static SpanNearQueryBuilder fromXContent(org.elasticsearch.common.xcontent.XContentParser parser) throws java.io.IOException- Throws:
java.io.IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(QueryShardContext context) throws java.io.IOException- Specified by:
doToQuery
in classAbstractQueryBuilder<SpanNearQueryBuilder>
- Throws:
java.io.IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCode
in classAbstractQueryBuilder<SpanNearQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilder
Indicates whether some otherQueryBuilder
object of the same type is "equal to" this one.- Specified by:
doEquals
in classAbstractQueryBuilder<SpanNearQueryBuilder>
-
getWriteableName
public java.lang.String getWriteableName()Description copied from interface:NamedWriteable
Returns the name of the writeable object- Specified by:
getWriteableName
in interfaceNamedWriteable
-