com.highdeal.iec
Interface DataCollection

All Superinterfaces:

com.highdeal.hci.XMLMarshallable

public interface DataCollection
extends com.highdeal.hci.XMLMarshallable

This interface represents a set of coherents data. Data is mapped with keys. For better performance, the interface provides some methods that allow the collection to be reused to limit the count of the instance creation. An instance of the DataCollection class is a set of pairs (key, value) in which the value can be a boolean, string, date or number. A key is unique, but two keys can have the same value. For example, the keys k1 and k2 can have the value TRUE which is a Boolean.

Method Summary

void	addAll(java.util.Map<java.lang.String,java.lang.Object> props) Adds to this collection the objects of the given props.
void	clear() Clears this collection so that it contains no keys and UID.
void	decant(DataCollection collectionToFill) This method decant its members in the given collectionToFill.
boolean	equalsDC(DataCollection dc) Compare to DC, property by property.
java.lang.Object	get(java.lang.String key) Searches for an Object with the specified key in this collection.
java.lang.Boolean	getBoolean(java.lang.String key) Searches for a Boolean with the specified key in this collection.
long	getCreationNumber() Returns the creation number of the DataCollection.
java.util.Date	getDate(java.lang.String key) Searches for a Date with the specified key in this collection.
java.util.Map<java.lang.String,java.lang.Object>	getMap() Returns a map that contains the keys and the values.
java.math.BigDecimal	getNumber(java.lang.String key) Searches for a Number with the specified key in this collection.
Resource	getResource(java.lang.String key) Searches for a Resource with the specified key in this collection.
java.lang.String	getString(java.lang.String key) Searches for a String with the specified key in this collection.
java.lang.String	getUID() Returns the UID of the DataCollection
boolean	isReusable() Returns true if this instance of DataCollection is no more shared by threads, false otherwise.
java.util.Set<java.lang.String>	keys() Returns all the keys of the collection.
void	set(java.lang.String key, java.lang.Object data) Maps the specified key to the specified Object in this collection.
void	setBoolean(java.lang.String key, java.lang.Boolean data) Maps the specified key to the specified Boolean in this collection.
void	setCreationNumber(long number) Sets the creation number of the DataCollection.
void	setDate(java.lang.String key, java.util.Date data) Maps the specified key to the specified Date in this collection.
void	setNumber(java.lang.String key, java.math.BigDecimal data) Maps the specified key to the specified BigDecimal in this collection.
void	setResource(java.lang.String key, Resource data) Maps the specified key to the specified Resource in this collection.
void	setReusable(boolean flag) Sets the DataCollection reusable.
void	setString(java.lang.String key, java.lang.String data) Maps the specified key to the specified String in this collection.
void	setUID(java.lang.String uid) Sets the UID of the DataCollection

Methods inherited from interface com.highdeal.hci.XMLMarshallable

addCharacterData, addChild, marshal, setAttributes

Method Detail

setUID

void setUID(java.lang.String uid)

Sets the UID of the DataCollection

getUID

java.lang.String getUID()

Returns the UID of the DataCollection

getCreationNumber

long getCreationNumber()

Returns the creation number of the DataCollection.

setCreationNumber

void setCreationNumber(long number)

Sets the creation number of the DataCollection.

getBoolean

java.lang.Boolean getBoolean(java.lang.String key)

Searches for a Boolean with the specified key in this collection.

Returns:

the Boolean in this collection with the specified key value if it exists, null otherwise.

setBoolean

void setBoolean(java.lang.String key,
                java.lang.Boolean data)

Maps the specified key to the specified Boolean in this collection. The Boolean can be retrieved by calling the getBoolean(java.lang.String) method with a key that is equal to the original key.

Parameters:

key - the key.

data - the value.

getString

java.lang.String getString(java.lang.String key)

Searches for a String with the specified key in this collection.

Returns:

the String in this collection with the specified key value if it exists, null otherwise.

setString

void setString(java.lang.String key,
               java.lang.String data)

Maps the specified key to the specified String in this collection. The String can be retrieved by calling the getString(java.lang.String) method with a key that is equal to the original key.

Parameters:

key - the key.

data - the value.

getDate

java.util.Date getDate(java.lang.String key)

Searches for a Date with the specified key in this collection.

Returns:

the Date in this collection with the specified key value if it exists, null otherwise.

setDate

void setDate(java.lang.String key,
             java.util.Date data)

Maps the specified key to the specified Date in this collection. The Date can be retrieved by calling the getDate(java.lang.String) method with a key that is equal to the original key.

Parameters:

key - the key.

data - the value.

getNumber

java.math.BigDecimal getNumber(java.lang.String key)

Searches for a Number with the specified key in this collection.

Returns:

the Number in this collection with the specified key value if it exists, null otherwise.

setNumber

void setNumber(java.lang.String key,
               java.math.BigDecimal data)

Maps the specified key to the specified BigDecimal in this collection. The BigDecimal can be retrieved by calling the getNumber(java.lang.String) method with a key that is equal to the original key.

Parameters:

key - the key.

data - the value.

getResource

Resource getResource(java.lang.String key)

Searches for a Resource with the specified key in this collection.

Returns:

the Resource in this collection with the specified key value if it exists, null otherwise.

setResource

void setResource(java.lang.String key,
                 Resource data)

Maps the specified key to the specified Resource in this collection. The Resource can be retrieved by calling the getResource(java.lang.String) method with a key that is equal to the original key.

Parameters:

key - the key.

data - the value.

get

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

Searches for an Object with the specified key in this collection.

Returns:

the Object in this collection with the specified key value if it exists, null otherwise.

set

void set(java.lang.String key,
         java.lang.Object data)

Maps the specified key to the specified Object in this collection. The Object can be retrieved by calling the get(java.lang.String) method with a key that is equal to the original key.

Parameters:

key - the key.

data - the value.

keys

java.util.Set<java.lang.String> keys()

Returns all the keys of the collection.

setReusable

void setReusable(boolean flag)

Sets the DataCollection reusable.

isReusable

boolean isReusable()

Returns true if this instance of DataCollection is no more shared by threads, false otherwise. If it is the case it can be reseted and reused without any problems. Very useful for Multithreaded process.

decant

void decant(DataCollection collectionToFill)

This method decant its members in the given collectionToFill. Warning, this instance should not use its members.

Parameters:

collectionToFill - the target collection.

clear

void clear()

Clears this collection so that it contains no keys and UID.

equalsDC

boolean equalsDC(DataCollection dc)

Compare to DC, property by property.

getMap

java.util.Map<java.lang.String,java.lang.Object> getMap()

Returns a map that contains the keys and the values.

addAll

void addAll(java.util.Map<java.lang.String,java.lang.Object> props)

Adds to this collection the objects of the given props.

Parameters:

props - the properties from which the objects are extracted.