ElasticFilterFactory (SIRIUS db 5.0-rc9 API)

java.lang.Object
- sirius.db.mixing.query.constraints.FilterFactory<ElasticConstraint>
- - sirius.db.es.constraints.ElasticFilterFactory

public class ElasticFilterFactory
extends FilterFactory<ElasticConstraint>

Generates filters and constraints for ElasticQuery.

See Also:: Elastic.FILTERS

Constructor Summary

Constructors
Constructor and Description

ElasticFilterFactory()

Constructors
Constructor and Description
`ElasticFilterFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`sirius.db.es.constraints.ElasticCSVFilter`	`containsAll(Mapping field, sirius.kernel.commons.Value commaSeparatedValues)` Creates a new constraint for the given field which asserts that all of the given values in the string is present.
`sirius.db.es.constraints.ElasticCSVFilter`	`containsAny(Mapping field, sirius.kernel.commons.Value commaSeparatedValues)` Creates a new constraint for the given field which asserts that one of the given values in the string is present.
`protected Object`	`customTransform(Object value)` Permits to provive database dependent transformations.
`protected ElasticConstraint`	`effectiveAnd(List<ElasticConstraint> effectiveConstraints)` Combines the list of constraints using `AND`
`protected ElasticConstraint`	`effectiveOr(List<ElasticConstraint> effectiveConstraints)` Combines the list of constraints using `OR`
`protected ElasticConstraint`	`eqValue(Mapping field, Object value)` Represents `field = value` as constraint
`ElasticConstraint`	`filled(Mapping field)` Generates a constraint which ensures that the given field is filled (not null)
`protected ElasticConstraint`	`gtValue(Mapping field, Object value, boolean orEqual)` Represents `field > value` as constraint
`protected ElasticConstraint`	`invert(ElasticConstraint constraint)` Effectively inverts the given constraint
`protected ElasticConstraint`	`ltValue(Mapping field, Object value, boolean orEqual)` Represents `field < value` as constraint
`NestedQuery`	`nested(Mapping field)` Executes a `nested` query.
`ElasticConstraint`	`nestedMapContains(Mapping mapField, String key, String value)` Creates a filter which ensures, that a nested `StringMap` or `StringListMap` contains the given key and value.
`protected ElasticConstraint`	`neValue(Mapping field, Object value)` Represents `field !`
`ElasticConstraint`	`notFilled(Mapping field)` Generates a constraint which ensures that the given field is not filled (null)
`ElasticConstraint`	`prefix(Mapping field, String value)` Creates a prefix query.
`ElasticConstraint`	`queryString(EntityDescriptor descriptor, String query, List<QueryField> fields)` Compiles the given query for the given entity while searching in the given fields.

Methods inherited from class sirius.db.mixing.query.constraints.FilterFactory
and, and, containsNone, containsOne, eq, eqIgnoreEmpty, eqOrEmpty, gt, gte, gteOrEmpty, gtOrEmpty, lt, lte, lteOrEmpty, ltOrEmpty, ne, noneInField, not, oneInField, or, or, queryString, transform

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ElasticFilterFactory
```
public ElasticFilterFactory()
```
- Method Detail
  - customTransform
```
protected Object customTransform(Object value)
```
    Description copied from class: FilterFactory
    
    Permits to provive database dependent transformations.
    
    Specified by:
    
    customTransform in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    value - the value to tranform
    
    Returns:
    
    the transformed value
  - eqValue
```
protected ElasticConstraint eqValue(Mapping field,
                                    Object value)
```
    Description copied from class: FilterFactory
    
    Represents field = value as constraint
    
    Specified by:
    
    eqValue in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    field - the field to filter
    
    value - the value to filter with
    
    Returns:
    
    the generated constraint
  - neValue
```
protected ElasticConstraint neValue(Mapping field,
                                    Object value)
```
    Description copied from class: FilterFactory
    
    Represents field != value as constraint
    
    Specified by:
    
    neValue in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    field - the field to filter
    
    value - the value to filter with
    
    Returns:
    
    the generated constraint
  - gtValue
```
protected ElasticConstraint gtValue(Mapping field,
                                    Object value,
                                    boolean orEqual)
```
    Description copied from class: FilterFactory
    
    Represents field > value as constraint
    
    Specified by:
    
    gtValue in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    field - the field to filter
    
    value - the value to filter with
    
    orEqual - if true, field >= value is used as comparator
    
    Returns:
    
    the generated constraint
  - ltValue
```
protected ElasticConstraint ltValue(Mapping field,
                                    Object value,
                                    boolean orEqual)
```
    Description copied from class: FilterFactory
    
    Represents field < value as constraint
    
    Specified by:
    
    ltValue in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    field - the field to filter
    
    value - the value to filter with
    
    orEqual - if true, field <= value is used as comparator
    
    Returns:
    
    the generated constraint
  - filled
```
public ElasticConstraint filled(Mapping field)
```
    Description copied from class: FilterFactory
    
    Generates a constraint which ensures that the given field is filled (not null)
    
    Specified by:
    
    filled in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    field - the field to check
    
    Returns:
    
    the generated constraint
  - notFilled
```
public ElasticConstraint notFilled(Mapping field)
```
    Description copied from class: FilterFactory
    
    Generates a constraint which ensures that the given field is not filled (null)
    
    Specified by:
    
    notFilled in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    field - the field to check
    
    Returns:
    
    the generated constraint
  - invert
```
protected ElasticConstraint invert(ElasticConstraint constraint)
```
    Description copied from class: FilterFactory
    
    Effectively inverts the given constraint
    
    Specified by:
    
    invert in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    constraint - the constraint to invert
    
    Returns:
    
    the inverted constraint
  - effectiveAnd
```
protected ElasticConstraint effectiveAnd(List<ElasticConstraint> effectiveConstraints)
```
    Description copied from class: FilterFactory
    
    Combines the list of constraints using AND
    
    Specified by:
    
    effectiveAnd in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    effectiveConstraints - the constraints to combine (where each value will be non-null)
    
    Returns:
    
    the combined constraint
  - effectiveOr
```
protected ElasticConstraint effectiveOr(List<ElasticConstraint> effectiveConstraints)
```
    Description copied from class: FilterFactory
    
    Combines the list of constraints using OR
    
    Specified by:
    
    effectiveOr in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    effectiveConstraints - the constraints to combine (where each value will be non-null)
    
    Returns:
    
    the combined constraint
  - containsAny
```
public sirius.db.es.constraints.ElasticCSVFilter containsAny(Mapping field,
                                                             sirius.kernel.commons.Value commaSeparatedValues)
```
    Description copied from class: FilterFactory
    
    Creates a new constraint for the given field which asserts that one of the given values in the string is present.
    The string can have a form like A,B,C or A|B|C.
    
    Overrides:
    
    containsAny in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    field - the field to check
    
    commaSeparatedValues - the comma separated values to check for
    
    Returns:
    
    a new constraint representing the given filter setting
  - containsAll
```
public sirius.db.es.constraints.ElasticCSVFilter containsAll(Mapping field,
                                                             sirius.kernel.commons.Value commaSeparatedValues)
```
    Description copied from class: FilterFactory
    
    Creates a new constraint for the given field which asserts that all of the given values in the string is present.
    The string can have a form like A,B,C or A|B|C.
    
    Overrides:
    
    containsAll in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    field - the field to check
    
    commaSeparatedValues - the comma separated values to check for
    
    Returns:
    
    a new constraint representing the given filter setting
  - queryString
```
public ElasticConstraint queryString(EntityDescriptor descriptor,
                                     String query,
                                     List<QueryField> fields)
```
    Description copied from class: FilterFactory
    
    Compiles the given query for the given entity while searching in the given fields.
    
    Specified by:
    
    queryString in class FilterFactory<ElasticConstraint>
    
    Parameters:
    
    descriptor - the descriptor of the entity being searched
    
    query - the query to compile
    
    fields - the default fields to search in
    
    Returns:
    
    a constraint representing the compiled query
  - nested
```
public NestedQuery nested(Mapping field)
```
    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
    
    Parameters:
    
    field - the list or inner map to query
    
    Returns:
    
    a nested query which can be populated with constraints
  - nestedMapContains
```
public ElasticConstraint nestedMapContains(Mapping mapField,
                                           String key,
                                           String value)
```
    Creates a filter which ensures, that a nested StringMap or StringListMap contains the given key and value.
    
    Parameters:
    
    mapField - the property which contains either a StringMap or StringListMap
    
    key - the key to check for
    
    value - the value to check for
    
    Returns:
    
    the filter
  - prefix
```
public ElasticConstraint prefix(Mapping field,
                                String value)
```
    Creates a prefix query.
    
    Parameters:
    
    field - the field to search in
    
    value - the prefix to filter by
    
    Returns:
    
    a new prefix query as constraint

Class ElasticFilterFactory

Constructor Summary

Method Summary

Methods inherited from class sirius.db.mixing.query.constraints.FilterFactory

Methods inherited from class java.lang.Object

Constructor Detail

ElasticFilterFactory

Method Detail

customTransform

eqValue

neValue

gtValue

ltValue

filled

notFilled

invert

effectiveAnd

effectiveOr

containsAny

containsAll

queryString

nested

nestedMapContains

prefix