cdac.medinfo.sdk.dcm30_04.baselibs

Class DataSet

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.DataSet

All Implemented Interfaces:

IDataSet, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class DataSet
extends java.lang.Object
implements IDataSet

This class is used as a DataSet in Dicom which holds the DataElements in increasing order of Tag number

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
DataSet() This constructor constructs the data set with default transfer syntax and dictionary reader.
DataSet(IDictionaryReader objIDictionaryReader_) This constructor creates DataSet with Dictionary Reader specified by the user .
DataSet(ITransferSyntax objITransferSyntax_) This constructor creates DataSet with TransferSyntax specified by the user .
DataSet(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor creates data set with given transfer syntax and dictionary reader.

Method Summary

Methods

Modifier and Type	Method and Description
int	addDataElement(IDataElement objIDataElement) This method adds the DataElement to the DataSet
java.lang.Object	clone() Create similar object of this class.
void	dispose() This function disposes the Data Set.
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the contents of Data Set in readable form to the specified stream.
boolean	equals(java.lang.Object objObject) This method compares the DataElemnts of two DataSets.
byte[]	getBytes(int iNumberOfBytes) The implementation of this function gets the iNumberOfBytes of data set and returns byte array containing iNumberOfBytes.
IDataElement	getDataForTag(int iGroupNumber, int iElementNumber) This method returns the DataElement for the specified tag
IDictionaryReader	getDictionaryReader() This method returns the DictionaryReader set in the DataSet
ImageElement	getImageElement() Retrieves the Image Element.
ISingleCollection<IDataElement>	getInvalidDataElements() Retrieves collection of invalid DataElements from DataSet.
java.lang.String	getSOPClassUID() This method returns the SOP Class UID which specifies the type of IOD related to the DataSet
ITransferSyntax	getTransferSyntax() This method returns the TransferSyntax set in the DataSet
java.lang.Object	getValue(int iGroupNumber, int iElementNumber) This method returns value of DicomValue.
boolean	isAvailable() The implementation of this method returns iNumberOfBytes in a byte array.
boolean	isEmpty() The implementation of this method checks that dataset is empty or not.
boolean	isPresent(int iGroupNumber, int iElementNumber) The implementation of this method checks that element is present in dataset or not.
ICollectionIterator<IDataElement>	iterator() Provides iterator over the collection of DataElements
void	removeDataElement(IDataElement objIDataElement) This method removes the data element from the data set.
void	removeDataElement(ITag objITag) This method removes the data element from the data set.
boolean	validate() validates the DataSet

Methods inherited from class java.lang.Object

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

Constructor Detail

DataSet

public DataSet()
        throws InvalidDataSetException

This constructor constructs the data set with default transfer syntax and dictionary reader.

Throws:

InvalidDataSetException

DataSet

public DataSet(ITransferSyntax objITransferSyntax_)

This constructor creates DataSet with TransferSyntax specified by the user . This TransferSyntax will be used by IOD.

Parameters:

objITransferSyntax_ - Transfer syntax of the Data set.

DataSet

public DataSet(IDictionaryReader objIDictionaryReader_)

This constructor creates DataSet with Dictionary Reader specified by the user . This Dictionary Reader will be used by IOD.

Parameters:

objIDictionaryReader_ - Dictionary reader used by the data set.

DataSet

public DataSet(ITransferSyntax objITransferSyntax_,
       IDictionaryReader objIDictionaryReader_)

This constructor creates data set with given transfer syntax and dictionary reader.

Parameters:

objITransferSyntax_ - Transfer syntax of the Data set.

objIDictionaryReader_ - Dictionary reader used by the data set.

Method Detail

getDictionaryReader

public IDictionaryReader getDictionaryReader()

This method returns the DictionaryReader set in the DataSet

Specified by:

getDictionaryReader in interface IDataSet

Returns:

- DictionaryReader object

getDataForTag

public IDataElement getDataForTag(int iGroupNumber,
                         int iElementNumber)

This method returns the DataElement for the specified tag

Specified by:

getDataForTag in interface IDataSet

Parameters:

iGroupNumber - - Group Number of the DataElement

iElementNumber - - Element Number of the DataElement

Returns:

IDataElement - object of DataElement retrieved from the DataSet or null if the DataElement is not found in the DataSet

getTransferSyntax

public ITransferSyntax getTransferSyntax()

This method returns the TransferSyntax set in the DataSet

Specified by:

getTransferSyntax in interface IDataSet

Returns:

- TransferSyntax of the DataSet

getSOPClassUID

public java.lang.String getSOPClassUID()

This method returns the SOP Class UID which specifies the type of IOD related to the DataSet

Specified by:

getSOPClassUID in interface IDataSet

Returns:

- the SOP Class UID specifying the IOD represented by the DataSet

addDataElement

public int addDataElement(IDataElement objIDataElement)
                   throws InvalidDataElementException

This method adds the DataElement to the DataSet

Specified by:

addDataElement in interface IDataSet

Parameters:

objIDataElement - instance of DataElement.

Returns:

- the status indicating success/failure of adding the DataElement in the DataSet

Throws:

InvalidDataElementException

removeDataElement

public void removeDataElement(IDataElement objIDataElement)

This method removes the data element from the data set.

Specified by:

removeDataElement in interface IDataSet

Parameters:

objIDataElement - Object of Data Element which is to be removed.

removeDataElement

public void removeDataElement(ITag objITag)

This method removes the data element from the data set.

Specified by:

removeDataElement in interface IDataSet

Parameters:

objITag - Tag of data element which is to be removed.

iterator

public ICollectionIterator<IDataElement> iterator()

Provides iterator over the collection of DataElements

Specified by:

iterator in interface ICollectionIterable<IDataElement>

Specified by:

iterator in interface java.lang.Iterable<IDataElement>

Returns:

Iterator - custom iterator over the collection of DataElements

isPresent

public boolean isPresent(int iGroupNumber,
                int iElementNumber)

The implementation of this method checks that element is present in dataset or not.

Specified by:

isPresent in interface IDataSet

Parameters:

iGroupNumber - integer value of group number.

iElementNumber - integer value of element number.

Returns:

boolean - shows status as success or failure.

isEmpty

public boolean isEmpty()

The implementation of this method checks that dataset is empty or not.

Specified by:

isEmpty in interface IDataSet

Returns:

boolean - shows status as success or failure.

validate

public boolean validate()
                 throws InvalidDataSetException

validates the DataSet

Specified by:

validate in interface IDataSet

Returns:

- function status indicating success or failure

Throws:

InvalidDataSetException - - throws when the DataElements are not in proper order

getInvalidDataElements

public ISingleCollection<IDataElement> getInvalidDataElements()

Retrieves collection of invalid DataElements from DataSet.

Specified by:

getInvalidDataElements in interface IDataSet

Returns:

ISingleCollection - collection of DataElements

equals

public boolean equals(java.lang.Object objObject)

This method compares the DataElemnts of two DataSets.

Specified by:

equals in interface IDataSet

Overrides:

equals in class java.lang.Object

Parameters:

objDataset - - DataSets object.

Returns:

boolean - function status indicating success or failure.

getBytes

public byte[] getBytes(int iNumberOfBytes)
                throws java.io.IOException

The implementation of this function gets the iNumberOfBytes of data set and returns byte array containing iNumberOfBytes.

Specified by:

getBytes in interface IDataSet

Parameters:

iNumberOfBytes - integer value of number of bytes.

Returns:

byte[] - byte array of iNumberOfBytes.

Throws:

java.io.IOException - if IOException occurs.

isAvailable

public boolean isAvailable()
                    throws java.io.IOException

The implementation of this method returns iNumberOfBytes in a byte array.

Specified by:

isAvailable in interface IDataSet

Parameters:

iNumberOfBytes - No of bytes required.

Returns:

byte[] - byte array containing iNumberOfBytes.

Throws:

java.io.IOException - if IOException occurs.

getValue

public java.lang.Object getValue(int iGroupNumber,
                        int iElementNumber)

This method returns value of DicomValue.

Specified by:

getValue in interface IDataSet

Parameters:

GroupNumber - Group Number of the DataElement

ElementNumber - Element Number of the DataElement

Returns:

Object - instance of IDicomValue.

getImageElement

public ImageElement getImageElement()

Retrieves the Image Element.

Returns:

ImageElement

dispose

public void dispose()
             throws java.io.IOException

This function disposes the Data Set.

Specified by:

dispose in interface IDataSet

Throws:

java.io.IOException - Signals IO Exception if Exception occurs.

clone

public java.lang.Object clone()

Create similar object of this class. This does the deep copy and create a new instance of this class nad return it.

Specified by:

clone in interface IDataSet

Overrides:

clone in class java.lang.Object

Returns:

a clone of this instance.

dumpDICOMInfo

public void dumpDICOMInfo(IDicomStream objIDicomStream)
                   throws java.io.IOException

Dumps the contents of Data Set in readable form to the specified stream. Contents such as VR, Value Length, and Value are dumped.

Specified by:

dumpDICOMInfo in interface IDataSet

Parameters:

objIDicomStream - - the Stream on which the Data is to be written.

Throws:

java.io.IOException - - Exception is thrown indicating runtime failure of writing operation.