Class AbstractFilteringVoEnabledDao<O extends Identifiable, VO extends IdentifiableValueObject<O>>

java.lang.Object

ubic.gemma.persistence.service.AbstractDao<O>

ubic.gemma.persistence.service.AbstractVoEnabledDao<O,VO>

ubic.gemma.persistence.service.AbstractFilteringVoEnabledDao<O,VO>

Type Parameters:

O - the entity type

VO - the corresponding VO type

All Implemented Interfaces:

org.springframework.beans.factory.InitializingBean, BaseDao<O>, BaseVoEnabledDao<O,VO>, FilteringDao<O>, FilteringVoEnabledDao<O,VO>

Direct Known Subclasses:

AbstractCriteriaFilteringVoEnabledDao, AbstractQueryFilteringVoEnabledDao

public abstract class AbstractFilteringVoEnabledDao<O extends Identifiable, VO extends IdentifiableValueObject<O>>
extends AbstractVoEnabledDao<O,VO>
implements FilteringVoEnabledDao<O,VO>, org.springframework.beans.factory.InitializingBean

Base implementation for FilteringVoEnabledDao.

Author:

poirigui

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected class	AbstractFilteringVoEnabledDao.FilterablePropertiesConfigurer	Configurer for filterable properties and their aliases.
protected static final class	AbstractFilteringVoEnabledDao.FilterablePropertyMeta	Meta-information for a filterable property.

Nested classes/interfaces inherited from interface FilteringDao

FilteringDao.ConjunctSpec

Field Summary

Fields inherited from class AbstractVoEnabledDao

REPORT_SLOW_QUERY_AFTER_MS

Fields inherited from class AbstractDao

log

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractFilteringVoEnabledDao(String objectAlias, Class<? extends O> elementClass, SessionFactory sessionFactory)

Method Summary

Modifier and Type	Method	Description
void	afterPropertiesSet()
protected void	configureFilterableProperties(AbstractFilteringVoEnabledDao<O,VO>.FilterablePropertiesConfigurer configurer)	Register filterable properties.
final <T> Filter	getFilter(String property, Class<T> propertyType, Filter.Operator operator, Collection<T> values)	Obtain a Filter with an already parsed collection of values.
final <T> Filter	getFilter(String property, Class<T> propertyType, Filter.Operator operator, T value)	Obtain a Filter with an already parsed value.
final Filter	getFilter(String property, Filter.Operator operator, String value)	Obtain an Filter for the entity this DAO is providing.
final Filter	getFilter(String property, Filter.Operator operator, String value, SubqueryMode subqueryMode)
final Filter	getFilter(String property, Filter.Operator operator, Collection<String> values)	Similar to FilteringDao.getFilter(String, Filter.Operator, String), but with a collection of values.
final Filter	getFilter(String property, Filter.Operator operator, Collection<String> values, SubqueryMode subqueryMode)
final Filter	getFilter(List<FilteringDao.ConjunctSpec> conjuncts, SubqueryMode subqueryMode)	Build a filter requiring a SINGLE element of a to-many relation to satisfy EVERY given predicate.
final Set<String>	getFilterableProperties()	List all properties availble for filtering.
List<Object>	getFilterablePropertyAllowedValues(String propertyName)	Obtain a short list of allowed values for the given property, or null if unrestricted.
String	getFilterablePropertyDescription(String propertyName)	Obtain a short description for a given filterable property.
protected final AbstractFilteringVoEnabledDao.FilterablePropertyMeta	getFilterablePropertyMeta(String propertyName)
protected final Map<String,String>	getFilterablePropertyObjectAliases()	Expose registered object-alias mappings to subclasses (e.g.
Class<?>	getFilterablePropertyType(String propertyName)	Obtain the type of the given filterable property.
protected final String	getObjectAlias()
final Sort	getSort(String property, Sort.Direction direction, Sort.NullMode nullMode)	Obtain a Sort object for a property of the O.
boolean	isFilterablePropertyDeprecated(String property)	Indicate if the given property is deprecated.
boolean	isFilterablePropertyUsingSubquery(String property)	Indicate if the given property is using a subquery for filtering.
protected AbstractFilteringVoEnabledDao.FilterablePropertyMeta.FilterablePropertyMetaBuilder	resolveFilterablePropertyMeta(String propertyName)	Obtain various meta-information used to infer what to use in a Filter or Sort.
protected AbstractFilteringVoEnabledDao.FilterablePropertyMeta.FilterablePropertyMetaBuilder	resolveFilterablePropertyMeta(String objectAlias, Class<? extends Identifiable> clazz, String propertyName)

Methods inherited from class AbstractVoEnabledDao

doLoadValueObject, doLoadValueObjects, loadAllValueObjects, loadValueObject, loadValueObjectById, loadValueObjects, loadValueObjectsByIds, postProcessValueObjects

Methods inherited from class AbstractDao

countAll, create, create, find, findByProperty, findByPropertyIn, findIdByProperty, findOneByProperty, findOrCreate, getBatchSize, getElementClass, getEntityName, getIdentifierPropertyName, getSessionFactory, load, load, loadAll, loadReference, loadReference, reload, reload, remove, remove, save, save, streamAll, streamAll, streamQuery, update, update

Methods inherited from class Object

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

Methods inherited from interface BaseDao

countAll, create, create, find, findOrCreate, getElementClass, load, load, loadAll, loadReference, loadReference, reload, reload, remove, remove, save, save, streamAll, streamAll, update, update

Methods inherited from interface BaseVoEnabledDao

loadAllValueObjects, loadValueObject, loadValueObjectById, loadValueObjects, loadValueObjectsByIds

Methods inherited from interface FilteringDao

count, load, load, loadIds

Methods inherited from interface FilteringVoEnabledDao

loadValueObjects, loadValueObjects, loadValueObjectsByCursor

Constructor Details

AbstractFilteringVoEnabledDao

protected AbstractFilteringVoEnabledDao(@Nullable
 String objectAlias,
 Class<? extends O> elementClass,
 SessionFactory sessionFactory)

Method Details

getFilterablePropertyObjectAliases

protected final Map<String,String> getFilterablePropertyObjectAliases()

Expose registered object-alias mappings to subclasses (e.g. the JPA Criteria DAO) so they can wire alias-prefixed filter/sort paths back to explicit joins on the root.

Returns a map of objectAlias → dotted prefix (without the trailing "."). Aliases registered with a null objectAlias are skipped.

getObjectAlias

@Nullable
protected final String getObjectAlias()

Returns:

the HQL object alias used to refer to the root entity in this DAO's queries (e.g. ee for ExpressionExperiment), or null when the DAO operates on the implicit root.

afterPropertiesSet

@OverridingMethodsMustInvokeSuper
public void afterPropertiesSet()

Specified by:

afterPropertiesSet in interface org.springframework.beans.factory.InitializingBean

getFilterableProperties

public final Set<String> getFilterableProperties()

Description copied from interface: FilteringDao

List all properties availble for filtering.

Specified by:

getFilterableProperties in interface FilteringDao<O extends Identifiable>

configureFilterableProperties

@OverridingMethodsMustInvokeSuper
protected void configureFilterableProperties(AbstractFilteringVoEnabledDao<O,VO>.FilterablePropertiesConfigurer configurer)

Register filterable properties.

getFilterablePropertyType

public Class<?> getFilterablePropertyType(String propertyName)
                                   throws IllegalArgumentException

Description copied from interface: FilteringDao

Obtain the type of the given filterable property.

Specified by:

getFilterablePropertyType in interface FilteringDao<O extends Identifiable>

Throws:

IllegalArgumentException - if no such property exists, the cause will be a NoSuchFieldException

getFilterablePropertyDescription

@Nullable
public String getFilterablePropertyDescription(String propertyName)
                                        throws IllegalArgumentException

Description copied from interface: FilteringDao

Obtain a short description for a given filterable property.

Specified by:

getFilterablePropertyDescription in interface FilteringDao<O extends Identifiable>

Throws:

IllegalArgumentException - if no such property exists

getFilterablePropertyAllowedValues

@Nullable
public List<Object> getFilterablePropertyAllowedValues(String propertyName)
                                                throws IllegalArgumentException

Description copied from interface: FilteringDao

Obtain a short list of allowed values for the given property, or null if unrestricted.

The returned values must be of the type outlined by FilteringDao.getFilterablePropertyType(String), generally a list of String or Integer to denote possible values for an enumerated type.

Specified by:

getFilterablePropertyAllowedValues in interface FilteringDao<O extends Identifiable>

Throws:

IllegalArgumentException

isFilterablePropertyUsingSubquery

public boolean isFilterablePropertyUsingSubquery(String property)
                                          throws IllegalArgumentException

Description copied from interface: FilteringDao

Indicate if the given property is using a subquery for filtering.

Specified by:

isFilterablePropertyUsingSubquery in interface FilteringDao<O extends Identifiable>

Throws:

IllegalArgumentException - if the property does not exist

isFilterablePropertyDeprecated

public boolean isFilterablePropertyDeprecated(String property)
                                       throws IllegalArgumentException

Description copied from interface: FilteringDao

Indicate if the given property is deprecated.

Specified by:

isFilterablePropertyDeprecated in interface FilteringDao<O extends Identifiable>

Throws:

IllegalArgumentException - if the property does not exist

getFilter

public final Filter getFilter(String property,
 Filter.Operator operator,
 String value)

Description copied from interface: FilteringDao

Obtain an Filter for the entity this DAO is providing.

It is the responsibility of the DAO to infer the filter property type as well as the alias to use.

If the filter refers to a related entity (i.e. a BioAssay of an ExpressionExperiment), then the DAO should inject the corresponding DAO and delegate it the work of creating the filter.

In the frontend, that correspond to a FilterArg, but since the definition is not available here, we unpack its attributes.

Specified by:

getFilter in interface FilteringDao<O extends Identifiable>

Parameters:

property - property name in the entity use as a left-hand side of the operator

operator - an operator

value - the corresponding, unparsed value, to the right-hand side of the operator

Returns:

a filter filled with the object alias, property, inferred type, operator and parsed value

getFilter

public final Filter getFilter(String property,
 Filter.Operator operator,
 String value,
 SubqueryMode subqueryMode)

Specified by:

getFilter in interface FilteringDao<O extends Identifiable>

getFilter

public final Filter getFilter(String property,
 Filter.Operator operator,
 Collection<String> values)

Description copied from interface: FilteringDao

Similar to FilteringDao.getFilter(String, Filter.Operator, String), but with a collection of values.

Specified by:

getFilter in interface FilteringDao<O extends Identifiable>

getFilter

public final Filter getFilter(String property,
 Filter.Operator operator,
 Collection<String> values,
 SubqueryMode subqueryMode)

Specified by:

getFilter in interface FilteringDao<O extends Identifiable>

getFilter

public final <T> Filter getFilter(String property,
 Class<T> propertyType,
 Filter.Operator operator,
 @Nullable
 T value)

Description copied from interface: FilteringDao

Obtain a Filter with an already parsed value.

Specified by:

getFilter in interface FilteringDao<O extends Identifiable>

See Also:

• FilteringDao.getFilter(String, Filter.Operator, String)

getFilter

public final <T> Filter getFilter(String property,
 Class<T> propertyType,
 Filter.Operator operator,
 Collection<T> values)

Description copied from interface: FilteringDao

Obtain a Filter with an already parsed collection of values.

Specified by:

getFilter in interface FilteringDao<O extends Identifiable>

See Also:

• FilteringDao.getFilter(String, Filter.Operator, Collection)

getFilter

public final Filter getFilter(List<FilteringDao.ConjunctSpec> conjuncts,
 @Nullable
 SubqueryMode subqueryMode)

Description copied from interface: FilteringDao

Build a filter requiring a SINGLE element of a to-many relation to satisfy EVERY given predicate.

Ordinary conjunction cannot express this. valueUri = X and categoryUri = Y becomes two independent subqueries and asks "has some characteristic valued X, and has some characteristic categorised Y" — which is true of a dataset where those are different characteristics. This conjoins the predicates inside one subquery, so they must hold of the same element.

Every predicate must be a subquery-filterable property on the same relation.

Specified by:

getFilter in interface FilteringDao<O extends Identifiable>

Parameters:

conjuncts - predicates to conjoin; at least one. A single conjunct behaves exactly like the corresponding getFilter overload.

subqueryMode - SubqueryMode.ANY (the default when null) or SubqueryMode.NONE. SubqueryMode.ALL is rejected for more than one conjunct: "every element satisfies A and B" negates to a disjunction, which a subquery carrying a conjunction cannot represent.

getSort

public final Sort getSort(String property,
 @Nullable
 Sort.Direction direction,
 Sort.NullMode nullMode)

Description copied from interface: FilteringDao

Obtain a Sort object for a property of the O.

Specified by:

getSort in interface FilteringDao<O extends Identifiable>

Parameters:

property - a property of O to sort by

direction - a sorting direction, or null if the default direction applies

nullMode - behavior for null values when sorting

Returns:

a Sort object that can be used, for example, on FilteringVoEnabledDao.loadValueObjects(Filters, Sort, int, int)

getFilterablePropertyMeta

protected final AbstractFilteringVoEnabledDao.FilterablePropertyMeta getFilterablePropertyMeta(String propertyName)

resolveFilterablePropertyMeta

protected AbstractFilteringVoEnabledDao.FilterablePropertyMeta.FilterablePropertyMetaBuilder resolveFilterablePropertyMeta(String propertyName)
                                                                                                                    throws IllegalArgumentException

Obtain various meta-information used to infer what to use in a Filter or Sort.

This is used by getFilter(String, Filter.Operator, String) and FilteringDao.getSort(String, Sort.Direction, Sort.NullMode).

Throws:

IllegalArgumentException - if no such propertyName exists in O

See Also:

• getFilter(String, Filter.Operator, String)
• getFilter(String, Filter.Operator, Collection)
• FilteringDao.getSort(String, Sort.Direction, Sort.NullMode)

resolveFilterablePropertyMeta

protected AbstractFilteringVoEnabledDao.FilterablePropertyMeta.FilterablePropertyMetaBuilder resolveFilterablePropertyMeta(@Nullable
 String objectAlias,
 Class<? extends Identifiable> clazz,
 String propertyName)
                                                                                                                    throws IllegalArgumentException

Throws:

IllegalArgumentException