java.lang.Object
org.elasticsearch.index.query.AbstractQueryBuilder<SpanNearQueryBuilder>
org.elasticsearch.index.query.SpanNearQueryBuilder
- All Implemented Interfaces:
NamedWriteable,VersionedNamedWriteable,Writeable,QueryBuilder,Rewriteable<QueryBuilder>,SpanQueryBuilder,ToXContent,ToXContentObject
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 ClassesModifier and TypeClassDescriptionstatic classSpanGapQueryBuilder enables gaps in a SpanNearQuery.Nested classes/interfaces inherited from interface org.elasticsearch.index.query.SpanQueryBuilder
SpanQueryBuilder.SpanQueryBuilderUtilNested classes/interfaces inherited from interface org.elasticsearch.xcontent.ToXContent
ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.ParamsNested classes/interfaces inherited from interface org.elasticsearch.common.io.stream.Writeable
Writeable.Reader<V>, Writeable.Writer<V> -
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final booleanDefault for flag controlling whether matches are required to be in-orderstatic final intDefault slop value, this is the same that luceneSpanNearQueryuses if no slop is providedstatic final StringFields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryNameFields inherited from interface org.elasticsearch.index.query.Rewriteable
MAX_REWRITE_ROUNDSFields inherited from interface org.elasticsearch.xcontent.ToXContent
EMPTY, EMPTY_PARAMS -
Constructor Summary
ConstructorsConstructorDescriptionRead from a stream.SpanNearQueryBuilder(SpanQueryBuilder initialClause, int slop) -
Method Summary
Modifier and TypeMethodDescriptionaddClause(SpanQueryBuilder clause) Add a span clause to the current list of clausesclauses()protected booleandoEquals(SpanNearQueryBuilder other) Indicates whether some otherQueryBuilderobject of the same type is "equal to" this one.protected intprotected org.apache.lucene.search.QuerydoToQuery(SearchExecutionContext context) protected voiddoWriteTo(StreamOutput out) protected voiddoXContent(XContentBuilder builder, ToXContent.Params params) static SpanNearQueryBuilderfromXContent(XContentParser parser) The minimal version of the recipient this object can be sent to.Returns the name of the writeable objectbooleaninOrder()inOrder(boolean inOrder) WheninOrderis true, the spans from each clause must be in the same order as inclausesand must be non-overlapping.intslop()Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder
addValidationError, boost, boost, boostAndQueryNameToXContent, checkNegativeBoost, declareStandardFields, doCoordinatorRewrite, doIndexMetadataRewrite, doInnerHitsRewrite, doRewrite, doSearchRewrite, equals, extractInnerHitBuilders, getMaxNestedDepth, getName, hashCode, parseInnerQueryBuilder, parseTopLevelQuery, parseTopLevelQuery, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, setMaxNestedDepth, throwParsingExceptionOnMultipleFields, toQuery, toString, toXContent, writeQueries, writeToMethods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, waitMethods inherited from interface org.elasticsearch.index.query.QueryBuilder
boost, boost, getName, queryName, queryName, rewrite, toQueryMethods inherited from interface org.elasticsearch.xcontent.ToXContent
toXContentMethods inherited from interface org.elasticsearch.xcontent.ToXContentObject
isFragmentMethods inherited from interface org.elasticsearch.common.io.stream.VersionedNamedWriteable
supportsVersion
-
Field Details
-
NAME
- See Also:
-
DEFAULT_IN_ORDER
public static final boolean DEFAULT_IN_ORDERDefault for flag controlling whether matches are required to be in-order- See Also:
-
DEFAULT_SLOP
public static final int DEFAULT_SLOPDefault slop value, this is the same that luceneSpanNearQueryuses if no slop is provided- See Also:
-
-
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:
IOException
-
-
Method Details
-
doWriteTo
- Specified by:
doWriteToin classAbstractQueryBuilder<SpanNearQueryBuilder>- Throws:
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
SpanQueryBuilderclauses that were set for this query
-
inOrder
WheninOrderis true, the spans from each clause must be in the same order as inclausesand must be non-overlapping. Defaults totrue -
inOrder
public boolean inOrder()- See Also:
-
doXContent
- Specified by:
doXContentin classAbstractQueryBuilder<SpanNearQueryBuilder>- Throws:
IOException
-
fromXContent
- Throws:
IOException
-
doToQuery
protected org.apache.lucene.search.Query doToQuery(SearchExecutionContext context) throws IOException - Specified by:
doToQueryin classAbstractQueryBuilder<SpanNearQueryBuilder>- Throws:
IOException
-
doHashCode
protected int doHashCode()- Specified by:
doHashCodein classAbstractQueryBuilder<SpanNearQueryBuilder>
-
doEquals
Description copied from class:AbstractQueryBuilderIndicates whether some otherQueryBuilderobject of the same type is "equal to" this one.- Specified by:
doEqualsin classAbstractQueryBuilder<SpanNearQueryBuilder>
-
getWriteableName
Description copied from interface:VersionedNamedWriteableReturns the name of the writeable object- Specified by:
getWriteableNamein interfaceNamedWriteable- Specified by:
getWriteableNamein interfaceVersionedNamedWriteable
-
getMinimalSupportedVersion
Description copied from interface:VersionedNamedWriteableThe minimal version of the recipient this object can be sent to. SeeVersionedNamedWriteable.supportsVersion(TransportVersion)for the default serialization check.- Specified by:
getMinimalSupportedVersionin interfaceVersionedNamedWriteable
-