Package org.opensearch.index.query

Class GeoPolygonQueryBuilder

java.lang.Object

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

org.opensearch.index.query.GeoPolygonQueryBuilder

All Implemented Interfaces:

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

public class GeoPolygonQueryBuilder
extends AbstractQueryBuilder<GeoPolygonQueryBuilder>

Query builder for polygon queries

Opensearch.internal:

Nested Class Summary

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 boolean	DEFAULT_IGNORE_UNMAPPED	The default value for ignore_unmapped.
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
GeoPolygonQueryBuilder(String fieldName, List<GeoPoint> points)
GeoPolygonQueryBuilder(StreamInput in)	Read from a stream.

Method Summary

Modifier and Type	Method	Description
protected boolean	doEquals(GeoPolygonQueryBuilder 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)
String	fieldName()
static GeoPolygonQueryBuilder	fromXContent(org.opensearch.common.xcontent.XContentParser parser)
GeoValidationMethod	getValidationMethod()	Returns the validation method to use for geo coordinates.
String	getWriteableName()	Returns the name of the writeable object
boolean	ignoreUnmapped()	Gets whether the query builder will ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the field is unmapped.
GeoPolygonQueryBuilder	ignoreUnmapped(boolean ignoreUnmapped)	Sets whether the query builder should ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the field is unmapped.
List<GeoPoint>	points()
GeoPolygonQueryBuilder	setValidationMethod(GeoValidationMethod method)	Sets the validation method to use for geo coordinates.

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.common.xcontent.ToXContentObject

isFragment

Field Details

NAME

public static final String NAME

See Also:

• Constant Field Values

DEFAULT_IGNORE_UNMAPPED

public static final boolean DEFAULT_IGNORE_UNMAPPED

The default value for ignore_unmapped.

See Also:

• Constant Field Values

Constructor Details

GeoPolygonQueryBuilder

public GeoPolygonQueryBuilder(String fieldName,
 List<GeoPoint> points)

GeoPolygonQueryBuilder

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

Throws:

IOException

fieldName

public String fieldName()

points

public List<GeoPoint> points()

setValidationMethod

public GeoPolygonQueryBuilder setValidationMethod(GeoValidationMethod method)

Sets the validation method to use for geo coordinates.

getValidationMethod

public GeoValidationMethod getValidationMethod()

Returns the validation method to use for geo coordinates.

ignoreUnmapped

public GeoPolygonQueryBuilder ignoreUnmapped(boolean ignoreUnmapped)

Sets whether the query builder should ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the field is unmapped.

ignoreUnmapped

public boolean ignoreUnmapped()

Gets whether the query builder will ignore unmapped fields (and run a MatchNoDocsQuery in place of this query) or throw an exception if the field is unmapped.

doToQuery

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

Specified by:

doToQuery in class AbstractQueryBuilder<GeoPolygonQueryBuilder>

Throws:

IOException

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<GeoPolygonQueryBuilder>

Throws:

IOException

fromXContent

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

Throws:

IOException

doEquals

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

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<GeoPolygonQueryBuilder>

getWriteableName

public String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object