Package ubic.gemma.persistence.service

Interface FilteringService<O extends Identifiable>

All Superinterfaces:

BaseReadOnlyService<O>

All Known Subinterfaces:

ArrayDesignService, BioAssayService, CharacteristicService, CompositeSequenceService, DatabaseEntryService, ExpressionAnalysisResultSetService, ExpressionExperimentService, FactorValueService, FilteringVoEnabledService<O,VO>, GeneService, QuantitationTypeService, SecurableFilteringVoEnabledService<C,VO>, TaxonService

All Known Implementing Classes:

AbstractFilteringVoEnabledService, ArrayDesignServiceImpl, BioAssayServiceImpl, CharacteristicServiceImpl, CompositeSequenceServiceImpl, DatabaseEntryServiceImpl, ExpressionAnalysisResultSetServiceImpl, ExpressionExperimentServiceImpl, FactorValueServiceImpl, GeneServiceImpl, QuantitationTypeServiceImpl, TaxonServiceImpl

public interface FilteringService<O extends Identifiable>
extends BaseReadOnlyService<O>

Interface for filtering-capable services.

See Also:

FilteringDao

Method Summary

Modifier and Type	Method	Description
long	count(Filters filters)
<T> Filter	getFilter(String property, Class<T> propertyType, Filter.Operator operator, Collection<T> parsedValues)
<T> Filter	getFilter(String property, Class<T> propertyType, Filter.Operator operator, T value)
Filter	getFilter(String property, Filter.Operator operator, String value)
Filter	getFilter(String property, Filter.Operator operator, String value, SubqueryMode subqueryMode)
Filter	getFilter(String property, Filter.Operator operator, Collection<String> values)
Filter	getFilter(String property, Filter.Operator operator, Collection<String> values, SubqueryMode subqueryMode)
Set<String>	getFilterableProperties()
List<Object>	getFilterablePropertyAllowedValues(String property)
Collection<org.springframework.security.access.ConfigAttribute>	getFilterablePropertyConfigAttributes(String property)	Obtain the Spring Security config attributes for a given property.
String	getFilterablePropertyDescription(String property)
boolean	getFilterablePropertyIsUsingSubquery(String property)
List<org.springframework.context.MessageSourceResolvable>	getFilterablePropertyResolvableAllowedValuesLabels(String property)	Obtain a list of resolvable MessageSourceResolvables to be used for user display purposes.
Class<?>	getFilterablePropertyType(String property)
String	getIdentifierPropertyName()
Sort	getSort(String property, Sort.Direction direction, Sort.NullMode last)
List<O>	load(Filters filters, Sort sort)
Slice<O>	load(Filters filters, Sort sort, int offset, int limit)
List<Long>	loadIds(Filters filters, Sort sort)

Methods inherited from interface ubic.gemma.persistence.service.BaseReadOnlyService

countAll, find, findOrFail, getElementClass, load, load, loadAll, loadOrFail, loadOrFail, loadOrFail, loadOrFail

Method Detail

getIdentifierPropertyName

String getIdentifierPropertyName()

See Also:

BaseDao.getIdentifierPropertyName()

getFilterableProperties

Set<String> getFilterableProperties()

See Also:

FilteringDao.getFilterableProperties()

getFilterablePropertyType

Class<?> getFilterablePropertyType(String property)

See Also:

FilteringDao.getFilterablePropertyType(String)

getFilterablePropertyDescription

@Nullable
String getFilterablePropertyDescription(String property)

See Also:

FilteringDao.getFilterablePropertyDescription(String)

getFilterablePropertyAllowedValues

@Nullable
List<Object> getFilterablePropertyAllowedValues(String property)

See Also:

FilteringDao.getFilterablePropertyAllowedValues(String)

getFilterablePropertyResolvableAllowedValuesLabels

@Nullable
List<org.springframework.context.MessageSourceResolvable> getFilterablePropertyResolvableAllowedValuesLabels(String property)

Obtain a list of resolvable MessageSourceResolvables to be used for user display purposes.

Nullity and the number of elements is guaranteed to match getFilterablePropertyAllowedValues(String) (String)}, so the two methods can be used jointly.

See Also:

getFilterablePropertyResolvableAllowedValuesLabels(String)

getFilterablePropertyIsUsingSubquery

boolean getFilterablePropertyIsUsingSubquery(String property)

See Also:

FilteringDao.getFilterablePropertyIsUsingSubquery(String)

getFilterablePropertyConfigAttributes

@Nullable
Collection<org.springframework.security.access.ConfigAttribute> getFilterablePropertyConfigAttributes(String property)

Obtain the Spring Security config attributes for a given property.

Returns:

the config attributes, or null if no security check should be performed

getFilter

Filter getFilter(String property,
                 Filter.Operator operator,
                 String value)
          throws IllegalArgumentException

Throws:

IllegalArgumentException

See Also:

FilteringDao.getFilterableProperties()

getFilter

Filter getFilter(String property,
                 Filter.Operator operator,
                 String value,
                 SubqueryMode subqueryMode)
          throws IllegalArgumentException

Throws:

IllegalArgumentException

getFilter

Filter getFilter(String property,
                 Filter.Operator operator,
                 Collection<String> values)
          throws IllegalArgumentException

Throws:

IllegalArgumentException

See Also:

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

getFilter

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

Throws:

IllegalArgumentException

getFilter

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

See Also:

FilteringDao.getFilter(String, Class, Filter.Operator, Object)

getFilter

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

See Also:

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

getSort

Sort getSort(String property,
             @Nullable
             Sort.Direction direction,
             Sort.NullMode last)
      throws IllegalArgumentException

Throws:

IllegalArgumentException

See Also:

FilteringDao.getSort(String, Sort.Direction, Sort.NullMode)

loadIds

List<Long> loadIds(@Nullable
                   Filters filters,
                   @Nullable
                   Sort sort)

See Also:

FilteringDao.loadIds(Filters, Sort)

load

Slice<O> load(@Nullable
              Filters filters,
              @Nullable
              Sort sort,
              int offset,
              int limit)

See Also:

FilteringDao.load(Filters, Sort, int, int)

load

List<O> load(@Nullable
             Filters filters,
             @Nullable
             Sort sort)

See Also:

FilteringDao.load(Filters, Sort)

count

long count(@Nullable
           Filters filters)

See Also:

FilteringDao.count(Filters)