org.safs.persist

Class PersistorToFile

java.lang.Object

org.safs.persist.PersistableChecker

org.safs.persist.AbstractPersistor

org.safs.persist.AbstractRuntimeDataPersistor

org.safs.persist.PersistorToFile

All Implemented Interfaces:

Persistor

Direct Known Subclasses:

PersistorToFileDelegate, PersistorToHierarchialFile, PersistorToPropertiesFile

public abstract class PersistorToFile
extends AbstractRuntimeDataPersistor

Author:

Lei Wang

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	filename The name of file to hold the information of a Persistable object.
protected java.util.Map<java.lang.String,java.util.List<java.lang.String>>	ignoredFieldsForUnpickle Holding the fields which are ignored for each class.
protected java.io.File	persistFile The file holds the information of a Persistable object.
protected java.io.Reader	reader The Reader object of the project file.
protected java.io.Writer	writer The Writer object of the test file.

Fields inherited from class org.safs.persist.AbstractRuntimeDataPersistor

runtime

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	PersistorToFile(RuntimeDataInterface runtime, java.lang.String filename)

Method Summary

Modifier and Type	Method and Description
protected void	beforeUnpickle()
protected Persistable	doUnpickle()
boolean	equals(java.lang.Object o) If they have the same filename, then we consider them equivalent
protected java.lang.String	escape(java.lang.String value) When writing a string to a file, some special characters MUST be escaped, such as new line "\n", "\r", "\r\n", or double quote ", or <?XML>...</XML> etc. What characters to escape and how to escape, these depend on the format of the persistence file, and the parser of the file.
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.
protected boolean	isIgnoredFiled(java.lang.String className, java.lang.String field) Check if the filed is being ignored at the moment for un-pickle.
void	persist(Persistable persistable) Persist a Persistable object.
protected boolean	stringNeedQuoted() If the string value needs to be quoted before writing into a kind of persistence. JSON file requires that for string value. In JSON file, For example: "key" : "stringValue" is good "key" : stringValue is bad
void	unpersist() Try to delete a persistence file in the test/bench folder.
Persistable	unpickle(java.util.Map<java.lang.String,java.util.List<java.lang.String>> ignoredFields) Provided default implementation, simply throw out a SAFSException.
protected abstract void	write(Persistable persistable) Write the Persistable object into a persistent material. writeHeader(Persistable) is called before writeTailer(Persistable) is called after
protected void	writeHeader(Persistable persistable) This is called before write(Persistable).
protected void	writeTailer(Persistable persistable) This is called after write(Persistable).

Methods inherited from class org.safs.persist.PersistableChecker

validate

Methods inherited from class java.lang.Object

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

Field Detail

filename

protected java.lang.String filename

The name of file to hold the information of a Persistable object.

persistFile

protected java.io.File persistFile

The file holds the information of a Persistable object.

writer

protected java.io.Writer writer

The Writer object of the test file. It is used to write Persistable object.

reader

protected java.io.Reader reader

The Reader object of the project file. Read content from it to construct/unpickle a Persistable object.

ignoredFieldsForUnpickle

protected java.util.Map<java.lang.String,java.util.List<java.lang.String>> ignoredFieldsForUnpickle

Holding the fields which are ignored for each class. No need to unpickle.
The field is expressed as a pair of (classname, a list of fields).

See Also:

#isIgnoredFiled(String)

Constructor Detail

PersistorToFile

protected PersistorToFile(RuntimeDataInterface runtime,
                          java.lang.String filename)

Method Detail

persist

public void persist(Persistable persistable)
             throws SAFSException

Description copied from interface: Persistor

Persist a Persistable object.

Specified by:

persist in interface Persistor

Overrides:

persist in class AbstractPersistor

Parameters:

persistable - Persistable, the object to persist

Throws:

SAFSException - when persistence fails or something wrong happens.

writeHeader

protected void writeHeader(Persistable persistable)
                    throws SAFSException,
                           java.io.IOException

This is called before write(Persistable).

Throws:

SAFSException

java.io.IOException

write

protected abstract void write(Persistable persistable)
                       throws SAFSException,
                              java.io.IOException

Write the Persistable object into a persistent material.
writeHeader(Persistable) is called before
writeTailer(Persistable) is called after

Throws:

SAFSException

java.io.IOException

writeTailer

protected void writeTailer(Persistable persistable)
                    throws SAFSException,
                           java.io.IOException

This is called after write(Persistable).

Throws:

SAFSException

java.io.IOException

stringNeedQuoted

protected boolean stringNeedQuoted()

If the string value needs to be quoted before writing into a kind of persistence.
JSON file requires that for string value.
In JSON file, For example:
"key" : "stringValue" is good
"key" : stringValue is bad

Returns:

boolean true if the value needs to be quoted before writing into persistence.

escape

protected java.lang.String escape(java.lang.String value)

When writing a string to a file, some special characters MUST be escaped, such as new line "\n", "\r", "\r\n", or double quote ", or <?XML>...</XML> etc.
What characters to escape and how to escape, these depend on the format of the persistence file, and the parser of the file. Subclass should override this method.
This method will also quote the value if stringNeedQuoted() returns true.

Parameters:

value - String, the value to escape.

Returns:

String, the escaped string

See Also:

stringNeedQuoted()

unpersist

public void unpersist()
               throws SAFSException

Try to delete a persistence file in the test/bench folder.

Specified by:

unpersist in interface Persistor

Overrides:

unpersist in class AbstractPersistor

Throws:

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

unpickle

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

Description copied from class: AbstractPersistor

Provided default implementation, simply throw out a SAFSException.

Specified by:

unpickle in interface Persistor

Overrides:

unpickle in class AbstractPersistor

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

beforeUnpickle

protected void beforeUnpickle()
                       throws SAFSException,
                              java.io.IOException

Throws:

SAFSException

java.io.IOException

doUnpickle

protected Persistable doUnpickle()
                          throws SAFSException,
                                 java.io.IOException

Throws:

SAFSException

java.io.IOException

isIgnoredFiled

protected boolean isIgnoredFiled(java.lang.String className,
                                 java.lang.String field)

Check if the filed is being ignored at the moment for un-pickle.

Parameters:

className - String, the className to check

field - String, the field to check

Returns:

boolean if this field is being ignored.

See Also:

ignoredFieldsForUnpickle

getType

public PersistenceType getType()

Description copied from interface: Persistor

The persistence Type.

Returns:

PersistenceType

getPersistenceName

public java.lang.String getPersistenceName()

Description copied from interface: Persistor

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:

Persistor.unpersist()

equals

public boolean equals(java.lang.Object o)

If they have the same filename, then we consider them equivalent

Overrides:

equals in class java.lang.Object