org.safs.persist

Class PersistorToHierarchialFile

java.lang.Object

org.safs.persist.AbstractRuntimeDataPersistor

org.safs.persist.PersistorToFile

org.safs.persist.PersistorToHierarchialFile

All Implemented Interfaces:

Persistor

Direct Known Subclasses:

PersistorToJSONFile, PersistorToXMLFile

public class PersistorToHierarchialFile
extends PersistorToFile

Write the Persistable object to a persistence of hierarchical structure, such as JSON, XML file.

Author:

Lei Wang

Field Summary

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
PersistorToHierarchialFile(RuntimeDataInterface runtime, java.lang.String filename)

Method Summary

Modifier and Type	Method and Description
protected void	childBegin(java.lang.String key, java.lang.String value) This is called inside write(Persistable) to write "key" and "value" of a child.
protected void	childEnd(boolean lastChild) This is called inside write(Persistable) to write the end of a child, here a newline "\n" is written.
protected void	containerBegin(java.lang.String className) This is called inside write(Persistable) to write the begin of a container such as: <tagNam> for XML file "tagName" : {\n for JSON file
protected void	containerEnd(java.lang.String className) This is called inside write(Persistable) to write the end of a container such as: </tagNam> for XML file } for JSON file.
protected java.lang.String	getTagName(java.lang.String className)
protected java.lang.String	parseFiledValue(java.lang.Object value) Parse the parameter value and convert it to a string which will be persisted to (File or Variable or ...) The following are the ways to parse value: The String value will be PersistorToFile.escape(String) and double-quoted if needed.
protected void	write(Persistable persistable) Write the Persistable object to a persistence of hierarchical structure, such as JSON, XML file. This is a template method, it is calling the method below: containerBegin(String) childBegin(String, String) childEnd(boolean) containerEnd(String)

Methods inherited from class org.safs.persist.PersistorToFile

beforeUnpickle, doUnpickle, equals, escape, getPersistenceName, getType, isIgnoredFiled, persist, stringNeedQuoted, unpersist, unpickle, writeHeader, writeTailer

Methods inherited from class org.safs.persist.AbstractRuntimeDataPersistor

validate

Methods inherited from class java.lang.Object

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

Constructor Detail

PersistorToHierarchialFile

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

Method Detail

write

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

Write the Persistable object to a persistence of hierarchical structure, such as JSON, XML file.
This is a template method, it is calling the method below:

1. containerBegin(String)
2. childBegin(String, String)
3. childEnd(boolean)
4. containerEnd(String)

Specified by:

write in class PersistorToFile

Parameters:

persistable - Persistable, the object to persist

Throws:

SAFSException

java.io.IOException

getTagName

protected java.lang.String getTagName(java.lang.String className)

containerBegin

protected void containerBegin(java.lang.String className)
                       throws java.io.IOException

This is called inside write(Persistable) to write the begin of a container such as:

• <tagNam> for XML file
• "tagName" : {\n for JSON file

Parameters:

className - String, the class name of a container. This is a full class-name, which may needs to treated to get the simple class name as the tag-name.

Throws:

java.io.IOException

childBegin

protected void childBegin(java.lang.String key,
                          java.lang.String value)
                   throws java.io.IOException

This is called inside write(Persistable) to write "key" and "value" of a child.

Parameters:

key - String, the key name

value - String, the value

Throws:

java.io.IOException

parseFiledValue

protected java.lang.String parseFiledValue(java.lang.Object value)

Parse the parameter value and convert it to a string which will be persisted to (File or Variable or ...)
The following are the ways to parse value:

• The String value will be PersistorToFile.escape(String) and double-quoted if needed.
• The array value will be transformed into [item1, item2, item3]
• The Number value will be returned as string without quote.

Parameters:

value - Object, the filed's value

Returns:

String, the parsed result of the field's value
null if the parameter 'value' is null.

Throws:

SAFSException

childEnd

protected void childEnd(boolean lastChild)
                 throws java.io.IOException

This is called inside write(Persistable) to write the end of a child, here a newline "\n" is written.

Parameters:

lastChild - boolean, if this is the last child within the container. it is useful for some file format, such as JSON, if this is false (not the last child), a comma , needs to be added at the end as "key" : "value" ,

Throws:

java.io.IOException

containerEnd

protected void containerEnd(java.lang.String className)
                     throws java.io.IOException

This is called inside write(Persistable) to write the end of a container such as:

• </tagNam> for XML file
• } for JSON file.
  

Parameters:

className - String, the tag name, it is normally a container. This is a full class-name, which may needs to treated to get the simple class name as the tag-name.

Throws:

java.io.IOException