org.safs.persist

Interface Persistor

All Known Implementing Classes:

AbstractPersistor, AbstractRuntimeDataPersistor, PersistorToFile, PersistorToFileDelegate, PersistorToHierarchialFile, PersistorToHierarchialString, PersistorToJSONFile, PersistorToJSONString, PersistorToPropertiesFile, PersistorToString, PersistorToVariable, PersistorToXMLFile, PersistorToXMLString

public interface Persistor

Provides the abilities to

• Persist a Persistable object to the persistence (a file, the variables etc.)
• Delete the persistence (a file, the variables etc.)
• Convert the contents stored in a persistence substance into a Persistable object.

Author:

Lei Wang

Method Summary

Modifier and Type	Method and Description
java.lang.String	getPersistenceName() The name of the persistence material holding the content of an Object. It can be a file name or a variable name etc. It could be useful when deleting the persistence.
PersistenceType	getType() The persistence Type.
void	persist(Persistable persistable) Persist a Persistable object.
void	unpersist() Delete the persistence (a file, the variables etc.)
Persistable	unpickle(java.util.Map<java.lang.String,java.util.List<java.lang.String>> ignoredFields) Convert the contents stored in a persistence substance into a Persistable object.

Method Detail

persist

void persist(Persistable persistable)
      throws SAFSException

Persist a Persistable object.

Parameters:

persistable - Persistable, the object to persist

Throws:

SAFSException - when persistence fails or something wrong happens.

unpersist

void unpersist()
        throws SAFSException

Delete the persistence (a file, the variables etc.)

Throws:

SAFSException - when failing to delete the persistence or something wrong happens.

unpickle

Persistable unpickle(java.util.Map<java.lang.String,java.util.List<java.lang.String>> ignoredFields)
              throws SAFSException

Convert the contents stored in a persistence substance into a Persistable object.

Parameters:

ignoredFields - Map<String, List<String>>, a Map containing the fields of each class to be ignored when un-pickling.

Returns:

Persistable, the Persistable object got from the persistence material.

Throws:

SAFSException

getType

PersistenceType getType()

The persistence Type.

Returns:

PersistenceType

getPersistenceName

java.lang.String getPersistenceName()

The name of the persistence material holding the content of an Object.
It can be a file name or a variable name etc.
It could be useful when deleting the persistence.

Returns:

String, The name of the persistence material, such as the file name or the variable name etc.

See Also:

unpersist()