java.lang.Object

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

org.opensearch.index.query.SpanNotQueryBuilder

All Implemented Interfaces:: NamedWriteable, Writeable, org.opensearch.common.xcontent.ToXContent, org.opensearch.common.xcontent.ToXContentObject, QueryBuilder, Rewriteable<QueryBuilder>, SpanQueryBuilder

public class SpanNotQueryBuilder
extends AbstractQueryBuilder<SpanNotQueryBuilder>
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 int`	`DEFAULT_POST`	the default post parameter size
`static int`	`DEFAULT_PRE`	the default pre parameter size
`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
`SpanNotQueryBuilder(StreamInput in)`	Read from a stream.
`SpanNotQueryBuilder(SpanQueryBuilder include, SpanQueryBuilder exclude)`	Construct a span query matching spans from `include` which have no overlap with spans from `exclude`.

Method Summary

Modifier and Type	Method	Description
`SpanNotQueryBuilder`	`dist(int dist)`
`protected boolean`	`doEquals(SpanNotQueryBuilder 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)`
`SpanQueryBuilder`	`excludeQuery()`
`static SpanNotQueryBuilder`	`fromXContent(org.opensearch.common.xcontent.XContentParser parser)`
`java.lang.String`	`getWriteableName()`	Returns the name of the writeable object
`SpanQueryBuilder`	`includeQuery()`
`java.lang.Integer`	`post()`
`SpanNotQueryBuilder`	`post(int post)`
`java.lang.Integer`	`pre()`
`SpanNotQueryBuilder`	`pre(int pre)`

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
- DEFAULT_PRE
  
  public static final int DEFAULT_PRE
  
  the default pre parameter size
  
  See Also:
  
  Constant Field Values
- DEFAULT_POST
  
  public static final int DEFAULT_POST
  
  the default post parameter size
  
  See Also:
  
  Constant Field Values
Constructor Details
- SpanNotQueryBuilder
  
  public SpanNotQueryBuilder(SpanQueryBuilder include, SpanQueryBuilder exclude)
  
  Construct a span query matching spans from include which have no overlap with spans from exclude.
  
  Parameters:
  
  include - the span query whose matches are filtered
  
  exclude - the span query whose matches must not overlap
- SpanNotQueryBuilder
  
  public SpanNotQueryBuilder(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<SpanNotQueryBuilder>
  
  Throws:
  
  java.io.IOException
- includeQuery
  
  public SpanQueryBuilder includeQuery()
  
  Returns:
  
  the span query whose matches are filtered
- excludeQuery
  
  public SpanQueryBuilder excludeQuery()
  
  Returns:
  
  the span query whose matches must not overlap
- dist
  
  public SpanNotQueryBuilder dist(int dist)
  
  Parameters:
  
  dist - the amount of tokens from within the include span can’t have overlap with the exclude span. Equivalent to setting both pre and post parameter.
- pre
  
  public SpanNotQueryBuilder pre(int pre)
  
  Parameters:
  
  pre - the amount of tokens before the include span that can’t have overlap with the exclude span. Values smaller than 0 will be ignored and 0 used instead.
- pre
  
  public java.lang.Integer pre()
  
  Returns:
  
  the amount of tokens before the include span that can’t have overlap with the exclude span.
  
  See Also:
  
  pre(int)
- post
  
  public SpanNotQueryBuilder post(int post)
  
  Parameters:
  
  post - the amount of tokens after the include span that can’t have overlap with the exclude span.
- post
  
  public java.lang.Integer post()
  
  Returns:
  
  the amount of tokens after the include span that can’t have overlap with the exclude span.
  
  See Also:
  
  post(int)
- 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<SpanNotQueryBuilder>
  
  Throws:
  
  java.io.IOException
- fromXContent
  
  public static SpanNotQueryBuilder 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<SpanNotQueryBuilder>
  
  Throws:
  
  java.io.IOException
- doHashCode
  
  protected int doHashCode()
  
  Specified by:
  
  doHashCode in class AbstractQueryBuilder<SpanNotQueryBuilder>
- doEquals
  
  protected boolean doEquals(SpanNotQueryBuilder 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<SpanNotQueryBuilder>
- getWriteableName
  
  public java.lang.String getWriteableName()
  
  Description copied from interface: NamedWriteable
  
  Returns the name of the writeable object
  
  Specified by:
  
  getWriteableName in interface NamedWriteable

Class SpanNotQueryBuilder

Nested Class Summary

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

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

Nested classes/interfaces inherited from interface org.opensearch.common.io.stream.Writeable