org.safs.persist

Class PersistorToXMLString

java.lang.Object

org.safs.persist.PersistableChecker

org.safs.persist.AbstractPersistor

org.safs.persist.PersistorToString

org.safs.persist.PersistorToHierarchialString

org.safs.persist.PersistorToXMLString

All Implemented Interfaces:

Persistor

public class PersistorToXMLString
extends PersistorToHierarchialString

Write Persistable object to an XML string, such as:

 <Response classname="org.safs.rest.Response">
   <StatusCode>200</StatusCode>
   <Headers>{Date=Tue, 13 Dec 2016 03:29:27 GMT, Content-Length=4574, Connection=keep-alive, Content-Type=application/xml}</Headers>
   <EntityBody><![CDATA[<?xml version="1.0"?><CUSTOMERList xmlns:xlink="http://www.w3.org/1999/xlink">
     <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/0/">0</CUSTOMER>
     <CUSTOMER xlink:href="http://www.thomas-bayer.com/sqlrest/CUSTOMER/49/">49</CUSTOMER>
     </CUSTOMERList>]]></EntityBody>
   <Request classname="org.safs.rest.Request">
     <Method>GET</Method>
     <Headers>
       Content-Type:application/octet-stream, Accept:application/octet-stream
     </Headers>
   </Request>
 </Response>
 

NOTE: Be careful with the value starting with <?xml, which should be wrapped as <![CDATA[...]]>, as shown in the example above. For other special symbols to be escaped, please refer to Constants.XMLConstants.SYMBOL_TO_ESCAPE.

Author:

Lei Wang

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	PersistorToXMLString.UnpickleHandler

Field Summary

Fields

Modifier and Type	Field and Description
protected org.xml.sax.InputSource	inputSource
protected javax.xml.parsers.SAXParser	saxParser

Fields inherited from class org.safs.persist.PersistorToHierarchialString

JSON_ARRAY_BRACKET_LEFT, JSON_ARRAY_BRACKET_RIGHT, JSON_ARRAY_COMMA_SEP

Fields inherited from class org.safs.persist.PersistorToString

ignoredFieldsForUnpickle, stringFormat, stringFormatReader

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	beforeUnpickle() Prepare the parser with the string format of a Persistable object.
protected Persistable	doUnpickle() Convert the string format of a Persistable object to Persistable object.
protected java.lang.String	escape(java.lang.String value) Wrap the string in "" if it contains special symbols Constants.XMLConstants.SYMBOL_TO_ESCAPE, please refer to #needEscape(String).
protected java.lang.String	getChildBegin(java.lang.String key, java.lang.String value, java.lang.String classname) This is called inside PersistorToHierarchialString.parse(Persistable, boolean) to write "key" and "value" of a child.
protected java.lang.String	getContainerBegin(java.lang.String className, boolean needLeadingName) This is called inside PersistorToHierarchialString.parse(Persistable, boolean) to write the begin of a container such as: <tagNam> for XML format "tagName" : {\n for JSON format
protected java.lang.String	getContainerEnd(java.lang.String className) This is called inside PersistorToHierarchialString.parse(Persistable, boolean) to write the end of a container such as: </tagNam> for XML file } for JSON file.

Methods inherited from class org.safs.persist.PersistorToHierarchialString

getChildEnd, getTagName, parse, parseArrayField, parseFieldValue

Methods inherited from class org.safs.persist.PersistorToString

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

saxParser

protected javax.xml.parsers.SAXParser saxParser

inputSource

protected org.xml.sax.InputSource inputSource

Constructor Detail

PersistorToXMLString

public PersistorToXMLString()

PersistorToXMLString

public PersistorToXMLString(java.lang.String stringFormat)

PersistorToXMLString

public PersistorToXMLString(java.io.Reader stringFormatReader)

Method Detail

getContainerBegin

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

Description copied from class: PersistorToHierarchialString

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

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

Specified by:

getContainerBegin in class PersistorToHierarchialString

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.

getChildBegin

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

Description copied from class: PersistorToHierarchialString

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

Specified by:

getChildBegin in class PersistorToHierarchialString

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.

getContainerEnd

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

Description copied from class: PersistorToHierarchialString

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

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

Specified by:

getContainerEnd in class PersistorToHierarchialString

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.

escape

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

Wrap the string in "" if it contains special symbols Constants.XMLConstants.SYMBOL_TO_ESCAPE, please refer to #needEscape(String).

Overrides:

escape in class PersistorToString

Parameters:

value - String, the value to be escaped if it contains special symbols

Returns:

String, the escaped string

See Also:

PersistorToString.stringNeedQuoted()

beforeUnpickle

protected void beforeUnpickle()
                       throws SAFSException

Description copied from class: PersistorToString

Prepare the parser with the string format of a Persistable object.

Overrides:

beforeUnpickle in class PersistorToString

Throws:

SAFSException

doUnpickle

protected Persistable doUnpickle()
                          throws SAFSException

Description copied from class: PersistorToString

Convert the string format of a Persistable object to Persistable object.

Overrides:

doUnpickle in class PersistorToString

Returns:

Persistable, the Persistable object.

Throws:

SAFSException