MongoFilterFactory (SIRIUS db 5.0-rc9 API)

java.lang.Object
- sirius.db.mixing.query.constraints.FilterFactory<MongoConstraint>
- - sirius.db.mongo.constraints.MongoFilterFactory

```
public class MongoFilterFactory
extends FilterFactory<MongoConstraint>
```
Generates filters and constraints for MongoQuery.

See Also:

QueryBuilder.FILTERS

Constructor Summary

Constructors
Constructor and Description

MongoFilterFactory()

Constructors
Constructor and Description
`MongoFilterFactory()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected Object`	`customTransform(Object value)` Permits to provive database dependent transformations.
`protected MongoConstraint`	`effectiveAnd(List<MongoConstraint> effectiveConstraints)` Combines the list of constraints using `AND`
`protected MongoConstraint`	`effectiveOr(List<MongoConstraint> effectiveConstraints)` Combines the list of constraints using `OR`
`protected MongoConstraint`	`eqValue(Mapping field, Object value)` Represents `field = value` as constraint
`MongoConstraint`	`filled(Mapping field)` Generates a constraint which ensures that the given field is filled (not null)
`protected MongoConstraint`	`gtValue(Mapping field, Object value, boolean orEqual)` Represents `field > value` as constraint
`protected MongoConstraint`	`invert(MongoConstraint constraint)` Effectively inverts the given constraint
`protected MongoConstraint`	`ltValue(Mapping field, Object value, boolean orEqual)` Represents `field < value` as constraint
`MongoConstraint`	`nearSphere(Mapping key, org.bson.Document geometry, int maxDistanceMeters)` Builds a filter which represents a geospatial query.
`MongoConstraint`	`nearSphere(Mapping key, double lat, double lon, int maxDistanceMeters)` Builds a filter which represents a geospatial query for a point.
`protected MongoConstraint`	`neValue(Mapping field, Object value)` Represents `field !`
`MongoConstraint`	`noneInField(Mapping field, List<Object> values)` Creates a constraint which ensures that the given field doesn't contain any of the given values.
`MongoConstraint`	`notFilled(Mapping field)` Generates a constraint which ensures that the given field is not filled (null)
`OneInField<MongoConstraint>`	`oneInField(Mapping field, List<Object> values)` Creates a filter builder which ensures that the given field contains at least on of the given values.
`MongoConstraint`	`queryString(EntityDescriptor descriptor, String query, List<QueryField> fields)` Compiles the given query for the given entity while searching in the given fields.
`MongoConstraint`	`regex(Mapping key, Object expression, String options)` Builds a filter which represents a regex filter for the given field and expression.
`MongoConstraint`	`text(String value)` Executes a $text search in the underlying fulltext index.

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

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

- Constructor Detail
  - MongoFilterFactory
```
public MongoFilterFactory()
```
- 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<MongoConstraint>
    
    Parameters:
    
    value - the value to tranform
    
    Returns:
    
    the transformed value
  - eqValue
```
protected MongoConstraint eqValue(Mapping field,
                                  Object value)
```
    Description copied from class: FilterFactory
    
    Represents field = value as constraint
    
    Specified by:
    
    eqValue in class FilterFactory<MongoConstraint>
    
    Parameters:
    
    field - the field to filter
    
    value - the value to filter with
    
    Returns:
    
    the generated constraint
  - neValue
```
protected MongoConstraint neValue(Mapping field,
                                  Object value)
```
    Description copied from class: FilterFactory
    
    Represents field != value as constraint
    
    Specified by:
    
    neValue in class FilterFactory<MongoConstraint>
    
    Parameters:
    
    field - the field to filter
    
    value - the value to filter with
    
    Returns:
    
    the generated constraint
  - gtValue
```
protected MongoConstraint gtValue(Mapping field,
                                  Object value,
                                  boolean orEqual)
```
    Description copied from class: FilterFactory
    
    Represents field > value as constraint
    
    Specified by:
    
    gtValue in class FilterFactory<MongoConstraint>
    
    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 MongoConstraint ltValue(Mapping field,
                                  Object value,
                                  boolean orEqual)
```
    Description copied from class: FilterFactory
    
    Represents field < value as constraint
    
    Specified by:
    
    ltValue in class FilterFactory<MongoConstraint>
    
    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 MongoConstraint 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<MongoConstraint>
    
    Parameters:
    
    field - the field to check
    
    Returns:
    
    the generated constraint
  - notFilled
```
public MongoConstraint 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<MongoConstraint>
    
    Parameters:
    
    field - the field to check
    
    Returns:
    
    the generated constraint
  - invert
```
protected MongoConstraint invert(MongoConstraint constraint)
```
    Description copied from class: FilterFactory
    
    Effectively inverts the given constraint
    
    Specified by:
    
    invert in class FilterFactory<MongoConstraint>
    
    Parameters:
    
    constraint - the constraint to invert
    
    Returns:
    
    the inverted constraint
  - effectiveAnd
```
protected MongoConstraint effectiveAnd(List<MongoConstraint> effectiveConstraints)
```
    Description copied from class: FilterFactory
    
    Combines the list of constraints using AND
    
    Specified by:
    
    effectiveAnd in class FilterFactory<MongoConstraint>
    
    Parameters:
    
    effectiveConstraints - the constraints to combine (where each value will be non-null)
    
    Returns:
    
    the combined constraint
  - effectiveOr
```
protected MongoConstraint effectiveOr(List<MongoConstraint> effectiveConstraints)
```
    Description copied from class: FilterFactory
    
    Combines the list of constraints using OR
    
    Specified by:
    
    effectiveOr in class FilterFactory<MongoConstraint>
    
    Parameters:
    
    effectiveConstraints - the constraints to combine (where each value will be non-null)
    
    Returns:
    
    the combined constraint
  - oneInField
```
public OneInField<MongoConstraint> oneInField(Mapping field,
                                              List<Object> values)
```
    Description copied from class: FilterFactory
    
    Creates a filter builder which ensures that the given field contains at least on of the given values.
    
    Overrides:
    
    oneInField in class FilterFactory<MongoConstraint>
    
    Parameters:
    
    field - the field to filter on
    
    values - the values to check
    
    Returns:
    
    a filter builder used to generate a constraint
  - noneInField
```
public MongoConstraint noneInField(Mapping field,
                                   List<Object> values)
```
    Description copied from class: FilterFactory
    
    Creates a constraint which ensures that the given field doesn't contain any of the given values.
    
    Overrides:
    
    noneInField in class FilterFactory<MongoConstraint>
    
    Parameters:
    
    field - the field to filter on
    
    values - the values to check
    
    Returns:
    
    the generated constraint
  - queryString
```
public MongoConstraint 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<MongoConstraint>
    
    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
  - regex
```
public MongoConstraint regex(Mapping key,
                             Object expression,
                             String options)
```
    Builds a filter which represents a regex filter for the given field and expression.
    
    Parameters:
    
    key - the name of the field to check
    
    expression - the regular expression to apply
    
    options - the options to apply like "i" to match case insensitive
    
    Returns:
    
    a filter representing the given operation
  - nearSphere
```
public MongoConstraint nearSphere(Mapping key,
                                  org.bson.Document geometry,
                                  int maxDistanceMeters)
```
    Builds a filter which represents a geospatial query.
    
    Parameters:
    
    key - the name of the field to check
    
    geometry - the geometry used to filter by
    
    maxDistanceMeters - the max distance to consider relevant
    
    Returns:
    
    a filter representing the given operation
  - nearSphere
```
public MongoConstraint nearSphere(Mapping key,
                                  double lat,
                                  double lon,
                                  int maxDistanceMeters)
```
    Builds a filter which represents a geospatial query for a point.
    
    Parameters:
    
    key - the name of the field to check
    
    lat - the latitude of the point used as search geometry.
    
    lon - the longitude of the point used as search geometry.
    
    maxDistanceMeters - the max distance to consider relevant
    
    Returns:
    
    a filter representing the given operation
  - text
```
public MongoConstraint text(String value)
```
    Executes a $text search in the underlying fulltext index.
    
    Parameters:
    
    value - the token to search for
    
    Returns:
    
    a filter representing the $text constraint

Class MongoFilterFactory

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Constructor Detail

MongoFilterFactory

Method Detail

customTransform

eqValue

neValue

gtValue

ltValue

filled

notFilled

invert

effectiveAnd

effectiveOr

oneInField

noneInField

queryString

regex

nearSphere

nearSphere

text