org.elasticsearch.index.query

Class GeohashCellQuery.Builder

java.lang.Object

org.elasticsearch.action.support.ToXContentToBytes

org.elasticsearch.index.query.AbstractQueryBuilder<GeohashCellQuery.Builder>

org.elasticsearch.index.query.GeohashCellQuery.Builder

All Implemented Interfaces:

NamedWriteable, Writeable, ToXContent, QueryBuilder

Enclosing class:

GeohashCellQuery

public static class GeohashCellQuery.Builder
extends AbstractQueryBuilder<GeohashCellQuery.Builder>

Builder for a geohashfilter. It needs the fields fieldname and geohash to be set. the default for a neighbor filteing is false.

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 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
Builder(StreamInput in) Read from a stream.
Builder(java.lang.String field, GeoPoint point)
Builder(java.lang.String field, java.lang.String geohash)
Builder(java.lang.String field, java.lang.String geohash, boolean neighbors)

Method Summary

Modifier and Type	Method and Description
protected boolean	doEquals(GeohashCellQuery.Builder 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()
GeohashCellQuery.Builder	fieldName(java.lang.String fieldName)
static java.util.Optional<GeohashCellQuery.Builder>	fromXContent(QueryParseContext parseContext)
java.lang.String	geohash()
GeohashCellQuery.Builder	geohash(java.lang.String geohash)
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.
GeohashCellQuery.Builder	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.
boolean	neighbors()
GeohashCellQuery.Builder	neighbors(boolean neighbors)
GeohashCellQuery.Builder	point(double lat, double lon)
GeohashCellQuery.Builder	point(GeoPoint point)
java.lang.Integer	precision()
GeohashCellQuery.Builder	precision(int levels)
GeohashCellQuery.Builder	precision(java.lang.String precision)

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

addValidationError, boost, boost, convertToBytesRefIfString, convertToStringIfBytesRef, doRewrite, 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

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

Constructor Detail

Builder

public Builder(java.lang.String field,
               GeoPoint point)

Builder

public Builder(java.lang.String field,
               java.lang.String geohash)

Builder

public Builder(java.lang.String field,
               java.lang.String geohash,
               boolean neighbors)

Builder

public Builder(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<GeohashCellQuery.Builder>

Throws:

java.io.IOException

point

public GeohashCellQuery.Builder point(GeoPoint point)

point

public GeohashCellQuery.Builder point(double lat,
                                      double lon)

geohash

public GeohashCellQuery.Builder geohash(java.lang.String geohash)

geohash

public java.lang.String geohash()

precision

public GeohashCellQuery.Builder precision(int levels)

precision

public java.lang.Integer precision()

precision

public GeohashCellQuery.Builder precision(java.lang.String precision)

neighbors

public GeohashCellQuery.Builder neighbors(boolean neighbors)

neighbors

public boolean neighbors()

fieldName

public GeohashCellQuery.Builder fieldName(java.lang.String fieldName)

fieldName

public java.lang.String fieldName()

ignoreUnmapped

public GeohashCellQuery.Builder 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<GeohashCellQuery.Builder>

Throws:

java.io.IOException

doXContent

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

Specified by:

doXContent in class AbstractQueryBuilder<GeohashCellQuery.Builder>

Throws:

java.io.IOException

fromXContent

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

Throws:

java.io.IOException

doEquals

protected boolean doEquals(GeohashCellQuery.Builder 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<GeohashCellQuery.Builder>

doHashCode

protected int doHashCode()

Specified by:

doHashCode in class AbstractQueryBuilder<GeohashCellQuery.Builder>

getWriteableName

public java.lang.String getWriteableName()

Description copied from interface: NamedWriteable

Returns the name of the writeable object