prajna.data

Class MultiValueMap<V>

java.lang.Object

java.util.AbstractMap<K,V>

java.util.HashMap<java.lang.String,java.util.Set<V>>

prajna.data.MultiValueMap<V>

Type Parameters:

V - The class of data stored in this map

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable, java.util.Map<java.lang.String,java.util.Set<V>>

public class MultiValueMap<V>
extends java.util.HashMap<java.lang.String,java.util.Set<V>>

Map class mapping a single key to a set of values.

Author:

Edward Swing

See Also:

Serialized Form

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
MultiValueMap()

Method Summary

Methods

Modifier and Type	Method and Description
void	addFieldValue(java.lang.String fieldName, V fieldValue) Add a value to the given field.
V	getField(java.lang.String fieldName) Gets the value for a particular field.
java.lang.String	getFieldAsString(java.lang.String fieldName) Gets the value of the specified field, converted to a String.
boolean	isMultiValued(java.lang.String fieldName) Return whether the given field has multiple values.
void	mergeData(MultiValueMap<V> otherMap) Merges the data from another MultiValueMap with this one.
void	removeFieldValue(java.lang.String fieldName, V fieldValue) Remove a value from the set of values for the given fieldName
void	setField(java.lang.String fieldName, V fieldValue) Sets the value for a particular field

Methods inherited from class java.util.HashMap

clear, clone, containsKey, containsValue, entrySet, get, isEmpty, keySet, put, putAll, remove, size, values

Methods inherited from class java.util.AbstractMap

equals, hashCode, toString

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.util.Map

equals, hashCode

Constructor Detail

MultiValueMap

public MultiValueMap()

Method Detail

addFieldValue

public void addFieldValue(java.lang.String fieldName,
                 V fieldValue)

Add a value to the given field. This method adds an additional value to the values associated with the field name

Parameters:

fieldName - the name of the field

fieldValue - the value of the field

getField

public V getField(java.lang.String fieldName)

Gets the value for a particular field. If the fieldName has multiple values associated with it, an arbitrary value is returned.

Parameters:

fieldName - the name of the field

Returns:

the value of the field

getFieldAsString

public java.lang.String getFieldAsString(java.lang.String fieldName)

Gets the value of the specified field, converted to a String. If a field has multiple values, these values are separated by the pipe character.

Parameters:

fieldName - the field name

Returns:

a string version of the field value.

isMultiValued

public boolean isMultiValued(java.lang.String fieldName)

Return whether the given field has multiple values. This method returns true if the field has more than one value.

Parameters:

fieldName - the name of the field

Returns:

true if the field has more than one value, false if the field has only one value or no values.

mergeData

public void mergeData(MultiValueMap<V> otherMap)

Merges the data from another MultiValueMap with this one. Any field values in the other map are copied into this one. The other map must be of the same type as this one.

Parameters:

otherMap - The other node to merge with this node.

removeFieldValue

public void removeFieldValue(java.lang.String fieldName,
                    V fieldValue)

Remove a value from the set of values for the given fieldName

Parameters:

fieldName - The field name for the value

fieldValue - The value to remove

setField

public void setField(java.lang.String fieldName,
            V fieldValue)

Sets the value for a particular field

Parameters:

fieldName - the name of the field

fieldValue - the value of the field