Package org.opensearch.index.query

Class SpanFirstQueryBuilder

java.lang.Object

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

org.opensearch.index.query.SpanFirstQueryBuilder

All Implemented Interfaces:

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

public class SpanFirstQueryBuilder
extends AbstractQueryBuilder<SpanFirstQueryBuilder>
implements SpanQueryBuilder

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 java.lang.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
SpanFirstQueryBuilder(StreamInput in)	Read from a stream.
SpanFirstQueryBuilder(SpanQueryBuilder matchBuilder, int end)	Query that matches spans queries defined in matchBuilder whose end position is less than or equal to end.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(SpanFirstQueryBuilder 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)
int	end()
static SpanFirstQueryBuilder	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
java.lang.String	getWriteableName()	Returns the name of the writeable object
SpanQueryBuilder	innerQuery()

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 java.lang.String NAME

See Also:

Constant Field Values

Constructor Details

SpanFirstQueryBuilder

public SpanFirstQueryBuilder(SpanQueryBuilder matchBuilder, int end)

Query that matches spans queries defined in matchBuilder whose end position is less than or equal to end.

Parameters:

matchBuilder - inner SpanQueryBuilder

end - maximum end position of the match, needs to be positive

Throws:

java.lang.IllegalArgumentException - for negative end positions

SpanFirstQueryBuilder

public SpanFirstQueryBuilder(StreamInput in) throws java.io.IOException

Read from a stream.

Throws:

java.io.IOException

Method Details

doWriteTo

protected void doWriteTo(StreamOutput out) throws java.io.IOException

Specified by:

doWriteTo in class AbstractQueryBuilder<SpanFirstQueryBuilder>

Throws:

java.io.IOException

innerQuery

public SpanQueryBuilder innerQuery()

Returns:

the inner SpanQueryBuilder defined in this query

end

public int end()

Returns:

maximum end position of the matching inner span query

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<SpanFirstQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static SpanFirstQueryBuilder fromXContent(org.opensearch.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 class AbstractQueryBuilder<SpanFirstQueryBuilder>

Throws:

java.io.IOException

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<SpanFirstQueryBuilder>

doEquals

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

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

Specified by:

getWriteableName in interface NamedWriteable