io.georocket.query

Class ElasticsearchQueryHelper

java.lang.Object

io.georocket.query.ElasticsearchQueryHelper

public final class ElasticsearchQueryHelper
extends Object

Helper methods to build Elasticsearch queries

Since:

1.0.0

Author:

Michel Kraemer

Method Summary

Modifier and Type	Method and Description
static void	boolAddFilter(JsonObject bool, JsonObject filter) Add a filter to a bool query.
static void	boolAddMust(JsonObject bool, JsonObject must) Add a "must" clause to a bool query.
static void	boolAddMustNot(JsonObject bool, JsonObject mustNot) Add a "must_not" clause to a bool query.
static void	boolAddShould(JsonObject bool, JsonObject should) Add a "should" clause to a bool query.
static JsonObject	boolQuery() Create a query that allows for boolean combinations of other queries
static JsonObject	geoShapeQuery(String name, JsonObject shape, String relation) Create a query that looks for documents matching a geo shape
static JsonObject	matchAllQuery() Create a query that matches all documents
static JsonObject	multiMatchQuery(Object text, String... fieldNames) Create a query that compares a value to multiple fields
static JsonObject	prefixQuery(String name, Object prefix) Create a query that looks for a field starting with a given prefix
static JsonObject	shape(String type, JsonArray coordinates) Create a geo shape
static JsonObject	termQuery(String name, Object value) Create a term query to exactly compare a field to a value

Methods inherited from class java.lang.Object

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

Method Detail

boolQuery

public static JsonObject boolQuery()

Create a query that allows for boolean combinations of other queries

Returns:

the query

boolAddFilter

public static void boolAddFilter(JsonObject bool,
                                 JsonObject filter)

Add a filter to a bool query. Do not add it if the clause already exists in the query.

Parameters:

bool - the bool query

filter - the filter to add

boolAddMust

public static void boolAddMust(JsonObject bool,
                               JsonObject must)

Add a "must" clause to a bool query. Do not add it if the clause already exists in the query.

Parameters:

bool - the bool query

must - the clause to add

boolAddMustNot

public static void boolAddMustNot(JsonObject bool,
                                  JsonObject mustNot)

Add a "must_not" clause to a bool query. Do not add it if the clause already exists in the query.

Parameters:

bool - the bool query

mustNot - the clause to add

boolAddShould

public static void boolAddShould(JsonObject bool,
                                 JsonObject should)

Add a "should" clause to a bool query. Do not add it if the clause already exists in the query.

Parameters:

bool - the bool query

should - the clause to add

termQuery

public static JsonObject termQuery(String name,
                                   Object value)

Create a term query to exactly compare a field to a value

Parameters:

name - the field's name

value - the value to compare to

Returns:

the term query

matchAllQuery

public static JsonObject matchAllQuery()

Create a query that matches all documents

Returns:

the query

multiMatchQuery

public static JsonObject multiMatchQuery(Object text,
                                         String... fieldNames)

Create a query that compares a value to multiple fields

Parameters:

text - the value

fieldNames - the names of the fields to compare to

Returns:

the query

prefixQuery

public static JsonObject prefixQuery(String name,
                                     Object prefix)

Create a query that looks for a field starting with a given prefix

Parameters:

name - the field's name

prefix - the prefix

Returns:

the query

geoShapeQuery

public static JsonObject geoShapeQuery(String name,
                                       JsonObject shape,
                                       String relation)

Create a query that looks for documents matching a geo shape

Parameters:

name - the field name containing the document's geo shape

shape - the geo shape to compare to

relation - the relation used for comparison (i.e. "intersects", "disjoint", "within", "contains")

Returns:

the query

shape

public static JsonObject shape(String type,
                               JsonArray coordinates)

Create a geo shape

Parameters:

type - the shape's type (e.g. "envelope")

coordinates - the shape's coordinates

Returns:

the shape