org.gcube.accounting.datamodel

Class BasicUsageRecord

java.lang.Object

org.gcube.accounting.datamodel.BasicUsageRecord

All Implemented Interfaces:

Serializable, Comparable<UsageRecord>, UsageRecord

Direct Known Subclasses:

JobUsageRecord, PortletUsageRecord, RawUsageRecord, ServiceUsageRecord, StorageStatusUsageRecord, StorageUsageRecord, TaskUsageRecord

public abstract class BasicUsageRecord
extends Object
implements UsageRecord, Serializable

Author:

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

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from interface org.gcube.accounting.datamodel.UsageRecord

UsageRecord.OperationResult

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	AGGREGATED
protected static String	AGGREGATED_USAGE_RECORD_ID
protected Set<String>	aggregatedFields
protected Set<String>	computedFields
static String	CONSUMER_ID
static String	CREATION_TIME
static String	CREATOR_ID
protected static String	END_TIME
static String	ID
static String	OPERATION_RESULT
protected Set<String>	requiredFields
static String	RESOURCE_SCOPE
protected Map<String,Serializable>	resourceProperties resource-specific properties
protected static String	START_TIME
protected static String	USAGE_RECORD_TYPE
protected Map<String,List<FieldAction>>	validation

Constructor Summary

Constructors

Constructor and Description
BasicUsageRecord()
BasicUsageRecord(Map<String,Serializable> properties)

Method Summary

Methods

Modifier and Type	Method and Description
int	compareTo(UsageRecord usageRecord) Compare this UsageRecord instance with the one provided as argument
String	getAggregatedUsageRecordId() Return the id of the usage record aggregating this, null if this record has not been aggregated by any record.
protected static Class<? extends UsageRecord>	getClass(String usageRecordName, boolean aggregated)
String	getConsumerId() Return the identity of the entity that consumed the resource
Calendar	getCreationTime() Return the creation time for this {#UsageRecord}
String	getCreatorId() Return the identity of the entity creating this {#UsageRecord}
protected Calendar	getEndTimeAsCalendar() Return the right end of the time interval covered by this {#UsageRecord}
String	getId() Return the unique id for this {#UsageRecord}
UsageRecord.OperationResult	getOperationResult()
Map<String,Serializable>	getResourceProperties() Return all resource-specific properties.
Serializable	getResourceProperty(String key) Return the value of the given resource property.
String	getResourceScope() Return the accounting scope of the {#UsageRecord}
protected Calendar	getStartTimeAsCalendar() Return the left end of the time interval covered by this {#UsageRecord}
static UsageRecord	getUsageRecord(Map<String,Serializable> usageRecordMap) This method use the resourceType value contained in the Map to instance the right UsageRecord class and return it.
protected void	initializeValidation()
void	setAggregatedUsageRecordId(String aggregatedId) Set the id of the usage record aggregating this
void	setConsumerId(String consumerId) Set the identity of the entity that consumed the resource
void	setCreationTime(Calendar creationTime) Set the creation time for this {#UsageRecord}
void	setCreatorId(String creatorId) Set the identity of the entity creating this {#UsageRecord}
protected void	setEndTime(Calendar endTime) Set the right end of the time interval covered by this {#UsageRecord}
void	setId(String id) Set the unique id for this {#UsageRecord}
void	setOperationResult(UsageRecord.OperationResult operationResult) Set the Operation Result related to the accounted Usage Record
void	setResourceProperties(Map<String,Serializable> properties) Set all resource-specific properties, replacing existing ones
void	setResourceProperty(String key, Serializable value) Set the value of the given resource property.
void	setResourceScope(String scope) Set the accounting scope of the {#UsageRecord}
protected void	setStartTime(Calendar startTime) Set the left end of the time interval covered by this {#UsageRecord}
protected Calendar	timestampStringToCalendar(long millis)
String	toString()
void	validate() Validate the Resource Record
protected Serializable	validateField(String key, Serializable serializable)
protected void	validateProperties(Map<String,Serializable> properties)

Methods inherited from class java.lang.Object

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

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

CREATOR_ID

public static final String CREATOR_ID

See Also:

Constant Field Values

CONSUMER_ID

public static final String CONSUMER_ID

See Also:

Constant Field Values

CREATION_TIME

public static final String CREATION_TIME

See Also:

Constant Field Values

START_TIME

protected static final String START_TIME

See Also:

Constant Field Values

END_TIME

protected static final String END_TIME

See Also:

Constant Field Values

USAGE_RECORD_TYPE

protected static final String USAGE_RECORD_TYPE

See Also:

Constant Field Values

RESOURCE_SCOPE

public static final String RESOURCE_SCOPE

See Also:

Constant Field Values

AGGREGATED

protected static final String AGGREGATED

See Also:

Constant Field Values

AGGREGATED_USAGE_RECORD_ID

protected static final String AGGREGATED_USAGE_RECORD_ID

See Also:

Constant Field Values

OPERATION_RESULT

public static final String OPERATION_RESULT

See Also:

Constant Field Values

resourceProperties

protected Map<String,Serializable> resourceProperties

resource-specific properties

validation

protected Map<String,List<FieldAction>> validation

requiredFields

protected Set<String> requiredFields

aggregatedFields

protected Set<String> aggregatedFields

computedFields

protected Set<String> computedFields

Constructor Detail

BasicUsageRecord

public BasicUsageRecord()

BasicUsageRecord

public BasicUsageRecord(Map<String,Serializable> properties)
                 throws InvalidValueException

Throws:

InvalidValueException

Method Detail

initializeValidation

protected void initializeValidation()

getId

public String getId()

Return the unique id for this {#UsageRecord}

Specified by:

getId in interface UsageRecord

Returns:

{#UsageRecord} Unique ID

setId

public void setId(String id)
           throws InvalidValueException

Set the unique id for this {#UsageRecord}

Specified by:

setId in interface UsageRecord

Parameters:

id - {#UsageRecord} Unique ID

Throws:

InvalidValueException

getCreatorId

public String getCreatorId()

Return the identity of the entity creating this {#UsageRecord}

Specified by:

getCreatorId in interface UsageRecord

Returns:

Creator ID

setCreatorId

public void setCreatorId(String creatorId)
                  throws InvalidValueException

Set the identity of the entity creating this {#UsageRecord}

Specified by:

setCreatorId in interface UsageRecord

Parameters:

creatorId - Creator ID

Throws:

InvalidValueException

getConsumerId

public String getConsumerId()

Return the identity of the entity that consumed the resource

Specified by:

getConsumerId in interface UsageRecord

Returns:

Consumer ID

setConsumerId

public void setConsumerId(String consumerId)
                   throws InvalidValueException

Set the identity of the entity that consumed the resource

Specified by:

setConsumerId in interface UsageRecord

Parameters:

consumerId - Consumer ID

Throws:

InvalidValueException

timestampStringToCalendar

protected Calendar timestampStringToCalendar(long millis)

getCreationTime

public Calendar getCreationTime()

Return the creation time for this {#UsageRecord}

Specified by:

getCreationTime in interface UsageRecord

Returns:

the creation time for this {#UsageRecord}

setCreationTime

public void setCreationTime(Calendar creationTime)
                     throws InvalidValueException

Set the creation time for this {#UsageRecord}

Specified by:

setCreationTime in interface UsageRecord

Parameters:

creationTime - creation time

Throws:

InvalidValueException

getStartTimeAsCalendar

protected Calendar getStartTimeAsCalendar()

Return the left end of the time interval covered by this {#UsageRecord}

Returns:

Start Time

setStartTime

protected void setStartTime(Calendar startTime)
                     throws InvalidValueException

Set the left end of the time interval covered by this {#UsageRecord}

Parameters:

startTime - Start Time

Throws:

InvalidValueException

getEndTimeAsCalendar

protected Calendar getEndTimeAsCalendar()

Return the right end of the time interval covered by this {#UsageRecord}

Returns:

End Time

setEndTime

protected void setEndTime(Calendar endTime)
                   throws InvalidValueException

Set the right end of the time interval covered by this {#UsageRecord}

Parameters:

endTime - End Time

Throws:

InvalidValueException

getResourceScope

public String getResourceScope()

Return the accounting scope of the {#UsageRecord}

Specified by:

getResourceScope in interface UsageRecord

Returns:

The Accounting scope of the {#UsageRecord}

setResourceScope

public void setResourceScope(String scope)
                      throws InvalidValueException

Set the accounting scope of the {#UsageRecord}

Specified by:

setResourceScope in interface UsageRecord

Parameters:

scope - The accounting scope of the {#UsageRecord}

Throws:

InvalidValueException

getAggregatedUsageRecordId

public String getAggregatedUsageRecordId()

Return the id of the usage record aggregating this, null if this record has not been aggregated by any record.

Specified by:

getAggregatedUsageRecordId in interface UsageRecord

Returns:

Aggregated Id The ID of the aggregation Record

setAggregatedUsageRecordId

public void setAggregatedUsageRecordId(String aggregatedId)
                                throws InvalidValueException

Set the id of the usage record aggregating this

Specified by:

setAggregatedUsageRecordId in interface UsageRecord

Parameters:

aggregatedId - The ID of the aggregation Record

Throws:

InvalidValueException

getResourceProperties

public Map<String,Serializable> getResourceProperties()

Return all resource-specific properties. The returned Map is a copy of the internal representation. Any modification to the returned Map MUST not affect the object

Specified by:

getResourceProperties in interface UsageRecord

Returns:

a Map containing the properties

setResourceProperties

public void setResourceProperties(Map<String,Serializable> properties)
                           throws InvalidValueException

Set all resource-specific properties, replacing existing ones

Specified by:

setResourceProperties in interface UsageRecord

Throws:

InvalidValueException

getResourceProperty

public Serializable getResourceProperty(String key)

Return the value of the given resource property.

Specified by:

getResourceProperty in interface UsageRecord

Parameters:

key - the key of the requested property

Returns:

the value of the given resource property

setResourceProperty

public void setResourceProperty(String key,
                       Serializable value)
                         throws InvalidValueException

Set the value of the given resource property. If the key has the value of one of the predefined property, the value is validated.

Specified by:

setResourceProperty in interface UsageRecord

Parameters:

key - the key of the requested property

value - the value of the given resource property

Throws:

InvalidValueException

validateField

protected Serializable validateField(String key,
                         Serializable serializable)
                              throws InvalidValueException

Throws:

InvalidValueException

validateProperties

protected void validateProperties(Map<String,Serializable> properties)
                           throws InvalidValueException

Throws:

InvalidValueException

validate

public void validate()
              throws InvalidValueException

Validate the Resource Record

Specified by:

validate in interface UsageRecord

Throws:

InvalidValueException

toString

public String toString()

Overrides:

toString in class Object

getOperationResult

public UsageRecord.OperationResult getOperationResult()

Specified by:

getOperationResult in interface UsageRecord

Returns:

the Operation Result related to the accounted Usage Record

setOperationResult

public void setOperationResult(UsageRecord.OperationResult operationResult)
                        throws InvalidValueException

Set the Operation Result related to the accounted Usage Record

Specified by:

setOperationResult in interface UsageRecord

Parameters:

operationResult - the Operation Result to set

Throws:

InvalidValueException

compareTo

public int compareTo(UsageRecord usageRecord)

Compare this UsageRecord instance with the one provided as argument

Specified by:

compareTo in interface Comparable<UsageRecord>

Parameters:

usageRecord - the Usage Record to compare

Returns:

0 is and only if the UsageRecord provided as parameter contains all and ONLY the parameters contained in this instance. If the number of parameters differs, the methods return the difference between the number of parameter in this instance and the ones in the UsageRecord provided as parameter. If the size is the same but the UsageRecord provided as parameter does not contains all parameters in this instance, -1 is returned.

getClass

protected static Class<? extends UsageRecord> getClass(String usageRecordName,
                                    boolean aggregated)
                                                throws ClassNotFoundException

Throws:

ClassNotFoundException

getUsageRecord

public static UsageRecord getUsageRecord(Map<String,Serializable> usageRecordMap)
                                  throws Exception

This method use the resourceType value contained in the Map to instance the right UsageRecord class and return it. If the type implementation does not exist or the validation of one or more field validation fails an exception is thrown

Parameters:

usageRecordMap -

Returns:

the instance of the UsageRecord class.

Throws:

Exception - if fails