org.elasticsearch.index.query

Class GeoShapeFilterParser

java.lang.Object

org.elasticsearch.index.query.GeoShapeFilterParser

All Implemented Interfaces:

FilterParser

public class GeoShapeFilterParser
extends Object
implements FilterParser

FilterParser for filtering Documents based on Shapes.

Only those fields mapped using GeoShapeFieldMapper can be filtered using this parser.

Format supported:

 "field" : {
     "relation" : "intersects",
     "shape" : {
         "type" : "polygon",
         "coordinates" : [
              [ [100.0, 0.0], [101.0, 0.0], [101.0, 1.0], [100.0, 1.0], [100.0, 0.0] ]
         ]
     }
 }
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	GeoShapeFilterParser.DEFAULTS

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAME

Constructor Summary

Constructors

Constructor and Description
GeoShapeFilterParser()

Method Summary

Modifier and Type	Method and Description
String[]	names() The names this filter is registered under.
org.apache.lucene.search.Filter	parse(QueryParseContext parseContext) Parses the into a filter from the current parser location.
void	setFetchService(ShapeFetchService fetchService)

Methods inherited from class java.lang.Object

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

Field Detail

NAME

public static final String NAME

See Also:

Constant Field Values

Constructor Detail

GeoShapeFilterParser

public GeoShapeFilterParser()

Method Detail

names

public String[] names()

Description copied from interface: FilterParser

The names this filter is registered under.

Specified by:

names in interface FilterParser

parse

public org.apache.lucene.search.Filter parse(QueryParseContext parseContext)
                                      throws IOException,
                                             QueryParsingException

Description copied from interface: FilterParser

Parses the into a filter from the current parser location. Will be at "START_OBJECT" location, and should end when the token is at the matching "END_OBJECT".

The parser should return null value when it should be ignored, regardless under which context it is. For example, an and filter with "and []" (no clauses), should be ignored regardless if it exists within a must clause or a must_not bool clause (that is why returning MATCH_ALL will not be good, since it will not match anything when returned within a must_not clause).

Specified by:

parse in interface FilterParser

Throws:

IOException

QueryParsingException

setFetchService

@Inject(optional=true)
public void setFetchService(@Nullable
                                                   ShapeFetchService fetchService)