org.gcube.accounting.analytics.persistence

Class AccountingPersistenceQuery

java.lang.Object

org.gcube.accounting.analytics.persistence.AccountingPersistenceQuery

All Implemented Interfaces:

AccountingPersistenceBackendQuery

public class AccountingPersistenceQuery
extends Object
implements AccountingPersistenceBackendQuery

Author:

Luca Frosini (ISTI - CNR)

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_LIMIT_RESULT_NUMBER

Fields inherited from interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

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.
SortedMap<Filter,SortedMap<Calendar,Info>>	getContextTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, List<String> contexts, boolean pad)
static String	getDefaultOrderingProperties(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz)
SortedSet<NumberedFilter>	getFilterValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, String key) Return a sortedSet filter value
protected static AccountingPersistenceQuery	getInstance()
SortedSet<NumberedFilter>	getNextPossibleValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, String key)
SortedSet<NumberedFilter>	getNextPossibleValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, String key, String orderingProperty)
protected static org.json.JSONObject	getPaddingJSONObject(Map<Calendar,Info> unpaddedResults)
static SortedSet<String>	getQuerableKeys(org.gcube.documentstore.records.AggregatedRecord instance) Deprecated.
static SortedSet<String>	getQuerableKeys(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz)
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<Calendar,Info>	getTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, boolean pad)
SortedMap<NumberedFilter,SortedMap<Calendar,Info>>	getTopValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, String topKey)
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.
SortedMap<NumberedFilter,SortedMap<Calendar,Info>>	getTopValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, TemporalConstraint temporalConstraint, List<Filter> filters, String topKey, String orderingProperty, boolean pad, int limit)
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] ]
static SortedMap<Calendar,Info>	padMap(SortedMap<Calendar,Info> unpaddedData, TemporalConstraint temporalConstraint) Pad the data
void	prepareConnection(AccountingPersistenceBackendQueryConfiguration configuration)

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_LIMIT_RESULT_NUMBER

public static final int DEFAULT_LIMIT_RESULT_NUMBER

See Also:

Constant Field Values

Method Detail

getInstance

protected static AccountingPersistenceQuery getInstance()

getQuerableKeys

@Deprecated
public static SortedSet<String> getQuerableKeys(org.gcube.documentstore.records.AggregatedRecord instance)
                                                     throws Exception

Deprecated.

Throws:

Exception

getQuerableKeys

public static SortedSet<String> getQuerableKeys(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz)
                                         throws Exception

Throws:

Exception

getDefaultOrderingProperties

public static String getDefaultOrderingProperties(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz)

getPaddingJSONObject

protected static org.json.JSONObject getPaddingJSONObject(Map<Calendar,Info> unpaddedResults)
                                                   throws org.json.JSONException

Throws:

org.json.JSONException

padMap

public static SortedMap<Calendar,Info> padMap(SortedMap<Calendar,Info> unpaddedData,
                                              TemporalConstraint temporalConstraint)
                                       throws Exception

Pad the data

Parameters:

unpaddedData - the data to be pad

temporalConstraint - temporalConstraint the temporal interval and the granularity of the data to pad

Returns:

the data padded taking in account the TemporalConstraint

Throws:

Exception - if fails

getTimeSeries

public 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.

Specified by:

getTimeSeries in interface AccountingPersistenceBackendQuery

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

getTimeSeries

public SortedMap<Calendar,Info> getTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                              TemporalConstraint temporalConstraint,
                                              List<Filter> filters,
                                              boolean pad)
                                       throws DuplicatedKeyFilterException,
                                              KeyException,
                                              ValueException,
                                              Exception

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getTopValues

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

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getTopValues

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

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getTopValues

public 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.

Specified by:

getTopValues in interface AccountingPersistenceBackendQuery

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.

Returns:

a SortedMap

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getNextPossibleValues

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

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getNextPossibleValues

public 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

Specified by:

getNextPossibleValues in interface AccountingPersistenceBackendQuery

Returns:

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

close

public void close()
           throws Exception

Close the connection to persistence

Specified by:

close in interface AccountingPersistenceBackendQuery

Throws:

Exception - if the close fails

prepareConnection

public void prepareConnection(AccountingPersistenceBackendQueryConfiguration configuration)
                       throws Exception

Specified by:

prepareConnection in interface AccountingPersistenceBackendQuery

Throws:

Exception

getFilterValues

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

Description copied from interface: AccountingPersistenceBackendQuery

Return a sortedSet filter value

Specified by:

getFilterValues in interface AccountingPersistenceBackendQuery

Returns:

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getUsageValue

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

Description copied from interface: AccountingPersistenceBackendQuery

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

Specified by:

getUsageValue in interface AccountingPersistenceBackendQuery

Parameters:

clz - the Usage Record Class of interest

temporalConstraint - the TemporalConstraint (interval and aggregation)

applicant - the type field and value

Returns:

Throws:

Exception

getUsageValueQuotaTotal

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

Description copied from interface: AccountingPersistenceBackendQuery

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] ]

Specified by:

getUsageValueQuotaTotal in interface AccountingPersistenceBackendQuery

Returns:

Throws:

Exception

getContextTimeSeries

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

Description copied from interface: AccountingPersistenceBackendQuery

Return a SortedMap containing the TimeSeries for each context.

Specified by:

getContextTimeSeries in interface AccountingPersistenceBackendQuery

Returns:

Throws:

Exception

getContextTimeSeries

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

Throws:

DuplicatedKeyFilterException

Exception