Package org.opensearch.index.query

Class SpanWithinQueryBuilder

java.lang.Object

org.opensearch.index.query.AbstractQueryBuilder<SpanWithinQueryBuilder>

org.opensearch.index.query.SpanWithinQueryBuilder

All Implemented Interfaces:

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

public class SpanWithinQueryBuilder
extends AbstractQueryBuilder<SpanWithinQueryBuilder>
implements SpanQueryBuilder

Builder for SpanWithinQuery.

Opensearch.internal:

Nested Class Summary

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

SpanQueryBuilder.SpanQueryBuilderUtil

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

org.opensearch.common.xcontent.ToXContent.DelegatingMapParams, org.opensearch.common.xcontent.ToXContent.MapParams, org.opensearch.common.xcontent.ToXContent.Params

Nested classes/interfaces inherited from interface org.opensearch.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 class org.opensearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

Fields inherited from interface org.opensearch.index.query.Rewriteable

MAX_REWRITE_ROUNDS

Fields inherited from interface org.opensearch.common.xcontent.ToXContent

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor	Description
SpanWithinQueryBuilder(StreamInput in)	Read from a stream.
SpanWithinQueryBuilder(SpanQueryBuilder big, SpanQueryBuilder little)	Query that returns spans from little that are contained in a spans from big.

Method Summary

Modifier and Type	Method	Description
SpanQueryBuilder	bigQuery()
protected boolean	doEquals(SpanWithinQueryBuilder 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(QueryShardContext context)
protected void	doWriteTo(StreamOutput out)
protected void	doXContent(org.opensearch.common.xcontent.XContentBuilder builder, org.opensearch.common.xcontent.ToXContent.Params params)
static SpanWithinQueryBuilder	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
String	getWriteableName()	Returns the name of the writeable object
SpanQueryBuilder	littleQuery()

Methods inherited from class org.opensearch.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

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

boost, boost, getName, queryName, queryName, rewrite, toQuery

Methods inherited from interface org.opensearch.common.xcontent.ToXContent

toXContent

Methods inherited from interface org.opensearch.common.xcontent.ToXContentObject

isFragment

Methods inherited from interface org.opensearch.common.io.stream.Writeable

writeTo

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

Constructor Details

SpanWithinQueryBuilder

public SpanWithinQueryBuilder(SpanQueryBuilder big,
 SpanQueryBuilder little)

Query that returns spans from little that are contained in a spans from big.

Parameters:

big - clause that must enclose little for a match.

little - the little clause, it must be contained within big for a match.

SpanWithinQueryBuilder

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

Throws:

IOException

littleQuery

public SpanQueryBuilder littleQuery()

Returns:

the little clause, contained within big for a match.

bigQuery

public SpanQueryBuilder bigQuery()

Returns:

the big clause that must enclose little for a match.

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<SpanWithinQueryBuilder>

Throws:

IOException

fromXContent

public static SpanWithinQueryBuilder fromXContent(org.opensearch.common.xcontent.XContentParser parser)
                                           throws IOException

Throws:

IOException

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<SpanWithinQueryBuilder>

Throws:

IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<SpanWithinQueryBuilder>

doEquals

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

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable