org.elasticsearch.index.query

Class GeoShapeQueryBuilder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.QueryBuilder

org.elasticsearch.index.query.GeoShapeQueryBuilder

All Implemented Interfaces:

ToXContent, BoostableQueryBuilder<GeoShapeQueryBuilder>

public class GeoShapeQueryBuilder
extends QueryBuilder
implements BoostableQueryBuilder<GeoShapeQueryBuilder>

QueryBuilder that builds a GeoShape Filter

Nested Class Summary

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

ToXContent.DelegatingMapParams, ToXContent.MapParams, ToXContent.Params

Field Summary

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

EMPTY_PARAMS

Constructor Summary

Constructors

Constructor and Description
GeoShapeQueryBuilder(String name, ShapeBuilder shape) Creates a new GeoShapeQueryBuilder whose Filter will be against the given field name using the given Shape
GeoShapeQueryBuilder(String name, ShapeBuilder shape, ShapeRelation relation) Creates a new GeoShapeQueryBuilder whose Filter will be against the given field name using the given Shape
GeoShapeQueryBuilder(String name, String indexedShapeId, String indexedShapeType, ShapeRelation relation) Creates a new GeoShapeQueryBuilder whose Filter will be against the given field name and will use the Shape found with the given ID in the given type

Method Summary

Methods

Modifier and Type	Method and Description
GeoShapeQueryBuilder	boost(float boost) Sets the boost for this query.
protected void	doXContent(XContentBuilder builder, ToXContent.Params params)
GeoShapeQueryBuilder	indexedShapeIndex(String indexedShapeIndex) Sets the name of the index where the indexed Shape can be found
GeoShapeQueryBuilder	indexedShapePath(String indexedShapePath) Sets the path of the field in the indexed Shape document that has the Shape itself
GeoShapeQueryBuilder	queryName(String queryName) Sets the name of the filter
GeoShapeQueryBuilder	relation(ShapeRelation relation) Sets the relation of query shape and indexed shape.
GeoShapeQueryBuilder	strategy(SpatialStrategy strategy) Defines which spatial strategy will be used for building the geo shape filter.

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

toXContent

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

buildAsBytes, buildAsBytes, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

GeoShapeQueryBuilder

public GeoShapeQueryBuilder(String name,
                    ShapeBuilder shape)

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

Parameters:

name - Name of the field that will be filtered

shape - Shape used in the filter

GeoShapeQueryBuilder

public GeoShapeQueryBuilder(String name,
                    ShapeBuilder shape,
                    ShapeRelation relation)

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

Parameters:

name - Name of the field that will be filtered

relation - ShapeRelation of query and indexed shape

shape - Shape used in the filter

GeoShapeQueryBuilder

public GeoShapeQueryBuilder(String name,
                    String indexedShapeId,
                    String indexedShapeType,
                    ShapeRelation relation)

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

Parameters:

name - Name of the field that will be filtered

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

indexedShapeType - Index type of the indexed Shapes

Method Detail

queryName

public GeoShapeQueryBuilder queryName(String queryName)

Sets the name of the filter

Parameters:

queryName - Name of the filter

Returns:

this

strategy

public GeoShapeQueryBuilder strategy(SpatialStrategy strategy)

Defines which spatial strategy will be used for building the geo shape filter. 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 filter

Returns:

this

indexedShapeIndex

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

indexedShapePath

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

relation

public GeoShapeQueryBuilder relation(ShapeRelation relation)

Sets the relation of query shape and indexed shape.

Parameters:

relation - relation of the shapes

Returns:

this

boost

public GeoShapeQueryBuilder boost(float boost)

Description copied from interface: BoostableQueryBuilder

Sets the boost for this query. Documents matching this query will (in addition to the normal weightings) have their score multiplied by the boost provided.

Specified by:

boost in interface BoostableQueryBuilder<GeoShapeQueryBuilder>

doXContent

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

Specified by:

doXContent in class QueryBuilder

Throws:

IOException