org.safs.persist

Class PersistorToFileDelegate

java.lang.Object

org.safs.persist.PersistableChecker

org.safs.persist.AbstractPersistor

org.safs.persist.AbstractRuntimeDataPersistor

org.safs.persist.PersistorToFile

org.safs.persist.PersistorToFileDelegate

All Implemented Interfaces:

Persistor

Direct Known Subclasses:

PersistorToJSONFile, PersistorToXMLFile

public abstract class PersistorToFileDelegate
extends PersistorToFile

Write Persistable object to a file, but it will delegate the job to a sub-class of PersistorToString to get back the string format of the Persistable object, then it will write that string into the file.

Author:

Lei Wang

Field Summary

Fields

Modifier and Type	Field and Description
(package private) PersistorToString	delegatePersistor The delegate string persistor.

Fields inherited from class org.safs.persist.PersistorToFile

filename, ignoredFieldsForUnpickle, persistFile, reader, writer

Fields inherited from class org.safs.persist.AbstractRuntimeDataPersistor

runtime

Constructor Summary

Constructors

Constructor and Description
PersistorToFileDelegate(RuntimeDataInterface runtime, java.lang.String filename)

Method Summary

Modifier and Type	Method and Description
protected void	beforeUnpickle()
protected Persistable	doUnpickle()
protected abstract void	instantiateDelegatePersitor() Instantiate a concrete PersistorToString.
Persistable	unpickle(java.util.Map<java.lang.String,java.util.List<java.lang.String>> ignoredFields) Provided default implementation, simply throw out a SAFSException.
protected void	write(Persistable persistable) Write the Persistable object into a persistent material. PersistorToFile.writeHeader(Persistable) is called before PersistorToFile.writeTailer(Persistable) is called after

Methods inherited from class org.safs.persist.PersistorToFile

equals, escape, getPersistenceName, getType, isIgnoredFiled, persist, stringNeedQuoted, unpersist, writeHeader, writeTailer

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

delegatePersistor

PersistorToString delegatePersistor

The delegate string persistor.

Constructor Detail

PersistorToFileDelegate

public PersistorToFileDelegate(RuntimeDataInterface runtime,
                               java.lang.String filename)

Parameters:

runtime -

filename -

Method Detail

instantiateDelegatePersitor

protected abstract void instantiateDelegatePersitor()

Instantiate a concrete PersistorToString. It will be called in the constructor PersistorToFileDelegate(RuntimeDataInterface, String).

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 PersistorToFile

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

Overrides:

beforeUnpickle in class PersistorToFile

Throws:

SAFSException

java.io.IOException

doUnpickle

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

Overrides:

doUnpickle in class PersistorToFile

Throws:

SAFSException

java.io.IOException

write

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

Description copied from class: PersistorToFile

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

Specified by:

write in class PersistorToFile

Throws:

SAFSException

java.io.IOException