com.softwareag.util

Class IDataMap

java.lang.Object

java.util.AbstractMap<java.lang.String,java.lang.Object>

com.softwareag.util.IDataMap

All Implemented Interfaces:

java.util.Map<java.lang.String,java.lang.Object>

public class IDataMap
extends java.util.AbstractMap<java.lang.String,java.lang.Object>

IDataMap combines the functionality of IData, IDataCursor, IDataUtil, and IDataFactory. IDataMap implements the java.util.Map interface from the Java Collections Framework, providing a familiar and simple interface. IDataMap expands the Map interface, adding getAs<Type> methods, which convert the returned value to a specific type.

For example:

     IDataMap pl = new IDataMap(pipeline);
     String userName = pl.getAsString("userName");
     Integer port = pl.getAsInteger("port", 5555);
 
     for (String key : pl.keys()) {
         System.out.println("pipeline[" + key + "]: " + pl.get(key));
     }
 
     IData[] assets = pl.getAsIDataArray("assets");
     // ... processing ...
     pl.put("status", "complete");
 

IDataMap, as a Map, assumes that the keys of the IData instance are unique, meaning that there are no duplicated elements with the same key.

IDataMap wraps an IData instance with a Map interface. It does not provide an alternative implementation of the underlying data structure for IData. IDataMap performs the same way as the legacy IData family.

You should use either IDataMap on an IData or the legacy IData family, but not both, since there are potential issues with concurrent modification via both the IDataMap and IData classes. For performance reasons, IDataMap caches values as it looks them up from IData. As with the IData family, IDataMap does not guarantee thread safety.

As a result of implementing the Map interface, an IDataMap can have its keys and values iterated over using the for-each construct, as in the example above.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	IDataMap.IDataMapEntry A name/value pair of entries for an IData instance.

Nested classes/interfaces inherited from class java.util.AbstractMap

java.util.AbstractMap.SimpleEntry<K,V>, java.util.AbstractMap.SimpleImmutableEntry<K,V>

Nested classes/interfaces inherited from interface java.util.Map

java.util.Map.Entry<K,V>

Constructor Summary

Constructors

Constructor and Description
IDataMap() Creates a map wrapping a newly-constructed IData.
IDataMap(IData data) Creates a map wrapping the given IData.
IDataMap(java.util.Map<? extends java.lang.String,? extends java.lang.Object> other) Creates a map wrapping a newly-constructed IData from the given map.
IDataMap(java.lang.Object[][] data) Constructs an IData from data, an array of Object arrays, and creates a map wrapping it.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all elements from the IData object.
java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>>	entrySet() Returns a set of entries for this map.
java.lang.Object	get(java.lang.Object key) Returns the value for the given key, or null if there is none.
java.lang.Boolean	getAsBoolean(java.lang.Object key) Returns the value as a boolean, if the value exists and can be converted to a boolean.
java.lang.Boolean	getAsBoolean(java.lang.Object key, java.lang.Boolean defVal) Returns the value as a boolean, if the value exists and can be converted to a boolean.
IData	getAsIData(java.lang.Object key) Returns the value as an IData object, or null if not found.
IData	getAsIData(java.lang.Object key, IData defVal) Returns the value as an IData, or defVal if not found.
IData[]	getAsIDataArray(java.lang.Object key) Returns the value as an IData array, or null if not found.
IData[]	getAsIDataArray(java.lang.Object key, IData[] defVal) Returns the value as an IData array, or defVal if not found.
IDataMap	getAsIDataMap(java.lang.Object key) Returns the element for the given key, wrapping it in an IDataMap, if the element is an IData instance.
IDataMap	getAsIDataMap(java.lang.Object key, IDataMap devVal) Returns the element for the given key, wrapping it in an IDataMap, if the element is an IData instance.
java.lang.Integer	getAsInteger(java.lang.Object key) Returns the value as an integer, if the value exists and can be converted to an integer.
java.lang.Integer	getAsInteger(java.lang.Object key, java.lang.Integer defVal) Returns the value as an integer, if the value exists and can be converted to an integer.
java.lang.Long	getAsLong(java.lang.Object key) Returns the value as a long, if the value exists and can be converted to an integer.
java.lang.Long	getAsLong(java.lang.Object key, java.lang.Long defVal) Returns the value as a long, if the value exists and can be converted to a long.
java.lang.String	getAsNonEmptyString(java.lang.Object key) Returns the value as a String, converting via toString unless the value is a String.
java.lang.String	getAsNonEmptyString(java.lang.Object key, java.lang.String defVal) Returns the value as a String, converting via toString unless the value is a String.
java.lang.String	getAsString(java.lang.Object key) Returns the value as a String, converting via toString unless the value is a String.
java.lang.String	getAsString(java.lang.Object key, java.lang.String defVal) Returns the value as a String, converting via toString unless the value is a String.
java.lang.String[]	getAsStringArray(java.lang.Object key) Returns the value as a String array, or null if not found.
java.lang.String[]	getAsStringArray(java.lang.Object key, java.lang.String[] defVal) Returns the value as a String array, or defVal if not found.
IData	getIData() Returns the IData that this object wraps.
java.lang.Object	getNested(java.lang.Object... keys) Returns a value within an arbitrarily deep nesting of IData objects.
java.lang.Object	put(java.lang.String key, java.lang.Object value) Sets the value for the given key, and returns the previous value or null if none.
java.lang.Object	remove(java.lang.Object key) Removes the IData entry for the given key.

Methods inherited from class java.util.AbstractMap

containsKey, containsValue, equals, hashCode, isEmpty, keySet, putAll, size, toString, values

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, forEach, getOrDefault, merge, putIfAbsent, remove, replace, replace, replaceAll

Constructor Detail

IDataMap

public IDataMap(IData data)

Creates a map wrapping the given IData.

Parameters:

data - The IData instance to be wrapped by this IDataMap. If null, a new IData will be created, and is accessible via the getIData method.

IDataMap

public IDataMap()

Creates a map wrapping a newly-constructed IData.

IDataMap

public IDataMap(java.lang.Object[][] data)

Constructs an IData from data, an array of Object arrays, and creates a map wrapping it.

Parameters:

data - The data from which to populate this IDataMap.

IDataMap

public IDataMap(java.util.Map<? extends java.lang.String,? extends java.lang.Object> other)

Creates a map wrapping a newly-constructed IData from the given map.

Parameters:

other - The map from which to populate this IDataMap.

Method Detail

getIData

public IData getIData()

Returns the IData that this object wraps.

Returns:

The IData instance.

get

public java.lang.Object get(java.lang.Object key)

Returns the value for the given key, or null if there is none.

Specified by:

get in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

get in class java.util.AbstractMap<java.lang.String,java.lang.Object>

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key.

getAsBoolean

public java.lang.Boolean getAsBoolean(java.lang.Object key)

Returns the value as a boolean, if the value exists and can be converted to a boolean. Otherwise, false will be returned.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, such as a Boolean.

getAsBoolean

public java.lang.Boolean getAsBoolean(java.lang.Object key,
                                      java.lang.Boolean defVal)

Returns the value as a boolean, if the value exists and can be converted to a boolean. Otherwise, the default value will be returned. Note that if this returns null, then boolean b = map.getAsBoolean(...), with autoboxing converting from Boolean to boolean, will result in a null pointer exception.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, such as a Boolean.

getAsIData

public IData getAsIData(java.lang.Object key)

Returns the value as an IData object, or null if not found.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as an IData object.

getAsIData

public IData getAsIData(java.lang.Object key,
                        IData defVal)

Returns the value as an IData, or defVal if not found.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as an IData.

getAsIDataArray

public IData[] getAsIDataArray(java.lang.Object key)

Returns the value as an IData array, or null if not found.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as an IData array.

getAsIDataArray

public IData[] getAsIDataArray(java.lang.Object key,
                               IData[] defVal)

Returns the value as an IData array, or defVal if not found.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as an IData array.

getAsInteger

public java.lang.Integer getAsInteger(java.lang.Object key)

Returns the value as an integer, if the value exists and can be converted to an integer. Otherwise, null will be returned. Note that if this returns null, then int i = map.getAsInteger(...) (autoboxing from Integer to int) will result in an NPE.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as an Integer.

getAsInteger

public java.lang.Integer getAsInteger(java.lang.Object key,
                                      java.lang.Integer defVal)

Returns the value as an integer, if the value exists and can be converted to an integer. Otherwise, the default value will be returned. Note that if this returns null, then int i = map.getAsInteger(...) will result in an NPE.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as an integer.

getAsLong

public java.lang.Long getAsLong(java.lang.Object key,
                                java.lang.Long defVal)

Returns the value as a long, if the value exists and can be converted to a long. Otherwise, null will be returned. Note that if this returns null, then long l = map.getAsLong(...) will result in an NullPointerException.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as a Long.

getAsLong

public java.lang.Long getAsLong(java.lang.Object key)

Returns the value as a long, if the value exists and can be converted to an integer. Otherwise, the default value will be returned. Note that if this returns null, then long l = map.getAsLong(...) will result in an NullPointerException.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as a long.

getAsString

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

Returns the value as a String, converting via toString unless the value is a String.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as a String.

getAsString

public java.lang.String getAsString(java.lang.Object key,
                                    java.lang.String defVal)

Returns the value as a String, converting via toString unless the value is a String.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as a String.

getAsNonEmptyString

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

Returns the value as a String, converting via toString unless the value is a String. If the String is empty (of zero length), null will be returned.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as a String.

getAsNonEmptyString

public java.lang.String getAsNonEmptyString(java.lang.Object key,
                                            java.lang.String defVal)

Returns the value as a String, converting via toString unless the value is a String. If the String is empty (of zero length), the default value will be returned.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as a String.

getAsStringArray

public java.lang.String[] getAsStringArray(java.lang.Object key)

Returns the value as a String array, or null if not found.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as a String array.

getAsStringArray

public java.lang.String[] getAsStringArray(java.lang.Object key,
                                           java.lang.String[] defVal)

Returns the value as a String array, or defVal if not found.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as a String array.

getAsIDataMap

public IDataMap getAsIDataMap(java.lang.Object key)

Returns the element for the given key, wrapping it in an IDataMap, if the element is an IData instance. Otherwise, null is returned.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as an IDataMap.

getAsIDataMap

public IDataMap getAsIDataMap(java.lang.Object key,
                              IDataMap devVal)

Returns the element for the given key, wrapping it in an IDataMap, if the element is an IData instance. Otherwise, the default value is returned.

Parameters:

key - The key with which to find the associated value.

Returns:

The value for the given key, as an IDataMap.

getNested

public java.lang.Object getNested(java.lang.Object... keys)

Returns a value within an arbitrarily deep nesting of IData objects. Each value in keys is the key to a nested IData, except the last one, which is the key of the desired Object.

Parameters:

keys - The keys with which to find the associated value.

Returns:

The value for the given keys.

put

public java.lang.Object put(java.lang.String key,
                            java.lang.Object value)

Sets the value for the given key, and returns the previous value or null if none.

Specified by:

put in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

put in class java.util.AbstractMap<java.lang.String,java.lang.Object>

Parameters:

key - The key for which the value will be associated.

Returns:

The previous value for the entry.

remove

public java.lang.Object remove(java.lang.Object key)

Removes the IData entry for the given key.

Specified by:

remove in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

remove in class java.util.AbstractMap<java.lang.String,java.lang.Object>

Parameters:

key - The key for which the entry will be removed.

Returns:

The previous value for the entry.

clear

public void clear()

Removes all elements from the IData object.

Specified by:

clear in interface java.util.Map<java.lang.String,java.lang.Object>

Overrides:

clear in class java.util.AbstractMap<java.lang.String,java.lang.Object>

entrySet

public java.util.Set<java.util.Map.Entry<java.lang.String,java.lang.Object>> entrySet()

Returns a set of entries for this map. This uses a TreeSet to sort the returned entries by key.

Specified by:

entrySet in interface java.util.Map<java.lang.String,java.lang.Object>

Specified by:

entrySet in class java.util.AbstractMap<java.lang.String,java.lang.Object>

Returns:

The entries for this map, sorted by key.