com.viaoa.util

Class OAJsonWriter

java.lang.Object

com.viaoa.util.OAJsonWriter

public class OAJsonWriter
extends Object

OAJsonWriter creates an JSON file that can then be read using an OAJsonReader.
If an object has already been stored in the file, then its key will be stored.

See Also:

OAJsonReader

Field Summary

Fields

Modifier and Type	Field and Description
protected Hashtable	hash
int	indent
int	indentAmount
protected PrintWriter	pw
protected StringWriter	sw

Constructor Summary

Constructors

Constructor and Description
OAJsonWriter()

Method Summary

Modifier and Type	Method and Description
String	convertToString(String property, Object value) Method that can be overwritten to provide custom conversion to String.
void	excludePropertyPath(String propertyPath)
boolean	getCompress()
protected String	getCurrentPath() Current propertyPath from the root OAObject.
void	includeManyReferences(boolean b)
void	includeOneReferences(boolean b)
void	includePropertyPath(String propertyPath)
void	indent()
void	popReference()
void	print(String line)
void	printCDATA(String line) encloses line in XML CDATA tag and internally encodes illegal XML characters
void	printJson(String line) converts XML codes and encodes illegal XML characters
void	println(String line)
void	pushReference(String name)
protected void	reset()
void	setCompress(boolean b)
boolean	shouldIncludeProperty(Object obj, String propertyName, Object value, OAPropertyInfo pi, OALinkInfo li) called by OAObject.write to know if object should be written for a property that references another OAObject.
String	write(Hub hub) saves Hub as JSON
String	write(OAObject obj) saves OAObject as JSON
void	writing(Object obj) hook used to know when an object is being saved.

Methods inherited from class java.lang.Object

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

Field Detail

pw

protected PrintWriter pw

sw

protected StringWriter sw

indent

public int indent

indentAmount

public int indentAmount

hash

protected Hashtable hash

Constructor Detail

OAJsonWriter

public OAJsonWriter()

Method Detail

setCompress

public void setCompress(boolean b)

getCompress

public boolean getCompress()

write

public String write(OAObject obj)

saves OAObject as JSON

write

public String write(Hub hub)

saves Hub as JSON

reset

protected void reset()

shouldIncludeProperty

public boolean shouldIncludeProperty(Object obj,
                                     String propertyName,
                                     Object value,
                                     OAPropertyInfo pi,
                                     OALinkInfo li)

called by OAObject.write to know if object should be written for a property that references another OAObject. This can be overwritten to control which properties are saved. default is true;

getCurrentPath

protected String getCurrentPath()

Current propertyPath from the root OAObject. Only includes reference/link names, no regular properties

pushReference

public void pushReference(String name)

popReference

public void popReference()

includeOneReferences

public void includeOneReferences(boolean b)

includeManyReferences

public void includeManyReferences(boolean b)

includePropertyPath

public void includePropertyPath(String propertyPath)

excludePropertyPath

public void excludePropertyPath(String propertyPath)

writing

public void writing(Object obj)

hook used to know when an object is being saved.

printCDATA

public void printCDATA(String line)

encloses line in XML CDATA tag and internally encodes illegal XML characters

printJson

public void printJson(String line)

converts XML codes and encodes illegal XML characters

print

public void print(String line)

println

public void println(String line)

indent

public void indent()

convertToString

public String convertToString(String property,
                              Object value)

Method that can be overwritten to provide custom conversion to String. Called to convert a value to a String when there does not exist an OAConverter for a class.

Returns:

null to skip property.