org.gcube.accounting.analytics.persistence.couchbase

Class AccountingPersistenceQueryCouchBase

java.lang.Object

org.gcube.accounting.analytics.persistence.couchbase.AccountingPersistenceQueryCouchBase

All Implemented Interfaces:

org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

public class AccountingPersistenceQueryCouchBase
extends Object
implements org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Author:

Luca Frosini (ISTI - CNR), Alessandro Pieve (ISTI - CNR) alessandro.pieve@isti.cnr.it

Field Summary

Fields

Modifier and Type	Field and Description
static String	BUCKET_JOB_NAME_PROPERTY_KEY
static String	BUCKET_PORTLET_NAME_PROPERTY_KEY
static String	BUCKET_SERVICE_NAME_PROPERTY_KEY
static String	BUCKET_STORAGE_NAME_PROPERTY_KEY
static String	BUCKET_STORAGESTATUS_NAME_PROPERTY_KEY
static String	BUCKET_TASK_NAME_PROPERTY_KEY
protected com.couchbase.client.java.Bucket	bucketJob
protected String	bucketNameJob
protected String	bucketNamePortlet
protected String	bucketNameService
protected String	bucketNameStorage
protected String	bucketNameStorageStatus
protected String	bucketNameTask
protected com.couchbase.client.java.Bucket	bucketPortlet
protected com.couchbase.client.java.Bucket	bucketService
protected com.couchbase.client.java.Bucket	bucketStorage
protected com.couchbase.client.java.Bucket	bucketStorageStatus
protected com.couchbase.client.java.Bucket	bucketTask
protected com.couchbase.client.java.Cluster	cluster
protected static String	DESIGN_DOC_ID
static String	DESIGN_DOC_ID_LIST_USAGE
protected static com.couchbase.client.java.env.CouchbaseEnvironment	ENV
static long	ENV_TIME_OUT
protected static String	KEYS_SEPARATOR
protected static String	MAP_REDUCE__DESIGN
protected static String	MAP_REDUCE_ALL
static String	PASSWORD_PROPERTY_KEY
static long	QUERY_TIME_OUT
static String	URL_PROPERTY_KEY

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

KEY_VALUES_LIMIT

Constructor Summary

Constructors

Constructor and Description
AccountingPersistenceQueryCouchBase()

Method Summary

Modifier and Type	Method and Description
void	close()
protected Calendar	getCalendar(org.json.JSONObject obj, org.gcube.accounting.analytics.TemporalConstraint.AggregationMode aggregationMode)
protected Calendar	getCalendarFromArray(com.couchbase.client.java.document.json.JsonArray array)
SortedMap<org.gcube.accounting.analytics.Filter,SortedMap<Calendar,org.gcube.accounting.analytics.Info>>	getContextTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters, List<String> contexts) Return a list of context time series (used for portlet accounting context)
protected String	getDesignDocId(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> recordClass) Deprecated.
static String	getDesignDocIdName(Collection<String> collection) EXPERIMENTAL DEPRECATED generate a name of design doc id for a top
protected String	getDesignDocIdSpecific(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> recordClass, Collection<String> keys) New division of designDocId and map-reduce
SortedSet<org.gcube.accounting.analytics.NumberedFilter>	getFilterValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters, String key) Used for list a possible values for each filter
static String	getMapReduceFunctionName(Collection<String> collection) generate a name of map-reduce view
static String	getMapReduceFunctionNameTopMap(String top, Collection<String> collection) generate a name of map-reduce view
SortedSet<org.gcube.accounting.analytics.NumberedFilter>	getNextPossibleValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters, String key, String orderingProperty) Calculate a next possible value with query (more slow but with fewer resources )
SortedSet<org.gcube.accounting.analytics.NumberedFilter>	getNextPossibleValuesWithMap(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters, String key, String orderingProperty) Calculate a next possible value with map (faster but with greater demand for resources)
SortedMap<Calendar,org.gcube.accounting.analytics.Info>	getNoContextTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters)
protected String	getQualifiedProperty(String property)
protected com.couchbase.client.java.document.json.JsonArray	getRangeKey(long time, org.gcube.accounting.analytics.TemporalConstraint.AggregationMode aggregationMode, boolean wildCard, boolean endKey)
String	getRecord(String recordId, String type)
SortedSet<String>	getSpaceProvidersIds() Used for storage status aka tab Space (into portlet accounting) and popolate a list combobox used
SortedMap<org.gcube.accounting.analytics.Filter,SortedMap<Calendar,Long>>	getSpaceTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters, List<String> providersId) used for accounting portlet section storage status
protected String	getSpecializedProperty(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, String property)
SortedMap<Calendar,org.gcube.accounting.analytics.Info>	getTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters)
SortedMap<org.gcube.accounting.analytics.NumberedFilter,SortedMap<Calendar,org.gcube.accounting.analytics.Info>>	getTopValues(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters, String topKey, String orderingProperty) Used for calculate a top value
org.json.JSONObject	getUsageValue(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, org.gcube.accounting.analytics.Filter applicant) SPERIMENTAL now is not used
List<org.gcube.accounting.analytics.UsageValue>	getUsageValueQuotaTotal(List<org.gcube.accounting.analytics.UsageValue> listUsage) Used for calculate a usage value for each element of list (QUOTA)
protected SortedMap<Calendar,org.gcube.accounting.analytics.Info>	mapReduceQuery(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters, String context, Boolean valueEmpty, Boolean noScope)
void	prepareConnection(org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQueryConfiguration configuration)
protected Map<Calendar,org.gcube.accounting.analytics.Info>	selectQuery(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, org.gcube.accounting.analytics.TemporalConstraint temporalConstraint, List<org.gcube.accounting.analytics.Filter> filters) Deprecated.
protected boolean	usingNextPossibleValuesWithMap(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz, String topKey, List<org.gcube.accounting.analytics.Filter> filters) SPERIMENTAL Used for verify if have exist map for calculate a top

Methods inherited from class java.lang.Object

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

Field Detail

URL_PROPERTY_KEY

public static final String URL_PROPERTY_KEY

See Also:

Constant Field Values

PASSWORD_PROPERTY_KEY

public static final String PASSWORD_PROPERTY_KEY

See Also:

Constant Field Values

BUCKET_STORAGE_NAME_PROPERTY_KEY

public static final String BUCKET_STORAGE_NAME_PROPERTY_KEY

See Also:

Constant Field Values

BUCKET_STORAGESTATUS_NAME_PROPERTY_KEY

public static final String BUCKET_STORAGESTATUS_NAME_PROPERTY_KEY

See Also:

Constant Field Values

BUCKET_SERVICE_NAME_PROPERTY_KEY

public static final String BUCKET_SERVICE_NAME_PROPERTY_KEY

See Also:

Constant Field Values

BUCKET_PORTLET_NAME_PROPERTY_KEY

public static final String BUCKET_PORTLET_NAME_PROPERTY_KEY

See Also:

Constant Field Values

BUCKET_JOB_NAME_PROPERTY_KEY

public static final String BUCKET_JOB_NAME_PROPERTY_KEY

See Also:

Constant Field Values

BUCKET_TASK_NAME_PROPERTY_KEY

public static final String BUCKET_TASK_NAME_PROPERTY_KEY

See Also:

Constant Field Values

DESIGN_DOC_ID_LIST_USAGE

public static final String DESIGN_DOC_ID_LIST_USAGE

See Also:

Constant Field Values

ENV_TIME_OUT

public static final long ENV_TIME_OUT

See Also:

Constant Field Values

QUERY_TIME_OUT

public static final long QUERY_TIME_OUT

See Also:

Constant Field Values

ENV

protected static final com.couchbase.client.java.env.CouchbaseEnvironment ENV

cluster

protected com.couchbase.client.java.Cluster cluster

bucketStorage

protected com.couchbase.client.java.Bucket bucketStorage

bucketNameStorage

protected String bucketNameStorage

bucketStorageStatus

protected com.couchbase.client.java.Bucket bucketStorageStatus

bucketNameStorageStatus

protected String bucketNameStorageStatus

bucketService

protected com.couchbase.client.java.Bucket bucketService

bucketNameService

protected String bucketNameService

bucketPortlet

protected com.couchbase.client.java.Bucket bucketPortlet

bucketNamePortlet

protected String bucketNamePortlet

bucketJob

protected com.couchbase.client.java.Bucket bucketJob

bucketNameJob

protected String bucketNameJob

bucketTask

protected com.couchbase.client.java.Bucket bucketTask

bucketNameTask

protected String bucketNameTask

MAP_REDUCE__DESIGN

protected static final String MAP_REDUCE__DESIGN

See Also:

Constant Field Values

MAP_REDUCE_ALL

protected static final String MAP_REDUCE_ALL

See Also:

Constant Field Values

KEYS_SEPARATOR

protected static final String KEYS_SEPARATOR

See Also:

Constant Field Values

DESIGN_DOC_ID

protected static final String DESIGN_DOC_ID

See Also:

Constant Field Values

Constructor Detail

AccountingPersistenceQueryCouchBase

public AccountingPersistenceQueryCouchBase()

Method Detail

prepareConnection

public void prepareConnection(org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQueryConfiguration configuration)
                       throws Exception

Specified by:

prepareConnection in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Throws:

Exception

close

public void close()
           throws Exception

Specified by:

close in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Throws:

Exception

getCalendar

protected Calendar getCalendar(org.json.JSONObject obj,
                               org.gcube.accounting.analytics.TemporalConstraint.AggregationMode aggregationMode)
                        throws NumberFormatException,
                               org.json.JSONException

Throws:

NumberFormatException

org.json.JSONException

selectQuery

@Deprecated
protected Map<Calendar,org.gcube.accounting.analytics.Info> selectQuery(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                                                                    org.gcube.accounting.analytics.TemporalConstraint temporalConstraint,
                                                                                    List<org.gcube.accounting.analytics.Filter> filters)
                                                                             throws Exception

Deprecated.

IS NOT USED

Parameters:

clz -

temporalConstraint -

filters -

Returns:

Throws:

Exception

getCalendarFromArray

protected Calendar getCalendarFromArray(com.couchbase.client.java.document.json.JsonArray array)
                                 throws org.json.JSONException

Throws:

org.json.JSONException

getRangeKey

protected com.couchbase.client.java.document.json.JsonArray getRangeKey(long time,
                                                                        org.gcube.accounting.analytics.TemporalConstraint.AggregationMode aggregationMode,
                                                                        boolean wildCard,
                                                                        boolean endKey)
                                                                 throws org.json.JSONException

Throws:

org.json.JSONException

getDesignDocId

@Deprecated
protected String getDesignDocId(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> recordClass)
                                     throws InstantiationException,
                                            IllegalAccessException

Deprecated.

Throws:

InstantiationException

IllegalAccessException

getDesignDocIdSpecific

protected String getDesignDocIdSpecific(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> recordClass,
                                        Collection<String> keys)
                                 throws InstantiationException,
                                        IllegalAccessException

New division of designDocId and map-reduce

Parameters:

recordClass -

keys -

Returns:

Throws:

InstantiationException

IllegalAccessException

getMapReduceFunctionName

public static String getMapReduceFunctionName(Collection<String> collection)

generate a name of map-reduce view

Parameters:

collection -

Returns:

getMapReduceFunctionNameTopMap

public static String getMapReduceFunctionNameTopMap(String top,
                                                    Collection<String> collection)

generate a name of map-reduce view

Parameters:

collection -

Returns:

getDesignDocIdName

public static String getDesignDocIdName(Collection<String> collection)

EXPERIMENTAL DEPRECATED generate a name of design doc id for a top

Parameters:

collection -

Returns:

mapReduceQuery

protected SortedMap<Calendar,org.gcube.accounting.analytics.Info> mapReduceQuery(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                                                                 org.gcube.accounting.analytics.TemporalConstraint temporalConstraint,
                                                                                 List<org.gcube.accounting.analytics.Filter> filters,
                                                                                 String context,
                                                                                 Boolean valueEmpty,
                                                                                 Boolean noScope)
                                                                          throws Exception

Throws:

Exception

getTimeSeries

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

Specified by:

getTimeSeries in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Throws:

Exception

getNoContextTimeSeries

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

Specified by:

getNoContextTimeSeries in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Throws:

Exception

getTopValues

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

Used for calculate a top value

Specified by:

getTopValues in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Parameters:

clz -

temporalConstraint -

filters -

topKey -

orderingProperty -

Returns:

Throws:

Exception

usingNextPossibleValuesWithMap

protected boolean usingNextPossibleValuesWithMap(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                                 String topKey,
                                                 List<org.gcube.accounting.analytics.Filter> filters)

SPERIMENTAL Used for verify if have exist map for calculate a top

Parameters:

clz -

topKey -

Returns:

getNextPossibleValuesWithMap

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

Calculate a next possible value with map (faster but with greater demand for resources)

Specified by:

getNextPossibleValuesWithMap in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Parameters:

clz -

temporalConstraint -

filters -

key -

orderingProperty -

Returns:

Throws:

Exception

getNextPossibleValues

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

Calculate a next possible value with query (more slow but with fewer resources )

Specified by:

getNextPossibleValues in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Parameters:

clz -

temporalConstraint -

filters -

key -

orderingProperty -

Returns:

Throws:

Exception

getContextTimeSeries

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

Return a list of context time series (used for portlet accounting context)

Specified by:

getContextTimeSeries in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Parameters:

clz -

temporalConstraint -

filters -

contexts -

Returns:

Throws:

Exception

getQualifiedProperty

protected String getQualifiedProperty(String property)

getSpecializedProperty

protected String getSpecializedProperty(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                        String property)

getFilterValues

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

Used for list a possible values for each filter

Specified by:

getFilterValues in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Parameters:

clz -

temporalConstraint -

filters -

key -

Returns:

Throws:

Exception

getUsageValue

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

SPERIMENTAL now is not used

Specified by:

getUsageValue in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Parameters:

clz -

temporalConstraint -

applicant -

Returns:

Throws:

Exception

getUsageValueQuotaTotal

public List<org.gcube.accounting.analytics.UsageValue> getUsageValueQuotaTotal(List<org.gcube.accounting.analytics.UsageValue> listUsage)
                                                                        throws Exception

Used for calculate a usage value for each element of list (QUOTA)

Specified by:

getUsageValueQuotaTotal in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Parameters:

listUsage -

Returns:

Throws:

Exception

getRecord

public String getRecord(String recordId,
                        String type)
                 throws Exception

Specified by:

getRecord in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Throws:

Exception

getSpaceProvidersIds

public SortedSet<String> getSpaceProvidersIds()

Used for storage status aka tab Space (into portlet accounting) and popolate a list combobox used

Specified by:

getSpaceProvidersIds in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

getSpaceTimeSeries

public SortedMap<org.gcube.accounting.analytics.Filter,SortedMap<Calendar,Long>> getSpaceTimeSeries(Class<? extends org.gcube.documentstore.records.AggregatedRecord<?,?>> clz,
                                                                                                    org.gcube.accounting.analytics.TemporalConstraint temporalConstraint,
                                                                                                    List<org.gcube.accounting.analytics.Filter> filters,
                                                                                                    List<String> providersId)
                                                                                             throws Exception

used for accounting portlet section storage status

Specified by:

getSpaceTimeSeries in interface org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQuery

Parameters:

clz -

temporalConstraint -

filters -

context -

Returns:

Throws:

org.json.JSONException

Exception