Package com.storedobject.core

Class JSON

java.lang.Object

com.storedobject.common.JSON

com.storedobject.core.JSON

public class JSON
extends JSON

Extended JSON class with more extract methods for the core-specific attribute types.

Author:

Syam

Nested Class Summary

Nested classes/interfaces inherited from class com.storedobject.common.JSON

JSON.Type

Field Summary

Fields

Modifier and Type	Field	Description
static final String	DATE_FORMAT	ISO 8601 date format string.
static final String	DATE_TIME_FORMAT	ISO 8601 date-time (timestamp) format string.
static final String	TIME_FORMAT	ISO 8601 time format string.

Constructor Summary

Constructors

Constructor	Description
JSON()	Construct an empty JSON.
JSON(Object object)	Construct a JSON instance from an Object that could hopefully parse into a JSON compatible String.

Method Summary

Modifier and Type	Method	Description
JSON	get(int n)	Get the value at position 'n' assuming that this is an array.
JSON	get(String key)	Get the value for the given key.
JSON	get(String key, int n)	Retrieve the value for the given key and get the value from the given position from that value, assuming that value is an array type.
Account	getAccount(String attribute)	Helper method to retrieve an Account instance from the JSON request.
BigDecimal	getBigDecimal(String attribute)	Helper method to retrieve a BigDecimal value from the JSON request.
ComputedDate	getComputedDate(String attribute)	Helper method to retrieve a ComputedDate value from the JSON request.
ComputedDouble	getComputedDouble(String attribute)	Helper method to retrieve a ComputedDouble value from the JSON request.
ComputedInteger	getComputedInteger(String attribute)	Helper method to retrieve a ComputedInteger value from the JSON request.
ComputedLong	getComputedLong(String attribute)	Helper method to retrieve a ComputedLong value from the JSON request.
ComputedMinute	getComputedMinute(String attribute)	Helper method to retrieve a ComputedMinute value from the JSON request.
Class<? extends StoredObject>	getDataClass(String attribute)	Helper method to retrieve a StoredObject class value from the JSON request.
Date	getDate()	Helper method to retrieve a date value from the JSON request assuming that the attribute name is "date".
Date	getDate(String attribute)	Helper method to retrieve a date value from the JSON request.
DatePeriod	getDatePeriod()	Helper method to retrieve a DatePeriod value from the JSON request assuming that "dateFrom" and "dateTo" are the names of the attributes.
Double	getDouble(String attribute)	Helper method to retrieve a Double value from the JSON request.
Id	getId(String attribute)	Helper method to retrieve a Id from the JSON request.
Integer	getInteger(String attribute)	Helper method to retrieve a Integer value from the JSON request.
Long	getLong(String attribute)	Helper method to retrieve a Long value from the JSON request.
Money	getMoney(String attribute)	Helper method to retrieve a monetary value from the JSON request.
Quantity	getQuantity(String attribute)	Helper method to retrieve a quantity value from the JSON request.
StringList	getStringList(String attribute)	Helper method to retrieve a StringList from the JSON request.
Time	getTime(String attribute)	Helper method to retrieve a time value from the JSON request.
Timestamp	getTimestamp(String attribute)	Helper method to retrieve a timestamp value from the JSON request.

Methods inherited from class com.storedobject.common.JSON

containsKey, create, create, encode, fromJSS, getArraySize, getBoolean, getBoolean, getBoolean, getDecimal, getDecimal, getDecimal, getNumber, getNumber, getNumber, getString, getString, getString, getType, isNull, keys, parseJSS, prettyWrite, set, toMap, toPrettyString, toPrettyString, toString, toString, write

Methods inherited from class java.lang.Object

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

Field Details

DATE_FORMAT

public static final String DATE_FORMAT

ISO 8601 date format string.

See Also:

• Constant Field Values

DATE_TIME_FORMAT

public static final String DATE_TIME_FORMAT

ISO 8601 date-time (timestamp) format string.

See Also:

• Constant Field Values

TIME_FORMAT

public static final String TIME_FORMAT

ISO 8601 time format string.

See Also:

• Constant Field Values

Constructor Details

JSON

public JSON()

Construct an empty JSON.

JSON

public JSON(Object object)

Construct a JSON instance from an Object that could hopefully parse into a JSON compatible String. Typically, it could be a Map or some sort of array or collection. It could also be a standalone object that can be converted to a valid JSON string. Otherwise, the following types are handled as special cases: (1) A JsonNode instance - directly set internally, (2) Another JSON instance - directly set internally, (3) An InputStream instance - expects a string value from the stream, (4) An instance of a Reader - expects a string value from it, (5) A URL instance - content from the URL is read and processed.

Parameters:

object - JSON to construct from this Object.

Method Details

get

public JSON get(int n)

Description copied from class: JSON

Get the value at position 'n' assuming that this is an array. Null will be returned if this is null, not an array or position is outside the range.

Overrides:

get in class JSON

Parameters:

n - Position.

Returns:

Value at the position.

get

public JSON get(String key)

Description copied from class: JSON

Get the value for the given key. Null will be returned if this is null, key is null or no value exists for the given key.

Overrides:

get in class JSON

Parameters:

key - Key.

Returns:

Value for the key.

get

public JSON get(String key,
 int n)

Description copied from class: JSON

Retrieve the value for the given key and get the value from the given position from that value, assuming that value is an array type. Null will be returned if this is null, key is null, no value exists for the given key, the value type is not an array or nothing found at the given position.

Overrides:

get in class JSON

Parameters:

key - Key.

n - Position.

Returns:

Value for the key.

getDate

public Date getDate(String attribute)

Helper method to retrieve a date value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

Date if found, otherwise null.

getDate

public Date getDate()

Helper method to retrieve a date value from the JSON request assuming that the attribute name is "date".

Returns:

Date if found, otherwise null.

getTimestamp

public Timestamp getTimestamp(String attribute)

Helper method to retrieve a timestamp value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

Timestamp if found, otherwise null.

getTime

public Time getTime(String attribute)

Helper method to retrieve a time value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

Time if found, otherwise null.

getId

public Id getId(String attribute)

Helper method to retrieve a Id from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

Id if found, otherwise null.

getQuantity

public Quantity getQuantity(String attribute)

Helper method to retrieve a quantity value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

Quantity if found, otherwise null.

getMoney

public Money getMoney(String attribute)

Helper method to retrieve a monetary value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

Money if found, otherwise null.

getComputedDate

public ComputedDate getComputedDate(String attribute)

Helper method to retrieve a ComputedDate value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

ComputedDate value if found, otherwise null.

getComputedMinute

public ComputedMinute getComputedMinute(String attribute)

Helper method to retrieve a ComputedMinute value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

ComputedMinute value if found, otherwise null.

getComputedDouble

public ComputedDouble getComputedDouble(String attribute)

Helper method to retrieve a ComputedDouble value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

ComputedDouble value if found, otherwise null.

getComputedInteger

public ComputedInteger getComputedInteger(String attribute)

Helper method to retrieve a ComputedInteger value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

ComputedInteger value if found, otherwise null.

getComputedLong

public ComputedLong getComputedLong(String attribute)

Helper method to retrieve a ComputedLong value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

ComputedLong value if found, otherwise null.

getInteger

public Integer getInteger(String attribute)

Helper method to retrieve a Integer value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

Integer value if found, otherwise null.

getLong

public Long getLong(String attribute)

Helper method to retrieve a Long value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

Long value if found, otherwise null.

getDouble

public Double getDouble(String attribute)

Helper method to retrieve a Double value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

Double value if found, otherwise null.

getBigDecimal

public BigDecimal getBigDecimal(String attribute)

Helper method to retrieve a BigDecimal value from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

BigDecimal value if found, otherwise null.

getStringList

public StringList getStringList(String attribute)

Helper method to retrieve a StringList from the JSON request.

Parameters:

attribute - Attribute name.

Returns:

StringList if found, otherwise null.

getDatePeriod

public DatePeriod getDatePeriod()

Helper method to retrieve a DatePeriod value from the JSON request assuming that "dateFrom" and "dateTo" are the names of the attributes.

Returns:

BigDecimal value if found, otherwise null.

getDataClass

public Class<? extends StoredObject> getDataClass(String attribute)
                                           throws Exception

Helper method to retrieve a StoredObject class value from the JSON request.

Returns:

StoredObject class value if found, otherwise an exception is raised.

Throws:

Exception - is thrown if class name can't be extracted or the name is invalid.

getAccount

public Account getAccount(String attribute)

Helper method to retrieve an Account instance from the JSON request. The parameter value must be the "account number".

Parameters:

attribute - Attribute name.

Returns:

Account instance if found, otherwise null.