org.gcube.documentstore.records.implementation

Class AbstractRecord

java.lang.Object

org.gcube.documentstore.records.implementation.AbstractRecord

All Implemented Interfaces:

Serializable, Comparable<Record>, Record

Direct Known Subclasses:

BasicUsageRecord

public abstract class AbstractRecord
extends Object
implements Record

Author:

Luca Frosini (ISTI - CNR)

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractRecord()
AbstractRecord(Map<String,? extends Serializable> properties)

Method Summary

Modifier and Type	Method and Description
int	compareTo(Record record)
Set<String>	getAggregatedFields()
Set<String>	getComputedFields()
Calendar	getCreationTime() Return the instant when this Record was created.
String	getId() Return the unique id for this Record
SortedSet<String>	getQuerableKeys()
Set<String>	getRequiredFields()
Map<String,Serializable>	getResourceProperties() Return all resource-specific properties.
Serializable	getResourceProperty(String key) Return the value of the given resource property.
void	removeResourceProperty(String key) Remove a property from Record.
void	setCreationTime(Calendar creationTime) The CreationTime is automatically created by the implementation Class.
void	setId(String id) The ID SHOULD be automatically created by the implementation Class.
void	setResourceProperties(Map<String,? extends Serializable> properties) Set all resource-specific properties, replacing existing ones
void	setResourceProperty(String key, Serializable value) Set the value of the given resource property.
static Calendar	timestampToCalendar(long millis)
String	toString()
void	validate() Validate the Resource Record.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.gcube.documentstore.records.Record

getRecordType

Constructor Detail

AbstractRecord

public AbstractRecord()

AbstractRecord

public AbstractRecord(Map<String,? extends Serializable> properties)
               throws InvalidValueException

Throws:

InvalidValueException

Method Detail

getQuerableKeys

public SortedSet<String> getQuerableKeys()
                                  throws Exception

Specified by:

getQuerableKeys in interface Record

Returns:

Querable Keys as SortedSet

Throws:

Exception

getRequiredFields

public Set<String> getRequiredFields()

Specified by:

getRequiredFields in interface Record

Returns:

a Set containing the keys of required fields The returned Set MUST be a copy of the internal representation. Any modification to the returned Set MUST not affect the object

getComputedFields

public Set<String> getComputedFields()

Specified by:

getComputedFields in interface Record

Returns:

a Set containing the keys of computed fields The returned Set MUST be a copy of the internal representation. Any modification to the returned Set MUST not affect the object

getAggregatedFields

public Set<String> getAggregatedFields()

getId

public String getId()

Return the unique id for this Record

Specified by:

getId in interface Record

Returns:

Record Unique ID

setId

public void setId(String id)
           throws InvalidValueException

The ID SHOULD be automatically created by the implementation Class. Set the ID only if you really know what you are going to do. Set the unique id for this Record

Specified by:

setId in interface Record

Parameters:

id - Unique ID

Throws:

InvalidValueException

timestampToCalendar

public static Calendar timestampToCalendar(long millis)

getCreationTime

public Calendar getCreationTime()

Return the instant when this Record was created.

Specified by:

getCreationTime in interface Record

Returns:

the creation time for this Record

setCreationTime

public void setCreationTime(Calendar creationTime)
                     throws InvalidValueException

The CreationTime is automatically created by the implementation Class. Set the CreationTime only if you really know what you are going to do. Set the instant when this Record was created.

Specified by:

setCreationTime in interface Record

Parameters:

creationTime - Creation Time

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 Record

Returns:

a Map containing the properties

setResourceProperties

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

Set all resource-specific properties, replacing existing ones

Specified by:

setResourceProperties in interface Record

Throws:

InvalidValueException

getResourceProperty

public Serializable getResourceProperty(String key)

Return the value of the given resource property.

Specified by:

getResourceProperty in interface Record

Parameters:

key - the key of the requested property

Returns:

the value of the given resource property

removeResourceProperty

public void removeResourceProperty(String key)

Description copied from interface: Record

Remove a property from Record. This API is intended for intern use only.

Specified by:

removeResourceProperty in interface Record

Parameters:

key - the key of the requested property to remove

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 Record

Parameters:

key - the key of the requested property

value - the value of the given resource property

Throws:

InvalidValueException

validate

public void validate()
              throws InvalidValueException

Validate the Resource Record. The validation check if all the Required Field are set and has valid value.

Specified by:

validate in interface Record

Throws:

InvalidValueException

toString

public String toString()

Overrides:

toString in class Object

compareTo

public int compareTo(Record record)

Specified by:

compareTo in interface Comparable<Record>