ch.gbrain.gwtstorage.model

Class StorageItem

java.lang.Object

ch.gbrain.gwtstorage.model.StorageItem

public abstract class StorageItem
extends Object

The main parent class for any object that must be stored locally or remote By defining the abstract converter methods for your particular inherited object the object is available for simple storage by the StorageManager

Constructor Summary

Constructors

Constructor and Description
StorageItem()

Method Summary

Methods

Modifier and Type	Method and Description
abstract void	fromJson(com.google.gwt.json.client.JSONValue json) Used to convert the JSONValue object (as stored in local and remote storage) back to the object itself.
void	fromJson(StorageItem storageItem) Convenience method to read the attributes of the StorageItem in and assign them internally from a Json read object which is inherited from StrorageItem
void	fromJson(String jsonString) Converts back from a json string to the object itself
String	getId()
String	getJsonFileName()
String	getLogId() Retrieve a unique key to identify StorageItems for log entries
String	getStorageItemIdKey() Retrieve a unique key to identify StorageItems in a key/value storage
String	getStorageItemTimeKey() Retrieve a unique key to identify StorageItems Save Time in a key/value storage
String	getTypeName()
Integer	getVersion()
static boolean	isStorageItemIdKey(String key)
static boolean	isStorageItemKey(String key)
static boolean	isStorageItemTimeKey(String key)
void	setId(String id)
void	setVersion(Integer version)
abstract com.google.gwt.json.client.JSONValue	toJson() Used to convert the object value to a JsonValue.
String	toString() Retrieves the current object state as stringified JSON value

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageItem

public StorageItem()

Method Detail

setId

public void setId(String id)

getId

public String getId()

getStorageItemIdKey

public String getStorageItemIdKey()

Retrieve a unique key to identify StorageItems in a key/value storage

Returns:

Retrieve a unique key for this storage item instance. Build from a prefix + object-type-name + id

getStorageItemTimeKey

public String getStorageItemTimeKey()

Retrieve a unique key to identify StorageItems Save Time in a key/value storage

Returns:

Retrieve a unique key for this storage item to store the time information. Based on the StorageItemKey + a suffix

isStorageItemKey

public static boolean isStorageItemKey(String key)

isStorageItemIdKey

public static boolean isStorageItemIdKey(String key)

isStorageItemTimeKey

public static boolean isStorageItemTimeKey(String key)

getLogId

public String getLogId()

Retrieve a unique key to identify StorageItems for log entries

Returns:

setVersion

public void setVersion(Integer version)

getVersion

public Integer getVersion()

getTypeName

public String getTypeName()

getJsonFileName

public String getJsonFileName()

toJson

public abstract com.google.gwt.json.client.JSONValue toJson()

Used to convert the object value to a JsonValue. This will be used to store the object in the local and remote storage.

Returns:

fromJson

public abstract void fromJson(com.google.gwt.json.client.JSONValue json)

Used to convert the JSONValue object (as stored in local and remote storage) back to the object itself.

Parameters:

storedItem - The value which was stored in the LocalStore and should be transformed back into the object.

fromJson

public final void fromJson(StorageItem storageItem)

Convenience method to read the attributes of the StorageItem in and assign them internally from a Json read object which is inherited from StrorageItem

Parameters:

storageItem - The item from which the values must be read and assign

fromJson

public void fromJson(String jsonString)

Converts back from a json string to the object itself

Parameters:

jsonString -

toString

public String toString()

Retrieves the current object state as stringified JSON value

Overrides:

toString in class Object

Returns:

The current objects state as JSON String