org.elasticsearch.index.query

Class GeoShapeQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

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

org.elasticsearch.index.query.GeoShapeQueryBuilder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder

public class GeoShapeQueryBuilder
extends AbstractQueryBuilder<GeoShapeQueryBuilder>

QueryBuilder that builds a GeoShape Query

Nested Class Summary

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

Writeable.Reader<V>, Writeable.Writer<V>

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	DEFAULT_SHAPE_FIELD_NAME
static java.lang.String	DEFAULT_SHAPE_INDEX_NAME
static ShapeRelation	DEFAULT_SHAPE_RELATION
static java.lang.String	NAME

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
GeoShapeQueryBuilder(StreamInput in) Read from a stream.
GeoShapeQueryBuilder(java.lang.String fieldName, ShapeBuilder shape) Creates a new GeoShapeQueryBuilder whose Query will be against the given field name using the given Shape
GeoShapeQueryBuilder(java.lang.String fieldName, java.lang.String indexedShapeId, java.lang.String indexedShapeType) Creates a new GeoShapeQueryBuilder whose Query will be against the given field name and will use the Shape found with the given ID in the given type

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(GeoShapeQueryBuilder other) Indicates whether some other QueryBuilder object of the same type is "equal to" this one.
protected int	doHashCode()
protected QueryBuilder	doRewrite(QueryRewriteContext queryShardContext)
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 java.util.Optional<GeoShapeQueryBuilder>	fromXContent(QueryParseContext parseContext)
static org.apache.lucene.spatial.query.SpatialArgs	getArgs(ShapeBuilder shape, ShapeRelation relation)
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.
GeoShapeQueryBuilder	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.lang.String	indexedShapeId()
java.lang.String	indexedShapeIndex()
GeoShapeQueryBuilder	indexedShapeIndex(java.lang.String indexedShapeIndex) Sets the name of the index where the indexed Shape can be found
java.lang.String	indexedShapePath()
GeoShapeQueryBuilder	indexedShapePath(java.lang.String indexedShapePath) Sets the path of the field in the indexed Shape document that has the Shape itself
java.lang.String	indexedShapeType()
ShapeRelation	relation()
GeoShapeQueryBuilder	relation(ShapeRelation relation) Sets the relation of query shape and indexed shape.
ShapeBuilder	shape()
SpatialStrategy	strategy()
GeoShapeQueryBuilder	strategy(SpatialStrategy strategy) Defines which spatial strategy will be used for building the geo shape Query.

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

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

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

buildAsBytes, buildAsBytes, toString, 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

DEFAULT_SHAPE_INDEX_NAME

public static final java.lang.String DEFAULT_SHAPE_INDEX_NAME

See Also:

Constant Field Values

DEFAULT_SHAPE_FIELD_NAME

public static final java.lang.String DEFAULT_SHAPE_FIELD_NAME

See Also:

Constant Field Values

DEFAULT_SHAPE_RELATION

public static final ShapeRelation DEFAULT_SHAPE_RELATION

DEFAULT_IGNORE_UNMAPPED

public static final boolean DEFAULT_IGNORE_UNMAPPED

The default value for ignore_unmapped.

See Also:

Constant Field Values

Constructor Detail

GeoShapeQueryBuilder

public GeoShapeQueryBuilder(java.lang.String fieldName,
                            ShapeBuilder shape)

Creates a new GeoShapeQueryBuilder whose Query will be against the given field name using the given Shape

Parameters:

fieldName - Name of the field that will be queried

shape - Shape used in the Query

GeoShapeQueryBuilder

public GeoShapeQueryBuilder(java.lang.String fieldName,
                            java.lang.String indexedShapeId,
                            java.lang.String indexedShapeType)

Creates a new GeoShapeQueryBuilder whose Query will be against the given field name and will use the Shape found with the given ID in the given type

Parameters:

fieldName - Name of the field that will be filtered

indexedShapeId - ID of the indexed Shape that will be used in the Query

indexedShapeType - Index type of the indexed Shapes

GeoShapeQueryBuilder

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

Throws:

java.io.IOException

fieldName

public java.lang.String fieldName()

Returns:

the name of the field that will be queried

shape

public ShapeBuilder shape()

Returns:

the shape used in the Query

indexedShapeId

public java.lang.String indexedShapeId()

Returns:

the ID of the indexed Shape that will be used in the Query

indexedShapeType

public java.lang.String indexedShapeType()

Returns:

the document type of the indexed Shape that will be used in the Query

strategy

public GeoShapeQueryBuilder strategy(SpatialStrategy strategy)

Defines which spatial strategy will be used for building the geo shape Query. When not set, the strategy that will be used will be the one that is associated with the geo shape field in the mappings.

Parameters:

strategy - The spatial strategy to use for building the geo shape Query

Returns:

this

strategy

public SpatialStrategy strategy()

Returns:

The spatial strategy to use for building the geo shape Query

indexedShapeIndex

public GeoShapeQueryBuilder indexedShapeIndex(java.lang.String indexedShapeIndex)

Sets the name of the index where the indexed Shape can be found

Parameters:

indexedShapeIndex - Name of the index where the indexed Shape is

Returns:

this

indexedShapeIndex

public java.lang.String indexedShapeIndex()

Returns:

the index name for the indexed Shape that will be used in the Query

indexedShapePath

public GeoShapeQueryBuilder indexedShapePath(java.lang.String indexedShapePath)

Sets the path of the field in the indexed Shape document that has the Shape itself

Parameters:

indexedShapePath - Path of the field where the Shape itself is defined

Returns:

this

indexedShapePath

public java.lang.String indexedShapePath()

Returns:

the path of the indexed Shape that will be used in the Query

relation

public GeoShapeQueryBuilder relation(ShapeRelation relation)

Sets the relation of query shape and indexed shape.

Parameters:

relation - relation of the shapes

Returns:

this

relation

public ShapeRelation relation()

Returns:

the relation of query shape and indexed shape to use in the Query

ignoreUnmapped

public GeoShapeQueryBuilder 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)

Specified by:

doToQuery in class AbstractQueryBuilder<GeoShapeQueryBuilder>

getArgs

public static org.apache.lucene.spatial.query.SpatialArgs getArgs(ShapeBuilder shape,
                                                                  ShapeRelation relation)

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<GeoShapeQueryBuilder>

Throws:

java.io.IOException

fromXContent

public static java.util.Optional<GeoShapeQueryBuilder> fromXContent(QueryParseContext parseContext)
                                                             throws java.io.IOException

Throws:

java.io.IOException

doEquals

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

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<GeoShapeQueryBuilder>

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object

doRewrite

protected QueryBuilder doRewrite(QueryRewriteContext queryShardContext)
                          throws java.io.IOException

Overrides:

doRewrite in class AbstractQueryBuilder<GeoShapeQueryBuilder>

Throws:

java.io.IOException