com.googlecode.fascinator.common

Class StorageDataUtil

java.lang.Object

com.googlecode.fascinator.common.StorageDataUtil

public class StorageDataUtil
extends java.lang.Object

Utility class for stored data in JSON format

Author:

Linda Octalina, Andrew Brazzatti, Jianfeng Li

Constructor Summary

Constructors

Constructor and Description
StorageDataUtil()

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	encodeJson(java.lang.String value) Safely escape the supplied string for use in JSON.
java.lang.String	encodeXml(java.lang.String value) Safely escape the supplied string for use in XML.
java.lang.String	get(JsonSimple json, java.lang.Object... field) Trivial wrapper for call into JSON Library.
java.lang.String	getDateTime(java.lang.String dateTimeInput, java.lang.String outputFormat) Reformat the date to the format supplied.
java.lang.String	getDefaultValueIfNull(JsonSimple json, java.lang.String defaultValue, java.lang.Object... field) Similar to get Method but return a string supplied by caller if cannot get the field
java.lang.String	getEmptyIfNull(JsonSimple json, java.lang.Object... field) Similar to get Method but return empty string instead of null
java.util.List<JsonObject>	getJavaList(JsonSimple json, java.lang.String baseKey) getJavaList method to reconstruct an list of JSONObjects of a key from a JsonSimple object
java.util.Map<java.lang.String,java.lang.Object>	getList(JsonSimple json, java.lang.String baseKey) Getlist method to get the values of key from the sourceMap
java.util.Map<java.lang.String,java.lang.Object>	getList(java.util.Map<java.lang.String,java.lang.Object> sourceMap, java.lang.String baseKey) Getlist method to get the values of key from the sourceMap
java.lang.String	getMetadata(DigitalObject object, java.lang.String field) Utility method for accessing object properties.
JsonSimple	getPayloadJsonSimple(Payload payload) Get a playload in JsonSimple format from the payload instance
JsonSimple	getPayloadJsonSimple(Storage storage, java.lang.String oid, java.lang.String payloadName) Get a playload in JsonSimple format in the specified Storage instance by its object ID and the name of payload.
java.util.List<java.lang.String>	getStringList(JsonSimple json, java.lang.String baseKey) getStringList method to reconstruct an list of String of a key from a JsonSimple object
java.lang.String	getW3CDateTime(java.lang.String dateTimeInput) Cleanup the supplied datetime value into a W3C format.

Methods inherited from class java.lang.Object

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

Constructor Detail

StorageDataUtil

public StorageDataUtil()

Method Detail

getPayloadJsonSimple

public JsonSimple getPayloadJsonSimple(Storage storage,
                              java.lang.String oid,
                              java.lang.String payloadName)

Get a playload in JsonSimple format in the specified Storage instance by its object ID and the name of payload. Useful for loading payloads which are in JSON format

Parameters:

storage - : Storage object

oid - : object ID

payloadName - : name of palyload

Returns:

JsonSimple or null

getPayloadJsonSimple

public JsonSimple getPayloadJsonSimple(Payload payload)

Get a playload in JsonSimple format from the payload instance

Parameters:

payload - : Payload object

Returns:

JsonSimple or null

getList

public java.util.Map<java.lang.String,java.lang.Object> getList(java.util.Map<java.lang.String,java.lang.Object> sourceMap,
                                                       java.lang.String baseKey)

Getlist method to get the values of key from the sourceMap

Parameters:

sourceMap - Map container

baseKey - field to searchclass

Returns:

list of value based on baseKey

getList

public java.util.Map<java.lang.String,java.lang.Object> getList(JsonSimple json,
                                                       java.lang.String baseKey)

Getlist method to get the values of key from the sourceMap

Parameters:

sourceMap - Map container

baseKey - field to search

Returns:

list of value based on baseKey

getJavaList

public java.util.List<JsonObject> getJavaList(JsonSimple json,
                                     java.lang.String baseKey)

getJavaList method to reconstruct an list of JSONObjects of a key from a JsonSimple object

Parameters:

json: - JsonSimple object of source

baseKey: - field to search

Returns:

List: a list of JsonObject based on baseKey

getStringList

public java.util.List<java.lang.String> getStringList(JsonSimple json,
                                             java.lang.String baseKey)

getStringList method to reconstruct an list of String of a key from a JsonSimple object

Parameters:

json: - JsonSimple object of source

baseKey: - field to search

Returns:

List: a List of JsonObject based on baseKey

get

public java.lang.String get(JsonSimple json,
                   java.lang.Object... field)

Trivial wrapper for call into JSON Library. Removes the difficulty of dealing with a null argument and a vararg from Velocity.

Parameters:

json: - The JSON object to get from

field: - The field in the JSON object to get

Returns:

String: The data in the field, possibly NULL

getEmptyIfNull

public java.lang.String getEmptyIfNull(JsonSimple json,
                              java.lang.Object... field)

Similar to get Method but return empty string instead of null

Parameters:

json: - The JSON object to get from

field: - The field in the JSON object to get

Returns:

String: The data in the field, possibly NULL

getDefaultValueIfNull

public java.lang.String getDefaultValueIfNull(JsonSimple json,
                                     java.lang.String defaultValue,
                                     java.lang.Object... field)

Similar to get Method but return a string supplied by caller if cannot get the field

Parameters:

json: - The JSON object to get from

defaultValue: - The default value of the field

field: - The field in the JSON object to get

Returns:

String: The data in the field, possibly NULL

getW3CDateTime

public java.lang.String getW3CDateTime(java.lang.String dateTimeInput)

Cleanup the supplied datetime value into a W3C format.

Parameters:

dateTimeInput - Datetime text to clean

Returns:

String The cleaned value

getDateTime

public java.lang.String getDateTime(java.lang.String dateTimeInput,
                           java.lang.String outputFormat)

Reformat the date to the format supplied.

Parameters:

dateTimeInput - Datetime to clean

Returns:

String The cleaned value

getMetadata

public java.lang.String getMetadata(DigitalObject object,
                           java.lang.String field)

Utility method for accessing object properties. Since null testing is awkward in velocity, an unset property is changed to en empty string ie. ("").

Parameters:

object: - The object to extract the property from

field: - The field name of the property

Returns:

String: The value of the property, or and empty string.

encodeXml

public java.lang.String encodeXml(java.lang.String value)

Safely escape the supplied string for use in XML.

Parameters:

value: - The string to escape

Returns:

String: The escaped string

encodeJson

public java.lang.String encodeJson(java.lang.String value)

Safely escape the supplied string for use in JSON.

Parameters:

value: - The string to escape

Returns:

String: The escaped string