org.gcube.accounting.analytics

Class ResourceRecordQuery

java.lang.Object

org.gcube.accounting.analytics.ResourceRecordQuery

public class ResourceRecordQuery
extends Object

Author:

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

Field Summary

Fields

Modifier and Type	Field and Description
protected AccountingPersistenceBackendQuery	accountingPersistenceQuery
protected static Map<Class<? extends org.gcube.documentstore.records.Record>,Set<String>>	resourceRecords

Constructor Summary

Constructors

Constructor and Description
ResourceRecordQuery() Instantiate the ResourceRecord for the current scope
ResourceRecordQuery(String scope) Instantiate the ResourceRecord for the provided scope

Method Summary

Methods

Modifier and Type	Method and Description
List<Info>	getInfo(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType, TemporalConstraint temporalConstraint, List<Filter> filters) Return unpadded results
List<Info>	getInfo(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType, TemporalConstraint temporalConstraint, List<Filter> filters, boolean pad) Return results with padding if pad is set to true.
List<String>	getKeys(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType) Return the list of key valid for queries a certain usage record type
static List<Info>	getPaddedResults(Map<Calendar,Info> unpaddedData, TemporalConstraint temporalConstraint) Pad the data
protected static org.json.JSONObject	getPaddingJSONObject(Map<Calendar,Info> unpaddedResults)
List<String>	getPossibleValuesForKey(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType, String key)
List<String>	getPossibleValuesForKey(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType, String key, int limit)
static Map<Class<? extends org.gcube.documentstore.records.Record>,Set<String>>	getResourceRecordsTypes() Return a Map containing a set of required fields for each Resource Records Types

Methods inherited from class java.lang.Object

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

Field Detail

resourceRecords

protected static Map<Class<? extends org.gcube.documentstore.records.Record>,Set<String>> resourceRecords

accountingPersistenceQuery

protected AccountingPersistenceBackendQuery accountingPersistenceQuery

Constructor Detail

ResourceRecordQuery

public ResourceRecordQuery()
                    throws NoAvailableScopeException,
                           NoUsableAccountingPersistenceQueryFound

Instantiate the ResourceRecord for the current scope

Throws:

NoAvailableScopeException - if there is not possible to query in the current scope

NoUsableAccountingPersistenceQueryFound - if there is no available instance which can query in that scope

ResourceRecordQuery

public ResourceRecordQuery(String scope)
                    throws NoAvailableScopeException,
                           NoUsableAccountingPersistenceQueryFound

Instantiate the ResourceRecord for the provided scope

Parameters:

scope - the scope

Throws:

NoAvailableScopeException - if there is not possible to query in that scope

NoUsableAccountingPersistenceQueryFound - if there is no available instance which can query in that scope

Method Detail

getResourceRecordsTypes

public static Map<Class<? extends org.gcube.documentstore.records.Record>,Set<String>> getResourceRecordsTypes()

Return a Map containing a set of required fields for each Resource Records Types

Returns:

the Map

getPaddingJSONObject

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

Throws:

org.json.JSONException

getPaddedResults

public static List<Info> getPaddedResults(Map<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

getInfo

public List<Info> getInfo(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType,
                 TemporalConstraint temporalConstraint,
                 List<Filter> filters,
                 boolean pad)
                   throws Exception

Return results with padding if pad is set to true.

Parameters:

usageRecordType - the UsageRecord type to query

temporalConstraint - the temporal interval and the granularity

filters - the list keys to filter (in AND)

pad - indicate is the results have to be padded with zeros when there is no data available at certain data points of sequence

Returns:

the requested list of Info

Throws:

Exception - if fails

getInfo

public List<Info> getInfo(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType,
                 TemporalConstraint temporalConstraint,
                 List<Filter> filters)
                   throws Exception

Return unpadded results

Parameters:

usageRecordType - the UsageRecord type to query

temporalConstraint - the temporal interval and the granularity

filters - the list keys to filter (in AND)

Returns:

the requested list of Info

Throws:

Exception - if fails

getKeys

public List<String> getKeys(Class<? extends org.gcube.documentstore.records.AggregatedRecord> usageRecordType)
                     throws Exception

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

Parameters:

usageRecordType - the usage record type

Returns:

a set containing the list of key

Throws:

Exception - if fails

getPossibleValuesForKey

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

Throws:

Exception

getPossibleValuesForKey

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

Throws:

Exception