Package ubic.gemma.persistence.util

Class Filters

java.lang.Object

ubic.gemma.persistence.util.Filters

All Implemented Interfaces:

Iterable<List<Filter>>

public class Filters
extends Object
implements Iterable<List<Filter>>

Represents a conjunction of disjunctions of Filter.

Author:

poirigui

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
class	Filters.FiltersClauseBuilder	Builder for a disjunctive sub-clause.

Method Summary

Modifier and Type	Method	Description
Filters.FiltersClauseBuilder	and()	Start a new clause.
<T> Filters	and(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Collection<T> requiredValues)	Add a new clause of one explicit clause with a collection right hand side to to the conjunction.
<T> Filters	and(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Collection<T> requiredValues, String originalProperty)
<T> Filters	and(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, T requiredValue)	Add a clause of one explicit clause to the conjunction.
<T> Filters	and(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, T requiredValue, String originalProperty)
<T> Filters	and(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Subquery requiredValues)
<T> Filters	and(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Subquery requiredValues, String originalProperty)
Filters	and(Filter... filters)	Add a clause of one or more Filter sub-clauses to the conjunction.
Filters	and(Filters filters)	Add all the clauses of another filter to this.
static <T> Filters	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Collection<T> requiredValue)
static <T> Filters	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Collection<T> requiredValue, String originalProperty)
static <T> Filters	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, T requiredValue)	Create a singleton Filters from an explicit clause.
static <T> Filters	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, T requiredValue, String originalProperty)
static <T> Filters	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Subquery requiredValue)
static <T> Filters	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Subquery requiredValue, String originalProperty)
static Filters	by(Filter... subClauses)	Create a singleton Filters from a Filter.
static Filters	by(Filters filters)	Copy constructor.
static Filters	empty()	Create an empty filter.
boolean	isEmpty()	Check if this contains an empty conjunction, or if all its clauses are empty.
Iterator<List<Filter>>	iterator()	Obtain an iterator over the clauses contained in this conjunction.
String	toOriginalString()
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Detail

empty

public static Filters empty()

Create an empty filter.

by

public static Filters by(Filter... subClauses)

Create a singleton Filters from a Filter.

Parameters:

subClauses - an array of sub-clause to create the Filters with

Returns:

a Filters with the given filter as only clause

by

public static <T> Filters by(@Nullable
                             String objectAlias,
                             String propertyName,
                             Class<T> propertyType,
                             Filter.Operator operator,
                             @Nullable
                             T requiredValue)

Create a singleton Filters from an explicit clause.

by

public static <T> Filters by(@Nullable
                             String objectAlias,
                             String propertyName,
                             Class<T> propertyType,
                             Filter.Operator operator,
                             @Nullable
                             T requiredValue,
                             String originalProperty)

by

public static <T> Filters by(@Nullable
                             String objectAlias,
                             String propertyName,
                             Class<T> propertyType,
                             Filter.Operator operator,
                             Collection<T> requiredValue)

by

public static <T> Filters by(@Nullable
                             String objectAlias,
                             String propertyName,
                             Class<T> propertyType,
                             Filter.Operator operator,
                             Collection<T> requiredValue,
                             String originalProperty)

by

public static <T> Filters by(@Nullable
                             String objectAlias,
                             String propertyName,
                             Class<T> propertyType,
                             Filter.Operator operator,
                             Subquery requiredValue)

by

public static <T> Filters by(@Nullable
                             String objectAlias,
                             String propertyName,
                             Class<T> propertyType,
                             Filter.Operator operator,
                             Subquery requiredValue,
                             String originalProperty)

by

public static Filters by(Filters filters)

Copy constructor.

and

public Filters.FiltersClauseBuilder and()

Start a new clause.

and

public Filters and(Filter... filters)

Add a clause of one or more Filter sub-clauses to the conjunction.

and

public <T> Filters and(@Nullable
                       String objectAlias,
                       String propertyName,
                       Class<T> propertyType,
                       Filter.Operator operator,
                       @Nullable
                       T requiredValue)

Add a clause of one explicit clause to the conjunction.

and

public <T> Filters and(@Nullable
                       String objectAlias,
                       String propertyName,
                       Class<T> propertyType,
                       Filter.Operator operator,
                       @Nullable
                       T requiredValue,
                       String originalProperty)

and

public <T> Filters and(@Nullable
                       String objectAlias,
                       String propertyName,
                       Class<T> propertyType,
                       Filter.Operator operator,
                       Collection<T> requiredValues)

Add a new clause of one explicit clause with a collection right hand side to to the conjunction.

and

public <T> Filters and(@Nullable
                       String objectAlias,
                       String propertyName,
                       Class<T> propertyType,
                       Filter.Operator operator,
                       Collection<T> requiredValues,
                       String originalProperty)

and

public <T> Filters and(@Nullable
                       String objectAlias,
                       String propertyName,
                       Class<T> propertyType,
                       Filter.Operator operator,
                       Subquery requiredValues)

and

public <T> Filters and(@Nullable
                       String objectAlias,
                       String propertyName,
                       Class<T> propertyType,
                       Filter.Operator operator,
                       Subquery requiredValues,
                       String originalProperty)

and

public Filters and(Filters filters)

Add all the clauses of another filter to this.

isEmpty

public boolean isEmpty()

Check if this contains an empty conjunction, or if all its clauses are empty.

An empty Filters has no effect whatsoever on the result of a query.

iterator

public Iterator<List<Filter>> iterator()

Obtain an iterator over the clauses contained in this conjunction.

Specified by:

iterator in interface Iterable<List<Filter>>

toString

public String toString()

Overrides:

toString in class Object

toOriginalString

public String toOriginalString()