org.safs.persist

Class PersistorToXMLFile

java.lang.Object

org.safs.persist.AbstractRuntimeDataPersistor

org.safs.persist.PersistorToFile

org.safs.persist.PersistorToHierarchialFile

org.safs.persist.PersistorToXMLFile

All Implemented Interfaces:

Persistor

public class PersistorToXMLFile
extends PersistorToHierarchialFile

Write Persistable object to an XML file, 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	PersistorToXMLFile.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.PersistorToFile

filename, ignoredFieldsForUnpickle, persistFile, reader, writer

Fields inherited from class org.safs.persist.AbstractRuntimeDataPersistor

runtime

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
protected void	beforeUnpickle()
protected void	childBegin(java.lang.String key, java.lang.String value) This is called inside PersistorToHierarchialFile.write(Persistable) to write "key" and "value" of a child.
protected void	containerBegin(java.lang.String className) This is called inside PersistorToHierarchialFile.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 PersistorToHierarchialFile.write(Persistable) to write the end of a container such as: </tagNam> for XML file } for JSON file.
protected Persistable	doUnpickle()
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).

Methods inherited from class org.safs.persist.PersistorToHierarchialFile

childEnd, getTagName, parseFiledValue, write

Methods inherited from class org.safs.persist.PersistorToFile

equals, 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

Field Detail

saxParser

protected javax.xml.parsers.SAXParser saxParser

inputSource

protected org.xml.sax.InputSource inputSource

Constructor Detail

PersistorToXMLFile

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

Parameters:

runtime -

filename -

Method Detail

containerBegin

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

Description copied from class: PersistorToHierarchialFile

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

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

Overrides:

containerBegin in class PersistorToHierarchialFile

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

Description copied from class: PersistorToHierarchialFile

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

Overrides:

childBegin in class PersistorToHierarchialFile

Parameters:

key - String, the key name

value - String, the value

Throws:

java.io.IOException

containerEnd

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

Description copied from class: PersistorToHierarchialFile

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

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

Overrides:

containerEnd in class PersistorToHierarchialFile

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

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 PersistorToFile

Parameters:

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

Returns:

String, the escaped string

See Also:

PersistorToFile.stringNeedQuoted()

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