Package org.jolokia.service.serializer.object

Class TabularDataConverter

java.lang.Object

org.jolokia.service.serializer.object.TabularDataConverter

All Implemented Interfaces:

Converter<TabularType>

public class TabularDataConverter
extends Object

Converter for TabularType objects. This converter transforms maps (in particular JSON objects into TabularData values according to the type specification defined in a TabularType.

The maps being converted come in 3 flavors:

• #1.MXBean compatible Map/SortedMap: requires TabularType.getRowType() to define two items: key and value. TabularType.getIndexNames() should contain one item: key. If the type of item is SimpleType, we can convert any map, otherwise we expect maps that can be handled by flavors #2 and #3.
• #2. non @MXBean maps with indexNames and values top level fields: this is Jolokia-specific representation which directly represents TabularData, where each row is separate JSON object added to JSON array under values field of top-level map. This should be used if TabularType.getIndexNames() point to fields in CompositeType which are not simple types.
• #3. other non @MXBean maps: TabularType.getIndexNames() are nested maps which eventually lead to the values. This representation is supported only if TabularType.getIndexNames() point to fields in CompositeType which are SimpleType.

Since:

28.09.11

Author:

roland

Field Summary

Fields

Modifier and Type	Field	Description
protected boolean	forgiving
protected final ObjectToOpenTypeConverter	objectToOpenTypeConverter

Constructor Summary

Constructors

Constructor	Description
TabularDataConverter(ObjectToOpenTypeConverter pObjectToOpenTypeConverter)	Constructor

Method Summary

Modifier and Type	Method	Description
Object	convert(TabularType pType, Object pValue)	Generic deserialization/conversion method, where: targetType describes the desired type of the deserialized object (deserializers usually use Class, but we have other ways to specify the target type). value comes in some wire format (String or JSON), but we can also convert (which is wider term than deserialization) them from other types.
static TabularType	createMXBeanTabularType(OpenType<?> keyType, OpenType<?> valueType)	Helper method to create MXBean compatible TabularType with key and value items in its CompositeType and single key index.
protected void	ensureStringKeys(Map<?,?> pValue, Set<Integer> identities)	Check if the generic Map uses only String-based keys
protected static String	getMXBeanTypeName(OpenType<?> type)	Get a name for given OpenType to be used when creating composite type names
protected boolean	isForgiving()
static boolean	isMXBeanMapWithSimpleKeys(TabularType pType)	Check if a TabularType matches the mapping for Map<K, V> in MXBean specification.
protected <J extends org.jolokia.json.JSONStructure> J	toJSON(Object pValue, Class<J> jsonType)	Convert a value to JSONStructure.
protected Map<String,Object>	toMap(Object pValue)
protected String	trim(String pValue)	Trims non-null value before printing.

Methods inherited from class java.lang.Object

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

Field Details

forgiving

protected boolean forgiving

objectToOpenTypeConverter

protected final ObjectToOpenTypeConverter objectToOpenTypeConverter

Constructor Details

TabularDataConverter

public TabularDataConverter(ObjectToOpenTypeConverter pObjectToOpenTypeConverter)

Constructor

Parameters:

pObjectToOpenTypeConverter - parent converter used for recursive conversion

Method Details

convert

public Object convert(TabularType pType,
 Object pValue)

Description copied from interface: Converter

Generic deserialization/conversion method, where:

• targetType describes the desired type of the deserialized object (deserializers usually use Class, but we have other ways to specify the target type).
• value comes in some wire format (String or JSON), but we can also convert (which is wider term than deserialization) them from other types.

Returns:

createMXBeanTabularType

public static TabularType createMXBeanTabularType(OpenType<?> keyType,
 OpenType<?> valueType)
                                           throws OpenDataException

Helper method to create MXBean compatible TabularType with key and value items in its CompositeType and single key index. The types of the key and value items may be any of OpenType.

If the type of the key is Comparable, the TabularType maps to SortedMap. Otherwise it maps to unordered Map.

Parameters:

keyType -

valueType -

Returns:

Throws:

OpenDataException

See Also:

• MXBean Type Names

isMXBeanMapWithSimpleKeys

public static boolean isMXBeanMapWithSimpleKeys(TabularType pType)

Check if a TabularType matches the mapping for Map<K, V> in MXBean specification. We also check if they keys are of SimpleType, because of JSON serialization.

Parameters:

pType -

Returns:

getMXBeanTypeName

protected static String getMXBeanTypeName(OpenType<?> type)

Get a name for given OpenType to be used when creating composite type names

Parameters:

type -

Returns:

toJSON

protected <J extends org.jolokia.json.JSONStructure>
J toJSON(Object pValue,
 Class<J> jsonType)

Convert a value to JSONStructure. The given object must be either a valid JSON string or of type JSONStructure, in which case it is returned directly if it matches desired target type.

Parameters:

pValue - the value to parse (or to return directly if it is a JSONStructure

Returns:

the resulting value

ensureStringKeys

protected void ensureStringKeys(Map<?,?> pValue,
 Set<Integer> identities)

Check if the generic Map uses only String-based keys

Parameters:

pValue -

identities - to track recursive instances - invoke first with empty set

toMap

protected Map<String,Object> toMap(Object pValue)

isForgiving

protected boolean isForgiving()

Returns:

whether I accept (and ignore) values that are not in the target type

trim

protected String trim(String pValue)

Trims non-null value before printing.

Parameters:

pValue -

Returns: