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
protected static String	AGGREGATED_PREFIX
static long	AUTO_RELEASE_AFTER
protected com.couchbase.client.java.Cluster	cluster
protected org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQueryConfiguration	configuration
static long	CONNECTION_TIMEOUT
static long	CONNECTION_TIMEOUT_BUCKET
protected Map<String,com.couchbase.client.java.Bucket>	connectionMap
protected static String	DESIGN_DOC_ID
static String	DESIGN_DOC_ID_LIST_USAGE
protected static com.couchbase.client.java.env.CouchbaseEnvironment	ENV
static long	KEEP_ALIVE_INTERVAL
protected static String	KEYS_SEPARATOR
protected static String	MAP_REDUCE__DESIGN
protected static String	MAP_REDUCE_ALL
static long	MAX_REQUEST_LIFE_TIME
static String	PASSWORD_PROPERTY_KEY
static String	URL_PROPERTY_KEY
static long	VIEW_TIMEOUT_BUCKET

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 com.couchbase.client.java.Bucket	getBucket(Class<? extends org.gcube.accounting.datamodel.UsageRecord> clz)
protected com.couchbase.client.java.Bucket	getBucket(String recordType)
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)
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) Deprecated.
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, Integer limit) Used for list a possible values for each filter
static String	getMapReduceFunctionName(Collection<String> collection)
static String	getMapReduceFunctionNameTopMap(String top, Collection<String> collection)
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 recordType)
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)
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)
boolean	isConnectionActive()
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 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

ENV

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

MAX_REQUEST_LIFE_TIME

public static final long MAX_REQUEST_LIFE_TIME

KEEP_ALIVE_INTERVAL

public static final long KEEP_ALIVE_INTERVAL

AUTO_RELEASE_AFTER

public static final long AUTO_RELEASE_AFTER

VIEW_TIMEOUT_BUCKET

public static final long VIEW_TIMEOUT_BUCKET

CONNECTION_TIMEOUT_BUCKET

public static final long CONNECTION_TIMEOUT_BUCKET

CONNECTION_TIMEOUT

public static final long CONNECTION_TIMEOUT

configuration

protected org.gcube.accounting.analytics.persistence.AccountingPersistenceBackendQueryConfiguration configuration

cluster

protected com.couchbase.client.java.Cluster cluster

connectionMap

protected Map<String,com.couchbase.client.java.Bucket> connectionMap

DESIGN_DOC_ID_LIST_USAGE

public static final String DESIGN_DOC_ID_LIST_USAGE

See Also:

Constant Field Values

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

AGGREGATED_PREFIX

protected static final String AGGREGATED_PREFIX

See Also:

Constant Field Values

Constructor Detail

AccountingPersistenceQueryCouchBase

public AccountingPersistenceQueryCouchBase()

Method Detail

isConnectionActive

public boolean isConnectionActive()
                           throws Exception

Specified by:

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

Throws:

Exception

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

getBucket

protected com.couchbase.client.java.Bucket getBucket(Class<? extends org.gcube.accounting.datamodel.UsageRecord> clz)
                                              throws Exception

Throws:

Exception

getBucket

protected com.couchbase.client.java.Bucket getBucket(String recordType)
                                              throws Exception

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

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

Throws:

InstantiationException

IllegalAccessException

getMapReduceFunctionName

public static String getMapReduceFunctionName(Collection<String> collection)

getMapReduceFunctionNameTopMap

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

getDesignDocIdName

public static String getDesignDocIdName(Collection<String> collection)

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

Parameters:

collection -

Returns:

String

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

Specified by:

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

Throws:

Exception

usingNextPossibleValuesWithMap

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

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

Parameters:

clz -

topKey -

Returns:

boolean

Throws:

Exception

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:

SortedSet

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:

SortedSet

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:

SortedMap

Throws:

Exception

getQualifiedProperty

protected String getQualifiedProperty(String property)

getSpecializedProperty

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

Throws:

Exception

getFilterValues

@Deprecated
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

Deprecated.

Specified by:

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

Throws:

Exception

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,
                                                                                Integer limit)
                                                                         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:

SortedSet

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:

JSONObject

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:

List

Throws:

Exception

getRecord

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

Specified by:

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

Throws:

Exception

getSpaceProvidersIds

public SortedSet<String> getSpaceProvidersIds()
                                       throws Exception

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

Throws:

Exception

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 -

providersId -

Returns:

SortedMap

Throws:

org.json.JSONException

Exception