org.safs.persist

Interface Persistable

All Known Implementing Classes:

AuthorizationServer, AutoItRs.Control, AutoItRs.DefaultRecognizable, AutoItRs.DefaultRecognizableAutoIt, AutoItRs.Window, Content, OAuth2, PersistableDefault, PersistTest.MyPersistable, Request, Response, SimpleAuth

public interface Persistable

Represent an object that can be persisted.

Author:

Lei Wang

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CONTAINER_ELEMENT "CONTAINER_ELEMENT", The general key name representing the container element.

Method Summary

Modifier and Type	Method and Description
java.util.Map<java.lang.String,java.lang.Object>	getContents()
java.util.Map<java.lang.String,java.lang.Object>	getContents(java.util.Map<java.lang.String,java.lang.String> elementAlternativeValues, java.util.Set<java.lang.String> ignoredFields, boolean includeContainer) Turn the Persistable hierarchical contents Map (getContents()) into a flat-key Map.
java.lang.Object	getField(java.lang.String persistKey) Get the field's value of this Persistable object according to the persist-key. The field name can be got from getPersitableFields() according to the persist-key, then the value will be got of that field.
java.lang.String	getFlatKey() A Persistable object can contain other Persistable objects, it is an hierarchical structure.
Persistable	getParent()
java.util.Map<java.lang.String,java.lang.String>	getPersitableFields() This Map contains a pair, the key is the 'class field name' telling us which field needs to be persisted; the value is a 'unique string' representing this class field in the persistence.
boolean	isEnabled() Tell us if this object will be persisted or not.
void	setEnabled(boolean enabled) Sometimes, we don't want to persist an object, we disable it.
boolean	setField(java.lang.String persistKey, java.lang.Object value) Set the field's value of this Persistable object to the persist-key. The field name can be got from getPersitableFields() according to the persist-key, then the value will be set to that field.
void	setParent(Persistable parent) Persistable object can contain Persistable object to form a tree-like structure. When defining a Persistable class, it is important to this method in the setter of Persistable-field to make sure that the Persistor and Verifier can work correctly.

Field Detail

CONTAINER_ELEMENT

static final java.lang.String CONTAINER_ELEMENT

"CONTAINER_ELEMENT", The general key name representing the container element. The the container element is like Response in XML

 <Response>
   <StatusCode>200</StatusCode>
 </Response>
 

See Also:

Constant Field Values

Method Detail

getContents

java.util.Map<java.lang.String,java.lang.Object> getContents()

Returns:

Map, a Map containing a pair(persistKey, fieldValue) to persist.

getPersitableFields

java.util.Map<java.lang.String,java.lang.String> getPersitableFields()

This Map contains a pair, the key is the 'class field name' telling us which field needs to be persisted; the value is a 'unique string' representing this class field in the persistence. The 'class field name' and the 'persist key' can be same or different.
When persisting a class, not all the fields need to be persisted; Only those fields which need to be persisted will be put into this Map.

Returns:

Map, a Map containing a pair(fieldName, persistKey) to persist.

isEnabled

boolean isEnabled()

Tell us if this object will be persisted or not.

Returns:

boolean, if true, this object will be persisted; otherwise, will not.

setEnabled

void setEnabled(boolean enabled)

Sometimes, we don't want to persist an object, we disable it.

Parameters:

enabled - boolean, if true, this object will be persisted; otherwise, will not.

setParent

void setParent(Persistable parent)

Persistable object can contain Persistable object to form a tree-like structure.
When defining a Persistable class, it is important to this method in the setter of Persistable-field to make sure that the Persistor and Verifier can work correctly.

Parameters:

parent - Persistable,

getParent

Persistable getParent()

Returns:

Persistable, the parent Persistable object; null if it doesn't have.

getFlatKey

java.lang.String getFlatKey()

A Persistable object can contain other Persistable objects, it is an hierarchical structure. This flat-key is supposed to represent each Persistable object uniquely.

Returns:

String, the flat key representing this Persistable object.

See Also:

#getContents(Map, Set)

getContents

java.util.Map<java.lang.String,java.lang.Object> getContents(java.util.Map<java.lang.String,java.lang.String> elementAlternativeValues,
                                                             java.util.Set<java.lang.String> ignoredFields,
                                                             boolean includeContainer)

Turn the Persistable hierarchical contents Map (getContents()) into a flat-key Map.

Parameters:

elementAlternativeValues - Map,in, contains pairs(elementName, alternativeValue), which will be used to set the value for a certain element.

ignoredFields - Set, out, it will hold the fields (of Persistable and its children) to be ignored. This Set should be initialized an provided from outside. The field is expressed as a flat key

 If this Set contains a field 'Response.Request', then all its children will
 be ignored, such as:
 Response.Request.Headers
 Response.Request.MessageBody
 ...
 

includeContainer - boolean, in, if the Persistable Object itself should be considered as part of the whole contents.
For example, if we have a Persistable Response object, it contains some fields as its contents, these fields could be Response.Headers, Response.ID etc. But does "Response" itself should be put into the contents Map as a key? The answer depends on the needs.

Returns:

Map, the actual contents of Persistable and those of its children. They are pairs of (flatKey, content) such as

 (Response.ID, "FFE3543545JLFS")
 (Response.Headers, "{Date=Tue, 06 DEC 2016 03:08:12 GMT}")
 (Response.Request.Headers, "{Content-Length=4574, Via=1.1 inetgw38 (squid)}")
 

setField

boolean setField(java.lang.String persistKey,
                 java.lang.Object value)

Set the field's value of this Persistable object to the persist-key.
The field name can be got from getPersitableFields() according to the persist-key, then the value will be set to that field.

Parameters:

persistKey - String, the persist-key (it can be tag-name in XML, key-string in JSON etc.). refer to getPersitableFields().

value - Object, the value to set

Returns:

boolean true if successful.

getField

java.lang.Object getField(java.lang.String persistKey)

Get the field's value of this Persistable object according to the persist-key.
The field name can be got from getPersitableFields() according to the persist-key, then the value will be got of that field.

Parameters:

persistKey - String, the persist-key (it can be tag-name in XML, key-string in JSON etc.). refer to getPersitableFields().

value - Object, the value of the field pointing by persistKey.