org.elasticsearch.index.query

Class GeoPolygonQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.GeoPolygonQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder<GeoPolygonQueryBuilder>

public class GeoPolygonQueryBuilder
extends AbstractQueryBuilder<GeoPolygonQueryBuilder>

Nested Class Summary

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

Writeable.Reader<R>

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_IGNORE_UNMAPPED The default value for ignore_unmapped.
static java.lang.String	NAME
static ParseField	QUERY_NAME_FIELD

Fields inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

boost, BOOST_FIELD, DEFAULT_BOOST, NAME_FIELD, queryName

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
GeoPolygonQueryBuilder(StreamInput in) Read from a stream.
GeoPolygonQueryBuilder(java.lang.String fieldName, java.util.List<GeoPoint> points)

Method Summary

Modifier and Type	Method and 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(XContentBuilder builder, ToXContent.Params params)
java.lang.String	fieldName()
static GeoPolygonQueryBuilder	fromXContent(QueryParseContext parseContext)
GeoValidationMethod	getValidationMethod() Returns the validation method to use for geo coordinates.
java.lang.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.
java.util.List<GeoPoint>	points()
GeoPolygonQueryBuilder	setValidationMethod(GeoValidationMethod method) Sets the validation method to use for geo coordinates.

Methods inherited from class org.elasticsearch.index.query.AbstractQueryBuilder

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, doRewrite, equals, getName, hashCode, printBoostAndQueryName, queryName, queryName, readQueries, requireValue, rewrite, toFilter, toQueries, toQuery, toXContent, writeQueries, writeTo

Methods inherited from class org.elasticsearch.action.support.ToXContentToBytes

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

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

rewriteQuery

Field Detail

NAME

public static final java.lang.String NAME

See Also:

Constant Field Values

QUERY_NAME_FIELD

public static final ParseField QUERY_NAME_FIELD

DEFAULT_IGNORE_UNMAPPED

public static final boolean DEFAULT_IGNORE_UNMAPPED

The default value for ignore_unmapped.

See Also:

Constant Field Values

Constructor Detail

GeoPolygonQueryBuilder

public GeoPolygonQueryBuilder(java.lang.String fieldName,
                              java.util.List<GeoPoint> points)

GeoPolygonQueryBuilder

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

Read from a stream.

Throws:

java.io.IOException

Method Detail

doWriteTo

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

Specified by:

doWriteTo in class AbstractQueryBuilder<GeoPolygonQueryBuilder>

Throws:

java.io.IOException

fieldName

public java.lang.String fieldName()

points

public java.util.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 java.io.IOException

Specified by:

doToQuery in class AbstractQueryBuilder<GeoPolygonQueryBuilder>

Throws:

java.io.IOException

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<GeoPolygonQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static GeoPolygonQueryBuilder fromXContent(QueryParseContext parseContext)
                                           throws java.io.IOException

Throws:

java.io.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 java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object