org.gcube.accounting.analytics.persistence

Interface AccountingPersistenceBackendQuery

All Known Implementing Classes:

AccountingPersistenceQuery

public interface AccountingPersistenceBackendQuery

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field and Description
static int	KEY_VALUES_LIMIT

Method Summary

Modifier and Type	Method and Description
void	close() Close the connection to persistence
SortedMap<Filter,SortedMap<Calendar,Info>>	getContextTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, List<String> contexts) Return a SortedMap containing the TimeSeries for each context.
SortedSet<NumberedFilter>	getFilterValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, String key) Return a sortedSet filter value
SortedSet<NumberedFilter>	getNextPossibleValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, String key, String orderingProperty)
SortedMap<Calendar,Info>	getTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters) Query the persistence obtaining a Map where the date is the key and the #Info is the value.
SortedMap<NumberedFilter,SortedMap<Calendar,Info>>	getTopValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, String topKey, String orderingProperty) Return a SortedMap containing the TimeSeries for top values for a certain key taking in account all Filters.
org.json.JSONObject	getUsageValue(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, Filter applicant) Return a JsonObject with value e.g.for StorageUsageRecord {"dataVolume":1860328,"operationCount":4115} e.g.
List<UsageValue>	getUsageValueQuotaTotal(List<UsageValue> listUsage) getUsageValueQuotaTotal Example for crequire 2 different quota (lucio.lelii for service and alessandro.pieve for storage) Input: [ TotalFilters [ clz=class org.gcube.accounting.datamodel.aggregation.AggregatedServiceUsageRecord, temporalConstraint=StartTime : 2015-05-01 11:42:34:515 UTC (1430480554515 millis), EndTime : 2016-11-09 11:42:34:515 UTC (1478691754515 millis), Aggregated DAILY, totalFilters=[ Filters [filters=[ { "consumerId" : "lucio.lelii" }, { "serviceClass" : "DataAccess" }, { "serviceName" : "CkanConnector" } ], d=null, orderingProperty=null], Filters [filters=[ { "consumerId" : "lucio.lelii" }, { "serviceClass" : "VREManagement" } ], d=null, orderingProperty=null] ], d=null, orderingProperty=null] ] Output: [ TotalFilters [ clz=class org.gcube.accounting.datamodel.aggregation.AggregatedServiceUsageRecord, temporalConstraint=StartTime : 2015-05-01 11:42:34:515 UTC (1430480554515 millis), EndTime : 2016-11-09 11:42:34:515 UTC (1478691754515 millis), Aggregated DAILY, totalFilters=[ Filters [filters=[ { "consumerId" : "lucio.lelii" }, { "serviceClass" : "DataAccess" }, { "serviceName" : "CkanConnector" } ], d=1.0, orderingProperty=operationCount], Filters [filters=[ { "consumerId" : "lucio.lelii" }, { "serviceClass" : "VREManagement" } ], d=1.0, orderingProperty=operationCount] ], d=2.0, orderingProperty=null] ]
void	prepareConnection(AccountingPersistenceBackendQueryConfiguration configuration)

Field Detail

KEY_VALUES_LIMIT

static final int KEY_VALUES_LIMIT

See Also:

Constant Field Values

Method Detail

prepareConnection

void prepareConnection(AccountingPersistenceBackendQueryConfiguration configuration)
                throws Exception

Throws:

Exception

getTimeSeries

SortedMap<Calendar,Info> getTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                       TemporalConstraint temporalConstraint,
                                       List<Filter> filters)
                                throws DuplicatedKeyFilterException,
                                       KeyException,
                                       ValueException,
                                       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:

clz - the Record Class of interest

temporalConstraint - the TemporalConstraint (interval and aggregation)

filters - list of filter to obtain the time series. If null or empty list get all data for the interested Record Class with the applying temporal constraint. All Filter must have not null and not empty key and value. The filters are must be related to different keys and are in AND. If the list contains more than one filter with the same key an Exception is thrown.

Returns:

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

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getTopValues

SortedMap<NumberedFilter,SortedMap<Calendar,Info>> getTopValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                                                TemporalConstraint temporalConstraint,
                                                                List<Filter> filters,
                                                                String topKey,
                                                                String orderingProperty)
                                                         throws DuplicatedKeyFilterException,
                                                                KeyException,
                                                                ValueException,
                                                                Exception

Return a SortedMap containing the TimeSeries for top values for a certain key taking in account all Filters. The key is identified adding a Filter with a null value. Only one Filter with null value is allowed otherwise an Exception is thrown. The values are ordered from the most occurred value.

Parameters:

clz - the Usage Record Class of interest

temporalConstraint - the TemporalConstraint (interval and aggregation)

filters - list of filter to obtain the time series of top values. If null or empty list get all data for the interested Record Class with the applying temporal constraint. All Filter must have not null and not empty key and value. The filters are must be related to different keys and are in AND. If the list contains more than one filter with the same key an Exception is thrown.

topKey -

orderingProperty -

Returns:

a SortedMap

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getNextPossibleValues

SortedSet<NumberedFilter> getNextPossibleValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                                TemporalConstraint temporalConstraint,
                                                List<Filter> filters,
                                                String key,
                                                String orderingProperty)
                                         throws DuplicatedKeyFilterException,
                                                KeyException,
                                                ValueException,
                                                Exception

Parameters:

clz -

temporalConstraint -

filters -

key -

orderingProperty -

Returns:

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

close

void close()
    throws Exception

Close the connection to persistence

Throws:

Exception - if the close fails

getFilterValues

SortedSet<NumberedFilter> getFilterValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                          TemporalConstraint temporalConstraint,
                                          List<Filter> filters,
                                          String key)
                                   throws Exception

Return a sortedSet filter value

Parameters:

clz -

temporalConstraint -

filters -

key -

orderingProperty -

Returns:

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getUsageValue

org.json.JSONObject getUsageValue(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                  TemporalConstraint temporalConstraint,
                                  Filter applicant)
                           throws Exception

Return a JsonObject with value e.g.for StorageUsageRecord {"dataVolume":1860328,"operationCount":4115} e.g. for ServiceUsageRcord {"operationCount":1651624}

Parameters:

clz - the Usage Record Class of interest

temporalConstraint - the TemporalConstraint (interval and aggregation)

applicant - the type field and value

Returns:

Throws:

Exception

getUsageValueQuotaTotal

List<UsageValue> getUsageValueQuotaTotal(List<UsageValue> listUsage)
                                  throws Exception

getUsageValueQuotaTotal Example for crequire 2 different quota (lucio.lelii for service and alessandro.pieve for storage) Input: [ TotalFilters [ clz=class org.gcube.accounting.datamodel.aggregation.AggregatedServiceUsageRecord, temporalConstraint=StartTime : 2015-05-01 11:42:34:515 UTC (1430480554515 millis), EndTime : 2016-11-09 11:42:34:515 UTC (1478691754515 millis), Aggregated DAILY, totalFilters=[ Filters [filters=[ { "consumerId" : "lucio.lelii" }, { "serviceClass" : "DataAccess" }, { "serviceName" : "CkanConnector" } ], d=null, orderingProperty=null], Filters [filters=[ { "consumerId" : "lucio.lelii" }, { "serviceClass" : "VREManagement" } ], d=null, orderingProperty=null] ], d=null, orderingProperty=null] ] Output: [ TotalFilters [ clz=class org.gcube.accounting.datamodel.aggregation.AggregatedServiceUsageRecord, temporalConstraint=StartTime : 2015-05-01 11:42:34:515 UTC (1430480554515 millis), EndTime : 2016-11-09 11:42:34:515 UTC (1478691754515 millis), Aggregated DAILY, totalFilters=[ Filters [filters=[ { "consumerId" : "lucio.lelii" }, { "serviceClass" : "DataAccess" }, { "serviceName" : "CkanConnector" } ], d=1.0, orderingProperty=operationCount], Filters [filters=[ { "consumerId" : "lucio.lelii" }, { "serviceClass" : "VREManagement" } ], d=1.0, orderingProperty=operationCount] ], d=2.0, orderingProperty=null] ]

Parameters:

listUsage -

Returns:

Throws:

Exception

getContextTimeSeries

SortedMap<Filter,SortedMap<Calendar,Info>> getContextTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                                                TemporalConstraint temporalConstraint,
                                                                List<Filter> filters,
                                                                List<String> contexts)
                                                         throws Exception

Return a SortedMap containing the TimeSeries for each context.

Parameters:

clz -

temporalConstraint -

filters -

contexts -

Returns:

Throws:

Exception