org.qbroker.json

Class JSONTemplate

java.lang.Object

org.qbroker.common.AssetList

org.qbroker.json.JSONTemplate

public class JSONTemplate
extends AssetList

JSONTemaplte is a template that formats JSON data. It contains a simple template with parameters or varibales and a list of JSONSections. The parameter is a place holder with name spaces such as "s:" for section, "p:" for quoted text or "P:" for unquoted text. The values for "p:" or "P:" can be set via the method of setParameter() before the format operation. The other type of place holders is the variable with the name space of "v:" or "V:". It is actually a JSON path for retrieving the value from the JSON data. All the variables in the root level must be defined in a map with the name of "variable". It contains key-value pairs with the name of the variable as the key and the json path as the value. In the runtime, the values of the variables will be loaded as normal parameters before the operation. After the operation, they will be cleaned up.

JSONSection represents a portion of JSON data as the value in the template. It supports various operations on JSON data. Some of the operations allow to update the JSON data with override parameters. An override parameter has valid a JSON path as the name. Its value can be any non-null JSON object. It can be set via the method of setParameter() before the operation. A JSONTemplate may contain multiple well defined sections.

Author:

yannanlu@yahoo.com

Constructor Summary

Constructors

Constructor and Description
JSONTemplate(java.util.Map props)

Method Summary

Modifier and Type	Method and Description
void	clear()
void	clearParameter()
java.lang.String	copyText()
protected void	finalize()
java.lang.String	format(java.util.List json) returns the formatted JSON content on the given JSON data
java.lang.String	format(java.util.Map json) returns the formatted JSON content on the given JSON data
java.lang.Object	getParameter(java.lang.String key)
java.util.Iterator	iterator()
boolean	keepOriginalOrder() if this returns true, the json should be parsed with ordering support
static void	main(java.lang.String[] args)
void	setParameter(java.lang.String key, java.lang.Object value)

Methods inherited from class org.qbroker.common.AssetList

add, add, browser, containsKey, existsID, get, get, getCapacity, getID, getKey, getMetaData, getMetaData, getName, insert, isFull, queryIDs, remove, remove, replaceKey, rotate, set, set, size, swap

Methods inherited from class java.lang.Object

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

Constructor Detail

JSONTemplate

public JSONTemplate(java.util.Map props)

Method Detail

setParameter

public void setParameter(java.lang.String key,
                         java.lang.Object value)

getParameter

public java.lang.Object getParameter(java.lang.String key)

clearParameter

public void clearParameter()

iterator

public java.util.Iterator iterator()

copyText

public java.lang.String copyText()

keepOriginalOrder

public boolean keepOriginalOrder()

if this returns true, the json should be parsed with ordering support

format

public java.lang.String format(java.util.Map json)

returns the formatted JSON content on the given JSON data

format

public java.lang.String format(java.util.List json)

returns the formatted JSON content on the given JSON data

clear

public void clear()

Overrides:

clear in class AssetList

finalize

protected void finalize()

Overrides:

finalize in class AssetList

main

public static void main(java.lang.String[] args)