cdac.medinfo.sdk.dcm30_04.utils

Class PairedCollection<T1,T2>

java.lang.Object

cdac.medinfo.sdk.dcm30_04.utils.PairedCollection<T1,T2>

Type Parameters:

T1 - object object specifying key at the time of instantiation of this interface.

T2 - object object specifying value at the time of instantiation of this interface.

All Implemented Interfaces:

ICollectionIterable<T2>, IPairedCollection<T1,T2>, java.io.Serializable, java.lang.Iterable<T2>

public class PairedCollection<T1,T2>
extends java.lang.Object
implements IPairedCollection<T1,T2>

This interface provides the user with an abstract interface towards collections holding series of objects .

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PairedCollection.CollectionIterator This inner class works as an Iterator which helps iterating over the map contained in the DataSet.
class	PairedCollection.SortedIterator This inner class works as an Sorted Iterator which helps iterating over the map contained in the DataSet.

Constructor Summary

Constructors

Constructor and Description
PairedCollection() Constructs a new PairedCollection with the same mappings as the specified Collection.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(T1 objT1) This method returns the status indicating whether the key is present in the collection or not
T2	get(T1 objT1) This method provides key based accessing over the internal collection.
T1[]	getKeys() The implementation of this method gets all the keys in the collection.
ICollectionIterator<T2>	iterator() This method returns an iterator over the internal collection.
void	put(T1 objT1, T2 objT2) This method provides a mechanism for adding a key value pair to the collection.
T2	remove(T1 objT1) Removes the values associated with the given key.
int	size() This method returns the size of the collection.
ICollectionIterator<T2>	sortedIterator() This method returns an iterator over the internal collection.

Methods inherited from class java.lang.Object

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

Constructor Detail

PairedCollection

public PairedCollection()

Constructs a new PairedCollection with the same mappings as the specified Collection.

Method Detail

iterator

public ICollectionIterator<T2> iterator()

This method returns an iterator over the internal collection.

Specified by:

iterator in interface ICollectionIterable<T2>

Specified by:

iterator in interface java.lang.Iterable<T2>

Returns:

iterator - returns the iterator over the internal collection.

sortedIterator

public ICollectionIterator<T2> sortedIterator()

This method returns an iterator over the internal collection.

Specified by:

sortedIterator in interface IPairedCollection<T1,T2>

Returns:

iterator - returns the iterator over the internal collection.

get

public T2 get(T1 objT1)

This method provides key based accessing over the internal collection.

Specified by:

get in interface IPairedCollection<T1,T2>

Parameters:

objT1 - This parameter specifies the key whose corresponding value is to be retrieved .

Returns:

T2 - object of the type value user specifies at the time of instantiation of this interface.

put

public void put(T1 objT1,
       T2 objT2)

This method provides a mechanism for adding a key value pair to the collection.

Specified by:

put in interface IPairedCollection<T1,T2>

Parameters:

objT1 - This parameter specifies the key whose corresponding value is to be set.

objT2 - This parameter specifies the key whose corresponding value is to be set.

contains

public boolean contains(T1 objT1)

This method returns the status indicating whether the key is present in the collection or not

Specified by:

contains in interface IPairedCollection<T1,T2>

Parameters:

objT1 - element whose presence in this collection is to be tested .

Returns:

boolean - returns the status indicating whether the key is present in the collection or not.

size

public int size()

This method returns the size of the collection.

Specified by:

size in interface IPairedCollection<T1,T2>

Returns:

size - returns the size of the collection.

remove

public T2 remove(T1 objT1)

Removes the values associated with the given key.

Specified by:

remove in interface IPairedCollection<T1,T2>

Parameters:

objT1 - - key whose mapping value is removed.

Returns:

- previous value associated with the key or null if no mapping for this key is found.

getKeys

public T1[] getKeys()

The implementation of this method gets all the keys in the collection.

Specified by:

getKeys in interface IPairedCollection<T1,T2>

Returns:

T1[] - array of keys in the collection.