sirius.db.es.constraints

Class NestedQuery

java.lang.Object

sirius.db.es.constraints.NestedQuery

public class NestedQuery
extends Object

Executes a nested query.

Nested queries must be used along with nested lists. Otherwise, if there are several objects nested in a list, an entity would also match, if the filtered properties match against any of the nested objects instead of all in a single one - which is most commonly wanted.

See: https://www.elastic.co/guide/en/elasticsearch/reference/current/query-dsl-nested-query.html

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	NestedQuery(Mapping path) Creates a new nested query for elements in the given field / list.

Method Summary

Modifier and Type	Method and Description
ElasticConstraint	build() Compiles the query into a constraint.
NestedQuery	eq(Mapping field, Object value) Adds a simple FilterFactory.eq(Mapping, Object) filter as inner filter.
NestedQuery	where(ElasticConstraint constraint) Appends an inner constraint.

Methods inherited from class java.lang.Object

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

Constructor Detail

NestedQuery

protected NestedQuery(Mapping path)

Creates a new nested query for elements in the given field / list.

Parameters:

path - the name of the list to search in.

Method Detail

where

public NestedQuery where(ElasticConstraint constraint)

Appends an inner constraint.

Note that all fields must be fully qualified (e.g. list.valueX instead of simly valueX).

Parameters:

constraint - the filter to add

Returns:

the nested query itself for fluent method calls

eq

public NestedQuery eq(Mapping field,
                      Object value)

Adds a simple FilterFactory.eq(Mapping, Object) filter as inner filter.

Parameters:

field - the fully qualified field to filter on

value - the value to filter on

Returns:

the nested query itself for fluent method calls

build

public ElasticConstraint build()

Compiles the query into a constraint.

Returns:

the effective constaint which can be applied on a query