Package 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	Description
protected AccountingPersistenceBackendQuery	accountingPersistenceBackendQuery
protected Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>>	clz
protected Set<String>	contexts
static final int	DEFAULT_LIMIT_RESULT_NUMBER
protected Collection<? extends Filter>	filters
protected org.gcube.com.fasterxml.jackson.databind.ObjectMapper	objectMapper
protected TemporalConstraint	temporalConstraint

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

KEY_VALUES_LIMIT

Method Summary

Modifier and Type	Method	Description
void	close()	Close the connection to persistence
SortedMap<Filter,SortedMap<Calendar,Info>>	getContextTimeSeries()	Return a SortedMap containing the TimeSeries for each context.
SortedMap<Filter,SortedMap<Calendar,Info>>	getContextTimeSeries(boolean pad)
SortedSet<String>	getDataType()
static String	getDefaultOrderingProperties(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz)
SortedSet<NumberedFilter>	getFilterValues(String key)
SortedSet<NumberedFilter>	getFilterValues(String key, Integer limit)
protected static AccountingPersistenceQuery	getInstance()
protected org.gcube.com.fasterxml.jackson.databind.JsonNode	getPaddingJsonNode(Map<Calendar,Info> unpaddedResults)
static SortedSet<String>	getQuerableKeys(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz)
org.gcube.documentstore.records.Record	getRecord(String recordId, String type)
SortedMap<Filter,SortedMap<Calendar,Info>>	getSpaceTimeSeries(Set<String> dataTypes)
SortedMap<Calendar,Info>	getTimeSeries()	Query the persistence obtaining a Map where the date is the key and the #Info is the value.
SortedMap<Calendar,Info>	getTimeSeries(boolean pad)
SortedMap<NumberedFilter,SortedMap<Calendar,Info>>	getTopValues(String topKey)
SortedMap<NumberedFilter,SortedMap<Calendar,Info>>	getTopValues(String topKey, String orderingProperty, boolean pad, Integer limit)
SortedMap<NumberedFilter,SortedMap<Calendar,Info>>	getTopValues(String topKey, String orderingProperty, Integer limit)	Return a SortedMap containing the TimeSeries for top values for a certain key taking in account all Filters.
List<UsageValue>	getUsageValueQuotaTotal(List<UsageValue> listUsage)	getUsageValueQuotaTotal Example to require 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] ]
boolean	isConnectionActive()
protected SortedMap<Calendar,Info>	padMap(SortedMap<Calendar,Info> unpaddedData)	Pad the data
protected SortedMap<Calendar,Info>	padMapStorage(SortedMap<Calendar,Info> unpaddedData)
void	prepareConnection(AccountingPersistenceBackendQueryConfiguration configuration)
void	setContexts(Set<String> contexts)
void	setFilters(Collection<? extends Filter> filters)
void	setRequestedRecords(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz)
void	setTemporalConstraint(TemporalConstraint temporalConstraint)

Methods inherited from class java.lang.Object

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

Field Details

DEFAULT_LIMIT_RESULT_NUMBER

public static final int DEFAULT_LIMIT_RESULT_NUMBER

See Also:

• Constant Field Values

clz

protected Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz

temporalConstraint

protected TemporalConstraint temporalConstraint

contexts

protected Set<String> contexts

filters

protected Collection<? extends Filter> filters

objectMapper

protected org.gcube.com.fasterxml.jackson.databind.ObjectMapper objectMapper

accountingPersistenceBackendQuery

protected AccountingPersistenceBackendQuery accountingPersistenceBackendQuery

Method Details

getInstance

protected static AccountingPersistenceQuery getInstance()

setRequestedRecords

public void setRequestedRecords(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz)

Specified by:

setRequestedRecords in interface AccountingPersistenceBackendQuery

Parameters:

clz - the Usage Record Class of interest Required

setTemporalConstraint

public void setTemporalConstraint(TemporalConstraint temporalConstraint)

Specified by:

setTemporalConstraint in interface AccountingPersistenceBackendQuery

Parameters:

temporalConstraint - the TemporalConstraint (interval and aggregation) Required

setContexts

public void setContexts(Set<String> contexts)

Specified by:

setContexts in interface AccountingPersistenceBackendQuery

Parameters:

contexts - the list of context to use as filter If null or empty list get all data for the interested Record Class with the applying temporal constraint with no contexts constraint. The contexts are evaluated in OR.

setFilters

public void setFilters(Collection<? extends Filter> filters)

Specified by:

setFilters in interface AccountingPersistenceBackendQuery

Parameters:

filters - list of filter to obtain the results. 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 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 when trying to query.

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)

getPaddingJsonNode

protected org.gcube.com.fasterxml.jackson.databind.JsonNode getPaddingJsonNode(Map<Calendar,Info> unpaddedResults)
                                                                        throws Exception

Throws:

Exception

padMap

protected SortedMap<Calendar,Info> padMap(SortedMap<Calendar,Info> unpaddedData)
                                   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()
                                       throws DuplicatedKeyFilterException,
KeyException,
ValueException,
Exception

Description copied from interface: AccountingPersistenceBackendQuery

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

Returns:

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

Throws:

Exception

DuplicatedKeyFilterException

KeyException

ValueException

getTimeSeries

public SortedMap<Calendar,Info> getTimeSeries(boolean pad)
                                       throws DuplicatedKeyFilterException,
KeyException,
ValueException,
Exception

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getTopValues

public SortedMap<NumberedFilter,SortedMap<Calendar,Info>> getTopValues(String topKey,
 String orderingProperty,
 boolean pad,
 Integer limit)
                                                                throws DuplicatedKeyFilterException,
KeyException,
ValueException,
Exception

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getTopValues

public SortedMap<NumberedFilter,SortedMap<Calendar,Info>> getTopValues(String topKey)
                                                                throws DuplicatedKeyFilterException,
KeyException,
ValueException,
Exception

Throws:

DuplicatedKeyFilterException

KeyException

ValueException

Exception

getTopValues

public SortedMap<NumberedFilter,SortedMap<Calendar,Info>> getTopValues(String topKey,
 String orderingProperty,
 Integer limit)
                                                                throws Exception

Description copied from interface: AccountingPersistenceBackendQuery

Return a SortedMap containing the TimeSeries for top values for a certain key taking in account all Filters. The values are ordered from the most occurred value.

Specified by:

getTopValues in interface AccountingPersistenceBackendQuery

Parameters:

topKey - the key to obtain top values

Returns:

a SortedMap

Throws:

Exception

close

public void close()
           throws Exception

Description copied from interface: AccountingPersistenceBackendQuery

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(String key)
                                          throws Exception

Specified by:

getFilterValues in interface AccountingPersistenceBackendQuery

Throws:

Exception

getFilterValues

public SortedSet<NumberedFilter> getFilterValues(String key,
 Integer limit)
                                          throws Exception

Specified by:

getFilterValues in interface AccountingPersistenceBackendQuery

Throws:

Exception

getUsageValueQuotaTotal

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

Description copied from interface: AccountingPersistenceBackendQuery

getUsageValueQuotaTotal Example to require 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:

List

Throws:

Exception

getContextTimeSeries

public SortedMap<Filter,SortedMap<Calendar,Info>> getContextTimeSeries()
                                                                throws Exception

Description copied from interface: AccountingPersistenceBackendQuery

Return a SortedMap containing the TimeSeries for each context.

Specified by:

getContextTimeSeries in interface AccountingPersistenceBackendQuery

Returns:

a SortedMap containing the TimeSeries for each context.

Throws:

Exception

getContextTimeSeries

public SortedMap<Filter,SortedMap<Calendar,Info>> getContextTimeSeries(boolean pad)
                                                                throws DuplicatedKeyFilterException,
Exception

Throws:

DuplicatedKeyFilterException

Exception

getRecord

public org.gcube.documentstore.records.Record getRecord(String recordId,
 String type)
                                                 throws Exception

Specified by:

getRecord in interface AccountingPersistenceBackendQuery

Throws:

Exception

getDataType

public SortedSet<String> getDataType()
                              throws Exception

Throws:

Exception

getSpaceTimeSeries

public SortedMap<Filter,SortedMap<Calendar,Info>> getSpaceTimeSeries(Set<String> dataTypes)
                                                              throws Exception

Specified by:

getSpaceTimeSeries in interface AccountingPersistenceBackendQuery

Throws:

Exception

padMapStorage

protected SortedMap<Calendar,Info> padMapStorage(SortedMap<Calendar,Info> unpaddedData)
                                          throws Exception

Throws:

Exception

isConnectionActive

public boolean isConnectionActive()
                           throws Exception

Specified by:

isConnectionActive in interface AccountingPersistenceBackendQuery

Throws:

Exception