Package ubic.gemma.persistence.util

Class Filter

java.lang.Object

ubic.gemma.persistence.util.Filter

All Implemented Interfaces:

PropertyMapping

public final class Filter
extends Object
implements PropertyMapping

Holds the necessary information to filter an entity with a property, operator and right-hand side value.

Author:

tesarst, poirigui

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	Filter.Operator

Method Summary

Modifier and Type	Method	Description
static <T> Filter	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Collection<T> requiredValues)	Create a new filter without an original property and a collection right hand side.
static <T> Filter	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Collection<T> requiredValues, String originalProperty)	Create a new filter with a collection right hand side.
static <T> Filter	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, T requiredValue)	Create a new filter without an original property.
static <T> Filter	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, T requiredValue, String originalProperty)	Create a new filter.
static <T> Filter	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Subquery requiredValues)
static <T> Filter	by(String objectAlias, String propertyName, Class<T> propertyType, Filter.Operator operator, Subquery requiredValues, String originalProperty)	Create a new filter with a subquery right hand side.
boolean	equals(Object o)
static org.springframework.core.convert.ConversionService	getConversionService()	Obtain the conversion service used for parsing values.
String	getObjectAlias()	Alias in the query/criteria space, if applicable.
Filter.Operator	getOperator()
String	getOriginalProperty()	The origin, if known.
String	getPropertyName()	Property name in the query/criteria space.
Class<?>	getPropertyType()
Object	getRequiredValue()
int	hashCode()
boolean	isNegative(Filter f)	Check if a filter is negative.
static Filter	not(Filter f)	Negate the given filter.
static Filter	parse(String objectAlias, String propertyName, Class<?> propertyType, Filter.Operator operator, String requiredValue)
static Filter	parse(String objectAlias, String propertyName, Class<?> propertyType, Filter.Operator operator, String requiredValue, String originalProperty)	Parse filter where the right-hand side is a scalar.
static Filter	parse(String objectAlias, String propertyName, Class<?> propertyType, Filter.Operator operator, Collection<String> requiredValues)
static Filter	parse(String objectAlias, String propertyName, Class<?> propertyType, Filter.Operator operator, Collection<String> requiredValues, String originalProperty)	Parse a filter where the right-hand side is a Collection of scalar right-hand side to be parsed.
String	toOriginalString()	Render this with its original property.
String	toString()	Render this with its PropertyMapping.getObjectAlias() and PropertyMapping.getPropertyName().
Filter	withPropertyName(String newPropertyName, String newOriginalProperty)	Create a copy of this filter with a new property name and original property.

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Details

getConversionService

public static org.springframework.core.convert.ConversionService getConversionService()

Obtain the conversion service used for parsing values.

by

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

Create a new filter.

If you need to parse the right-hand side, consider using parse(String, String, Class, Operator, String, String) for a scalar or parse(String, String, Class, Operator, Collection, String) for a collection type.

Parameters:

objectAlias - the alias that refers to the entity subject to the filter

propertyName - the property in the entity

propertyType - the type of the property

operator - a valid operator for the property and the requiredValue

requiredValue - a required value, or null to perform a null-check (i.e. objectAlias.propertyName is null)

originalProperty - the original property name, or null if not applicable

Throws:

IllegalArgumentException - if the type of the requiredValue does not match the propertyType

by

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

Create a new filter with a collection right hand side.

by

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

Create a new filter with a subquery right hand side.

by

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

Create a new filter without an original property.

See Also:

• by(String, String, Class, Operator, Object, String)

by

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

Create a new filter without an original property and a collection right hand side.

See Also:

• by(String, String, Class, Operator, Object, String)

by

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

parse

public static Filter parse(@Nullable
 String objectAlias,
 String propertyName,
 Class<?> propertyType,
 Filter.Operator operator,
 String requiredValue,
 String originalProperty)
                    throws IllegalArgumentException

Parse filter where the right-hand side is a scalar.

Parameters:

requiredValue - a right-hand side to be parsed according to the propertyType and operator

Throws:

IllegalArgumentException - if the right-hand side cannot be parsed, which is generally caused by a ConversionException when attempting to convert the requiredValue to the desired propertyType.

See Also:

• Filter(String, String, Class, Operator, Object, String)

parse

public static Filter parse(@Nullable
 String objectAlias,
 String propertyName,
 Class<?> propertyType,
 Filter.Operator operator,
 String requiredValue)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

parse

public static Filter parse(@Nullable
 String objectAlias,
 String propertyName,
 Class<?> propertyType,
 Filter.Operator operator,
 Collection<String> requiredValues,
 String originalProperty)
                    throws IllegalArgumentException

Parse a filter where the right-hand side is a Collection of scalar right-hand side to be parsed.

If you need to parse a collection held in a String (i.e. "(1,2,3,4)"), you should use parse(String, String, Class, Operator, String, String) instead.

Parameters:

requiredValues - a collection of right-hand side to be parsed

Throws:

IllegalArgumentException - if the right-hand side cannot be parsed, which is generally caused by a ConversionException when attempting to convert the requiredValue to the desired propertyType.

See Also:

• Filter(String, String, Class, Operator, Object, String)

parse

public static Filter parse(@Nullable
 String objectAlias,
 String propertyName,
 Class<?> propertyType,
 Filter.Operator operator,
 Collection<String> requiredValues)
                    throws IllegalArgumentException

Throws:

IllegalArgumentException

not

public static Filter not(Filter f)

Negate the given filter.

If the required value is a subquery, the subquery itself is negated.

withPropertyName

public Filter withPropertyName(String newPropertyName,
 @Nullable
 String newOriginalProperty)

Create a copy of this filter with a new property name and original property.

If the filter's right hand side is a Subquery, the operation is propagated to the subquery via invalid input: '{@link /*missing*/}'

This can be used to apply this filter to a different property. For example, if you have a filter on a Statement over object, you could create a filter over a secondObject.

Throws:

IllegalArgumentException - if the type of the resulting property is not compatible with the required value

See Also:

• Subquery.withFilterPropertyName(String, String)

toString

public String toString()

Description copied from interface: PropertyMapping

Render this with its PropertyMapping.getObjectAlias() and PropertyMapping.getPropertyName().

Specified by:

toString in interface PropertyMapping

Overrides:

toString in class Object

toOriginalString

public String toOriginalString()

Description copied from interface: PropertyMapping

Render this with its original property.

If no original property are attached to this mapping, this method should return the same as PropertyMapping.toString().

Specified by:

toOriginalString in interface PropertyMapping

isNegative

public boolean isNegative(Filter f)

Check if a filter is negative.

getObjectAlias

@Nullable
public String getObjectAlias()

Description copied from interface: PropertyMapping

Alias in the query/criteria space, if applicable.

Null implies a reference to the root alias.

Specified by:

getObjectAlias in interface PropertyMapping

getPropertyName

public String getPropertyName()

Description copied from interface: PropertyMapping

Property name in the query/criteria space.

Specified by:

getPropertyName in interface PropertyMapping

getPropertyType

public Class<?> getPropertyType()

getOperator

public Filter.Operator getOperator()

getRequiredValue

@Nullable
public Object getRequiredValue()

getOriginalProperty

@Nullable
public String getOriginalProperty()

The origin, if known.

Specified by:

getOriginalProperty in interface PropertyMapping

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object