cdac.medinfo.sdk.dcm30_04.utils

Interface IPairedCollection<T1,T2>

Type Parameters:

T1 - object to be used as a key in PairedCollection

T2 - object to be used as a value in PairedCollection

All Superinterfaces:

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

All Known Implementing Classes:

PairedCollection

public interface IPairedCollection<T1,T2>
extends ICollectionIterable<T2>, java.io.Serializable

This interface needs to be implemented by all classes which implements the necessary functionality for the PairedCollection. This template is generic so that any key value pairs can be used. The only condition for the object to be used as a key is to override hashCode() method to provide value based hashCode generation so that all the objects containing same values should generate same hashCode.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	contains(T1 objT1) The implementation of this method checks whether the specified key is present in the collection
T2	get(T1 objT1) The implementation of this method retrieves the object of type specified at the time of instantiation of this library.
T1[]	getKeys() The implementation of this method gets all the keys in the collection.
void	put(T1 objT1, T2 objT2) The implementation of this method add a key value pair in the paired collection
T2	remove(T1 objT1) The implementation of this method removes the values associated with the given key.
int	size() The implementation of this method retrieves the size of the collection.
ICollectionIterator<T2>	sortedIterator() The implementation of this method returns iterator having data elements in sorted order.

Methods inherited from interface cdac.medinfo.sdk.dcm30_04.utils.ICollectionIterable

iterator

Method Detail

sortedIterator

ICollectionIterator<T2> sortedIterator()

The implementation of this method returns iterator having data elements in sorted order.

Returns:

ICollectionIterator - collection of Data Elements in sorted order.

get

T2 get(T1 objT1)

The implementation of this method retrieves the object of type specified at the time of instantiation of this library.

Parameters:

objT1 - object specifying the key of PairedCollection

Returns:

objT2 - object specifying the value corresponding to the key in the specified collection

put

void put(T1 objT1,
       T2 objT2)

The implementation of this method add a key value pair in the paired collection

Parameters:

objT1 - object specifying the key of PairedCollection

objT2 - object specifying the value corresponding to the key in the specified collection

contains

boolean contains(T1 objT1)

The implementation of this method checks whether the specified key is present in the collection

Parameters:

objT1 - object specifying the key of PairedCollection .

Returns:

boolean - shows status as success or failure.

size

int size()

The implementation of this method retrieves the size of the collection.

Returns:

size - returns the number of elements present in the collection.

remove

T2 remove(T1 objT1)

The implementation of this method removes the values associated with the given key.

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

T1[] getKeys()

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

Returns:

T1[] - array of keys in the collection.