org.safs.persist

Class PersistorToHierarchialString

java.lang.Object

org.safs.persist.PersistableChecker

org.safs.persist.AbstractPersistor

org.safs.persist.PersistorToString

org.safs.persist.PersistorToHierarchialString

All Implemented Interfaces:

Persistor

Direct Known Subclasses:

PersistorToJSONString, PersistorToXMLString

public abstract class PersistorToHierarchialString
extends PersistorToString

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

Author:

Lei Wang

Field Summary

Fields

Modifier and Type	Field and Description
protected static java.lang.String	JSON_ARRAY_BRACKET_LEFT "[" the start bracket to wrap json array items
protected static java.lang.String	JSON_ARRAY_BRACKET_RIGHT "]" the end bracket to wrap the json array items
protected static java.lang.String	JSON_ARRAY_COMMA_SEP "," separator to separate the json array items

Fields inherited from class org.safs.persist.PersistorToString

ignoredFieldsForUnpickle, stringFormat, stringFormatReader

Constructor Summary

Constructors

Constructor and Description
PersistorToHierarchialString()
PersistorToHierarchialString(java.io.Reader stringFormatReader)
PersistorToHierarchialString(java.lang.String stringFormat)

Method Summary

Modifier and Type	Method and Description
protected abstract java.lang.String	getChildBegin(java.lang.String key, java.lang.String value, java.lang.String classname) This is called inside parse(Persistable, boolean) to write "key" and "value" of a child.
protected java.lang.String	getChildEnd(boolean lastChild) This is called inside parse(Persistable, boolean) to write the end of a child, here a newline "\n" is written.
protected abstract java.lang.String	getContainerBegin(java.lang.String className, boolean needLeadingName) This is called inside parse(Persistable, boolean) to write the begin of a container such as: <tagNam> for XML format "tagName" : {\n for JSON format
protected abstract java.lang.String	getContainerEnd(java.lang.String className) This is called inside parse(Persistable, boolean) 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	parse(Persistable persistable, boolean needLeadingNameForContainer) Convert a Persistable Object to a hierarchical string.
protected java.lang.String	parseArrayField(java.lang.Object arrayFieldObject)
protected java.lang.String	parseFieldValue(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 PersistorToString.escape(String) and double-quoted if needed.

Methods inherited from class org.safs.persist.PersistorToString

beforeUnpickle, doUnpickle, escape, getPersistenceName, getStringFormat, getStringFormatReader, getType, isIgnoredField, persist, setStringFormat, setStringFormatReader, stringNeedQuoted, unpersist, unpickle, write, writeHeader, writeTailer

Methods inherited from class org.safs.persist.PersistableChecker

validate

Methods inherited from class java.lang.Object

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

Field Detail

JSON_ARRAY_BRACKET_LEFT

protected static final java.lang.String JSON_ARRAY_BRACKET_LEFT

"[" the start bracket to wrap json array items

See Also:

Constant Field Values

JSON_ARRAY_BRACKET_RIGHT

protected static final java.lang.String JSON_ARRAY_BRACKET_RIGHT

"]" the end bracket to wrap the json array items

See Also:

Constant Field Values

JSON_ARRAY_COMMA_SEP

protected static final java.lang.String JSON_ARRAY_COMMA_SEP

"," separator to separate the json array items

See Also:

Constant Field Values

Constructor Detail

PersistorToHierarchialString

public PersistorToHierarchialString()

PersistorToHierarchialString

public PersistorToHierarchialString(java.lang.String stringFormat)

PersistorToHierarchialString

public PersistorToHierarchialString(java.io.Reader stringFormatReader)

Method Detail

parse

protected final java.lang.String parse(Persistable persistable,
                                       boolean needLeadingNameForContainer)
                                throws SAFSException

Convert a Persistable Object to a hierarchical string. The concrete format depends on the sub-class.

Specified by:

parse in class PersistorToString

Parameters:

persistable -

needLeadingNameForContainer -

Returns:

Throws:

SAFSException

getTagName

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

getContainerBegin

protected abstract java.lang.String getContainerBegin(java.lang.String className,
                                                      boolean needLeadingName)

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

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

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.

needLeadingName - boolean, if the leading tag name is needed. For example sometimes we don't need the "tagName" for JSON format.

Throws:

java.io.IOException

getChildBegin

protected abstract java.lang.String getChildBegin(java.lang.String key,
                                                  java.lang.String value,
                                                  java.lang.String classname)

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

Parameters:

key - String, the key name

value - String, the value

classname - String, the class name of this value. It is not useful with JSON format, but it is useful for XML format.

Throws:

java.io.IOException

getChildEnd

protected java.lang.String getChildEnd(boolean lastChild)

This is called inside parse(Persistable, boolean) 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

getContainerEnd

protected abstract java.lang.String getContainerEnd(java.lang.String className)

This is called inside parse(Persistable, boolean) 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

parseFieldValue

protected java.lang.String parseFieldValue(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 PersistorToString.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 Persistable object field's value

Returns:

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

Throws:

SAFSException

parseArrayField

protected java.lang.String parseArrayField(java.lang.Object arrayFieldObject)

Parameters:

arrayFieldObject - Object, it is the object represent an array field of a class

Returns:

String, the string format of an array object