org.yawlfoundation.yawl.elements

Class YAttributeMap

java.lang.Object

java.util.AbstractMap<K,V>

java.util.TreeMap<java.lang.String,java.lang.String>

org.yawlfoundation.yawl.elements.YAttributeMap

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.lang.String>, java.util.NavigableMap<java.lang.String,java.lang.String>, java.util.SortedMap<java.lang.String,java.lang.String>

public class YAttributeMap
extends java.util.TreeMap<java.lang.String,java.lang.String>

An extended map of key=attribute pairs.

Since:

2.1

Author:

Michael Adams

See Also:

Serialized Form

Created/Last Date:

11/11/2009

Nested Class Summary

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

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

Constructor Summary

Constructors

Constructor and Description
YAttributeMap() Construct an (initially) empty attribute map.
YAttributeMap(java.util.Map<java.lang.String,java.lang.String> attributes) Construct an attribute map, and initialise it with the specified attributes.

Method Summary

Modifier and Type	Method and Description
void	fromJDOM(java.util.List<Attribute> jdomAttributes) Replace the stored attributes (if any) with the JDOM attributes specified.
void	fromXMLElements(java.lang.String xml)
java.lang.String	get(java.lang.String key) Gets the stored value for the key (as a String).
boolean	getBoolean(java.lang.String key) Get the boolean value matching the stored key.
DynamicValue	put(java.lang.String key, DynamicValue value) Adds a key + DynamicValue to the dynamic map
void	remove(java.lang.String key) Removes a value the store
void	set(java.util.Map<java.lang.String,java.lang.String> attributes) Replace the stored attributes (if any) with those specified.
java.util.Set<Attribute>	toJDOM() Get the contents of the attribute map as a set of JDOM attributes.
java.lang.String	toXML() Write the full set of attributes stored in the map, in XML attribute format, for insertion into an XML element.
java.lang.String	toXML(java.lang.String key) Write a specified key=value pair in XML attribute format: key="value"
java.lang.String	toXMLElement(java.lang.String key) Write a specified key=value pair in XML element format: <key>value</key>
java.lang.String	toXMLElements() Write the full set of attributes stored in the map, in XML element format.
void	transformDynamicValues(java.lang.Object owner)

Methods inherited from class java.util.TreeMap

ceilingEntry, ceilingKey, clear, clone, comparator, containsKey, containsValue, descendingKeySet, descendingMap, entrySet, firstEntry, firstKey, floorEntry, floorKey, forEach, get, headMap, headMap, higherEntry, higherKey, keySet, lastEntry, lastKey, lowerEntry, lowerKey, navigableKeySet, pollFirstEntry, pollLastEntry, put, putAll, remove, replace, replace, replaceAll, size, subMap, subMap, tailMap, tailMap, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, isEmpty, toString

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, getOrDefault, hashCode, isEmpty, merge, putIfAbsent, remove

Constructor Detail

YAttributeMap

public YAttributeMap()

Construct an (initially) empty attribute map.

YAttributeMap

public YAttributeMap(java.util.Map<java.lang.String,java.lang.String> attributes)

Construct an attribute map, and initialise it with the specified attributes.

Parameters:

attributes - a map of key=value pairs to initialise the map.

Method Detail

set

public void set(java.util.Map<java.lang.String,java.lang.String> attributes)

Replace the stored attributes (if any) with those specified.

Parameters:

attributes - a map of key=value pairs to place in this map, replacing any previous contents.

getBoolean

public boolean getBoolean(java.lang.String key)

Get the boolean value matching the stored key.

Parameters:

key - the attribute key to retrieve the value of.

Returns:

true iff the attribute map contains a key matching the String specified AND that attribute key has a corresponding value that matches the String "true" (case-insensitive).

put

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

Adds a key + DynamicValue to the dynamic map

Parameters:

key - the key

value - the DynamicValue

Returns:

the added DynamicValue

get

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

Gets the stored value for the key (as a String). If the key refers to a DynamicValue object, its value is dynamically evaluated

Parameters:

key - the key

Returns:

the stored String value

remove

public void remove(java.lang.String key)

Removes a value the store

Parameters:

key - the key that refers to a DynamicValue

toJDOM

public java.util.Set<Attribute> toJDOM()

Get the contents of the attribute map as a set of JDOM attributes.

Returns:

a Set of populated JDOM Attribute objects.

fromJDOM

public void fromJDOM(java.util.List<Attribute> jdomAttributes)

Replace the stored attributes (if any) with the JDOM attributes specified.

Parameters:

jdomAttributes - a List of JDOM Attribute objects to convert to key=value pairs and place in this map, replacing any previous contents.

transformDynamicValues

public void transformDynamicValues(java.lang.Object owner)

toXML

public java.lang.String toXML(java.lang.String key)

Write a specified key=value pair in XML attribute format: key="value"

Parameters:

key - the key to write out, with its corresponding value.

Returns:

if the key exists in the attribute map, a representation of it in XML attribute format, otherwise an empty String.

toXMLElement

public java.lang.String toXMLElement(java.lang.String key)

Write a specified key=value pair in XML element format: <key>value</key>

Parameters:

key - the key to write out, with its corresponding value.

Returns:

if the key exists in the attribute map, a representation of it in XML element format, otherwise an empty String.

toXML

public java.lang.String toXML()

Write the full set of attributes stored in the map, in XML attribute format, for insertion into an XML element.

Returns:

a space separated list of this attribute map's key="value" pairs.

toXMLElements

public java.lang.String toXMLElements()

Write the full set of attributes stored in the map, in XML element format.

Returns:

a space separated list of this attribute map's <key>value</key> pairs.

fromXMLElements

public void fromXMLElements(java.lang.String xml)