Filter.Builder

Enclosing class:

Filter
```
public static interface Filter.Builder
```
Enables to define and combine filtering criteria. Once all criteria have been defined, a Filter instance can be obtained using the build() method.

See Also:

Filter.builder()

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`Filter`	`build()` Creates a `Filter` instance which uses all filtering criteria assigned to this builder.
`Filter.Builder`	`contains(String attributeName, String value, boolean caseSensitive)` Retains objects whose textual attribute contains the specified fragment.
`Filter.Builder`	`empty(String attributeName)` Retains objects having an non-empty value for the specified attribute name.
`Filter.Builder`	`equalTo(String attributeName, boolean value)` Retains objects whose boolean attribute equals the specified value.
`Filter.Builder`	`equalTo(String attributeName, Date value)` Retains objects whose date attribute equals the specified value.
`Filter.Builder`	`equalTo(String attributeName, float value)` Retains objects whose real attribute equals the specified value.
`Filter.Builder`	`equalTo(String attributeName, int value)` Retains objects whose integer attribute equals the specified value.
`Filter.Builder`	`equalTo(String attributeName, String value)` Retains objects whose textual attribute equals the specified value.
`Filter.Builder`	`excludes(String attributeName, String value)` Retains objects whose multi-valued attribute does not contain the specified value.
`Filter.Builder`	`greaterThan(String attributeName, Date value)` Retains objects whose date attribute is strictly higher than the specified value.
`Filter.Builder`	`greaterThan(String attributeName, float value)` Retains objects whose real attribute is strictly higher than the specified value.
`Filter.Builder`	`greaterThan(String attributeName, int value)` Retains objects whose integer attribute is strictly higher than the specified value.
`Filter.Builder`	`greaterThan(String attributeName, String value)` Retains objects whose textual attribute is strictly higher than the specified value.
`Filter.Builder`	`greaterThanOrEqualTo(String attributeName, Date value)` Retains objects whose date attribute is higher or equal to the specified value.
`Filter.Builder`	`greaterThanOrEqualTo(String attributeName, float value)` Retains objects whose real attribute is higher or equal to the specified value.
`Filter.Builder`	`greaterThanOrEqualTo(String attributeName, int value)` Retains objects whose integer attribute is higher or equal to the specified value.
`Filter.Builder`	`greaterThanOrEqualTo(String attributeName, String value)` Retains objects whose textual attribute is higher or equal to the specified value.
`Filter.Builder`	`includes(String attributeName, String value)` Retains objects whose multi-valued attribute contains the specified value.
`Filter.Builder`	`lessThan(String attributeName, Date value)` Retains objects whose date attribute is strictly lower than the specified value.
`Filter.Builder`	`lessThan(String attributeName, float value)` Retains objects whose real attribute is strictly lower than the specified value.
`Filter.Builder`	`lessThan(String attributeName, int value)` Retains objects whose integer attribute is strictly lower than the specified value.
`Filter.Builder`	`lessThan(String attributeName, String value)` Retains objects whose textual attribute is strictly lower than the specified value.
`Filter.Builder`	`lessThanOrEqualTo(String attributeName, Date value)` Retains objects whose date attribute is lower or equal to the specified value.
`Filter.Builder`	`lessThanOrEqualTo(String attributeName, float value)` Retains objects whose real attribute is lower or equal to the specified value.
`Filter.Builder`	`lessThanOrEqualTo(String attributeName, int value)` Retains objects whose integer attribute is lower or equal to the specified value.
`Filter.Builder`	`lessThanOrEqualTo(String attributeName, String value)` Retains objects whose textual attribute is lower or equal to the specified value.
`Filter.Builder`	`modifiedAfter(Date date)` Retains objects modified after the specified date.
`Filter.Builder`	`notEmpty(String attributeName)` Retains objects whose specified attribute is not set.
`Filter.Builder`	`notEqualTo(String attributeName, boolean value)` Retains objects whose boolean attribute is not equal to the specified value.
`Filter.Builder`	`notEqualTo(String attributeName, Date value)` Retains objects whose date attribute is not equal to the specified value.
`Filter.Builder`	`notEqualTo(String attributeName, float value)` Retains objects whose real attribute is not equal to the specified value.
`Filter.Builder`	`notEqualTo(String attributeName, int value)` Retains objects whose integer attribute is not equal to the specified value.
`Filter.Builder`	`notEqualTo(String attributeName, String value)` Retains objects whose textual attribute is not equal to the specified value.

- Method Detail
  - modifiedAfter
```
Filter.Builder modifiedAfter(Date date)
```
    Retains objects modified after the specified date. Time information is used for date comparison.
    
    Parameters:
    
    date - the minimal modification date an object must have to be accepted by the filter.
    
    Returns:
    
    the same builder instance.
  - empty
```
Filter.Builder empty(String attributeName)
```
    Retains objects having an non-empty value for the specified attribute name.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    Returns:
    
    the same builder instance.
  - notEmpty
```
Filter.Builder notEmpty(String attributeName)
```
    Retains objects whose specified attribute is not set.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    Returns:
    
    the same builder instance.
  - equalTo
```
Filter.Builder equalTo(String attributeName,
                       boolean value)
```
    Retains objects whose boolean attribute equals the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - equalTo
```
Filter.Builder equalTo(String attributeName,
                       Date value)
```
    Retains objects whose date attribute equals the specified value. Time information is used for date comparison.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - equalTo
```
Filter.Builder equalTo(String attributeName,
                       float value)
```
    Retains objects whose real attribute equals the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - equalTo
```
Filter.Builder equalTo(String attributeName,
                       int value)
```
    Retains objects whose integer attribute equals the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - equalTo
```
Filter.Builder equalTo(String attributeName,
                       String value)
```
    Retains objects whose textual attribute equals the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - notEqualTo
```
Filter.Builder notEqualTo(String attributeName,
                          boolean value)
```
    Retains objects whose boolean attribute is not equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - notEqualTo
```
Filter.Builder notEqualTo(String attributeName,
                          Date value)
```
    Retains objects whose date attribute is not equal to the specified value. Time information is used for date comparison.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - notEqualTo
```
Filter.Builder notEqualTo(String attributeName,
                          float value)
```
    Retains objects whose real attribute is not equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - notEqualTo
```
Filter.Builder notEqualTo(String attributeName,
                          int value)
```
    Retains objects whose integer attribute is not equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - notEqualTo
```
Filter.Builder notEqualTo(String attributeName,
                          String value)
```
    Retains objects whose textual attribute is not equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - lessThan
```
Filter.Builder lessThan(String attributeName,
                        float value)
```
    Retains objects whose real attribute is strictly lower than the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - lessThan
```
Filter.Builder lessThan(String attributeName,
                        Date value)
```
    Retains objects whose date attribute is strictly lower than the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - lessThan
```
Filter.Builder lessThan(String attributeName,
                        int value)
```
    Retains objects whose integer attribute is strictly lower than the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - lessThan
```
Filter.Builder lessThan(String attributeName,
                        String value)
```
    Retains objects whose textual attribute is strictly lower than the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - lessThanOrEqualTo
```
Filter.Builder lessThanOrEqualTo(String attributeName,
                                 float value)
```
    Retains objects whose real attribute is lower or equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - lessThanOrEqualTo
```
Filter.Builder lessThanOrEqualTo(String attributeName,
                                 Date value)
```
    Retains objects whose date attribute is lower or equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - lessThanOrEqualTo
```
Filter.Builder lessThanOrEqualTo(String attributeName,
                                 int value)
```
    Retains objects whose integer attribute is lower or equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - lessThanOrEqualTo
```
Filter.Builder lessThanOrEqualTo(String attributeName,
                                 String value)
```
    Retains objects whose textual attribute is lower or equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - greaterThan
```
Filter.Builder greaterThan(String attributeName,
                           float value)
```
    Retains objects whose real attribute is strictly higher than the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - greaterThan
```
Filter.Builder greaterThan(String attributeName,
                           Date value)
```
    Retains objects whose date attribute is strictly higher than the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - greaterThan
```
Filter.Builder greaterThan(String attributeName,
                           int value)
```
    Retains objects whose integer attribute is strictly higher than the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - greaterThan
```
Filter.Builder greaterThan(String attributeName,
                           String value)
```
    Retains objects whose textual attribute is strictly higher than the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - greaterThanOrEqualTo
```
Filter.Builder greaterThanOrEqualTo(String attributeName,
                                    float value)
```
    Retains objects whose real attribute is higher or equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - greaterThanOrEqualTo
```
Filter.Builder greaterThanOrEqualTo(String attributeName,
                                    Date value)
```
    Retains objects whose date attribute is higher or equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - greaterThanOrEqualTo
```
Filter.Builder greaterThanOrEqualTo(String attributeName,
                                    int value)
```
    Retains objects whose integer attribute is higher or equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - greaterThanOrEqualTo
```
Filter.Builder greaterThanOrEqualTo(String attributeName,
                                    String value)
```
    Retains objects whose textual attribute is higher or equal to the specified value.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the value compared to each object attribute.
    
    Returns:
    
    the same builder instance.
  - contains
```
Filter.Builder contains(String attributeName,
                        String value,
                        boolean caseSensitive)
```
    Retains objects whose textual attribute contains the specified fragment.
    
    Parameters:
    
    attributeName - the name of the attribute.
    
    value - the fragment to look for in the attribute text value.
    
    caseSensitive - true if the comparison is case sensitive, false otherwise.
    
    Returns:
    
    the same builder instance.
  - includes
```
Filter.Builder includes(String attributeName,
                        String value)
```
    Retains objects whose multi-valued attribute contains the specified value.
    
    Parameters:
    
    attributeName - the name of the multi-valued attribute.
    
    value - the value to look for in the attribute values.
    
    Returns:
    
    the same builder instance.
  - excludes
```
Filter.Builder excludes(String attributeName,
                        String value)
```
    Retains objects whose multi-valued attribute does not contain the specified value.
    
    Parameters:
    
    attributeName - the name of the multi-valued attribute.
    
    value - the value to look for in the attribute values.
    
    Returns:
    
    the same builder instance.
  - build
```
Filter build()
```
    Creates a Filter instance which uses all filtering criteria assigned to this builder. The created filter can then be assigned to an ItemScope.
    
    Returns:
    
    a new Filter instance.
    
    See Also:
    
    ItemScope.setFilter(Filter)

Interface Filter.Builder

Method Summary

Method Detail

modifiedAfter

empty

notEmpty

equalTo

equalTo

equalTo

equalTo

equalTo

notEqualTo

notEqualTo

notEqualTo

notEqualTo

notEqualTo

lessThan

lessThan

lessThan

lessThan

lessThanOrEqualTo

lessThanOrEqualTo

lessThanOrEqualTo

lessThanOrEqualTo

greaterThan

greaterThan

greaterThan

greaterThan

greaterThanOrEqualTo

greaterThanOrEqualTo

greaterThanOrEqualTo

greaterThanOrEqualTo

contains

includes

excludes

build