org.gcube.accounting.analytics.persistence

Class AccountingPersistenceBackendQuery

java.lang.Object

org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

public abstract class AccountingPersistenceBackendQuery
extends Object

Author:

Luca Frosini (ISTI - CNR) http://www.lucafrosini.com/

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEY_VALUES_LIMIT

Constructor Summary

Constructors

Constructor and Description
AccountingPersistenceBackendQuery()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	close() Close the connection to persistence
abstract Set<String>	getKeys(Class<? extends org.gcube.documentstore.records.AggregatedRecord> recordClass) Return the list of key valid for queries a certain usage record type
abstract Set<String>	getPossibleValuesForKey(Class<? extends org.gcube.documentstore.records.AggregatedRecord> recordClass, String key) Return the list of possible values for a key for a certain usage record type.
abstract Set<String>	getPossibleValuesForKey(Class<? extends org.gcube.documentstore.records.AggregatedRecord> recordClass, String key, int limit) Return the list of possible values for a key for a certain usage record type.
protected abstract void	prepareConnection(AccountingPersistenceBackendQueryConfiguration configuration)
Map<Calendar,Info>	query(Class<? extends org.gcube.documentstore.records.AggregatedRecord> recordClass, TemporalConstraint temporalConstraint, List<Filter> filters) Query the persistence obtaining a Map where the date is the key and the #Info is the value.
protected abstract Map<Calendar,Info>	reallyQuery(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType, TemporalConstraint temporalConstraint, List<Filter> filters)

Methods inherited from class java.lang.Object

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

Field Detail

KEY_VALUES_LIMIT

public static final int KEY_VALUES_LIMIT

See Also:

Constant Field Values

Constructor Detail

AccountingPersistenceBackendQuery

public AccountingPersistenceBackendQuery()

Method Detail

prepareConnection

protected abstract void prepareConnection(AccountingPersistenceBackendQueryConfiguration configuration)
                                   throws Exception

Throws:

Exception

reallyQuery

protected abstract Map<Calendar,Info> reallyQuery(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType,
                             TemporalConstraint temporalConstraint,
                             List<Filter> filters)
                                           throws Exception

Throws:

Exception

query

public Map<Calendar,Info> query(Class<? extends org.gcube.documentstore.records.AggregatedRecord> recordClass,
                       TemporalConstraint temporalConstraint,
                       List<Filter> filters)
                         throws Exception

Query the persistence obtaining a Map where the date is the key and the #Info is the value. The result is relative to an Usage Record Type, respect a TemporalConstraint and can be applied one or more filters.

Parameters:

recordClass - the Usage Record Type of interest

temporalConstraint - the TemporalConstraint (interval and aggregation)

filters - the filter for the query. If null or empty string get all data. The filters are evaluated in the order the are presented and are considered in AND

Returns:

the Map containing for each date in the required interval the requested data

Throws:

Exception - if fails

getKeys

public abstract Set<String> getKeys(Class<? extends org.gcube.documentstore.records.AggregatedRecord> recordClass)
                             throws Exception

Return the list of key valid for queries a certain usage record type

Parameters:

recordClass - the usage record class

Returns:

a set containing the list of key

Throws:

Exception - if fails

getPossibleValuesForKey

public abstract Set<String> getPossibleValuesForKey(Class<? extends org.gcube.documentstore.records.AggregatedRecord> recordClass,
                                  String key)
                                             throws Exception

Return the list of possible values for a key for a certain usage record type. The result are limited to KEY_VALUES_LIMIT value. If you want a different limit please use the getPossibleValuesForKey(Class, String, int) function. Invoking this function has the same effect of invoking getPossibleValuesForKey(Class, String, int) function passing KEY_VALUES_LIMIT has third argument.

Parameters:

recordClass - the usage record type

key - the key

Returns:

a set containing the list of possible values

Throws:

Exception - if fails

getPossibleValuesForKey

public abstract Set<String> getPossibleValuesForKey(Class<? extends org.gcube.documentstore.records.AggregatedRecord> recordClass,
                                  String key,
                                  int limit)
                                             throws Exception

Return the list of possible values for a key for a certain usage record type. The result are limited to limit value. When limit is <= 0 this means no limit.

Parameters:

recordClass - the usage record type

key - the key

limit - limit of result to return.

Returns:

a set containing the list of possible values

Throws:

Exception - if fails

close

public abstract void close()
                    throws Exception

Close the connection to persistence

Throws:

Exception - if the close fails