cdac.medinfo.sdk.dcm30_04.commoninterface

Interface IDataSet

All Superinterfaces:

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

All Known Implementing Classes:

DataSet

public interface IDataSet
extends ICollectionIterable<IDataElement>, java.io.Serializable

This interface needs to be implemented by all classes which implements the DataSet along with iterability.

Method Summary

Methods

Modifier and Type	Method and Description
int	addDataElement(IDataElement objIDataElement) Adds the DataElement to the DataSet
java.lang.Object	clone() Create similar object of this class.
void	dispose() This function disposes the DataSet.
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the contents of Data Set in readable form to the specified stream.
boolean	equals(java.lang.Object objObject) Check for the equality of two objects.
byte[]	getBytes(int iNumberOfBytes) The implementation of this method returns iNumberOfBytes in a byte array.
IDataElement	getDataForTag(int iGroupNumber, int iElementNumber) Retrieves the DataElement for the specified tag.
IDictionaryReader	getDictionaryReader() Retrieves the DictionaryReader.
ISingleCollection<IDataElement>	getInvalidDataElements() Validates DataSet for all DataElements and retrieves collection of invalid DataElements.
java.lang.String	getSOPClassUID() Retrieves the unique identifier for SOP class.
ITransferSyntax	getTransferSyntax() Retrieves 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 true is data is available in Data set.
boolean	isEmpty() Checks that dataset is empty or not.
boolean	isPresent(int iGroupNumber, int iElementNumber) Checks that element is present in dataset or not.
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 according to the DICOM Rules

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

iterator

Method Detail

getDataForTag

IDataElement getDataForTag(int iGroupNumber,
                         int iElementNumber)

Retrieves the DataElement for the specified tag.

Parameters:

iGroupNumber - integer value of group number.

iElementNumber - integer value of element number.

Returns:

IDataElement - instance of DataElement.

getDictionaryReader

IDictionaryReader getDictionaryReader()

Retrieves the DictionaryReader.

Returns:

IDictionaryReader - instance of DictionaryReader.

addDataElement

int addDataElement(IDataElement objIDataElement)
                   throws InvalidDataElementException

Adds the DataElement to the DataSet

Parameters:

objIDataElement - instance of DataElement.

Returns:

int - shows status as success or failure.

Throws:

InvalidDataElementException

getTransferSyntax

ITransferSyntax getTransferSyntax()

Retrieves the TransferSyntax set in the DataSet.

Returns:

ITransferSyntax - instance of TransferSyntax.

isPresent

boolean isPresent(int iGroupNumber,
                int iElementNumber)

Checks that element is present in dataset or not.

Parameters:

iGroupNumber - integer value of group number.

iElementNumber - integer value of element number.

Returns:

boolean - shows status as success or failure.

isEmpty

boolean isEmpty()

Checks that dataset is empty or not.

Returns:

boolean - shows status as success or failure.

getSOPClassUID

java.lang.String getSOPClassUID()

Retrieves the unique identifier for SOP class.

Returns:

String - String value of UID.

validate

boolean validate()
                 throws InvalidDataSetException

Validates the DataSet according to the DICOM Rules

Returns:

boolean - shows status as success or failure.

Throws:

InvalidDataSetException - if validation of DataSet fails.

equals

boolean equals(java.lang.Object objObject)

Check for the equality of two objects.

Overrides:

equals in class java.lang.Object

Parameters:

objObject - the object to compare with.

Returns:

boolean - true if the objects are the same false otherwise.

getBytes

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

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

Parameters:

iNumberOfBytes - No of bytes required.

Returns:

byte[] - byte array containing iNumberOfBytes.

Throws:

java.io.IOException - if IOException occurs.

isAvailable

boolean isAvailable()
                    throws java.io.IOException

The implementation of this method returns true is data is available in Data set.

Returns:

boolean - true if data is available in Data set. false if data is not available in Data set.

Throws:

java.io.IOException - if IO Operation fails.

getValue

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

This method returns value of DicomValue.

Parameters:

iGroupNumber - - Group Number of the DataElement

iElementNumber - - Element Number of the DataElement

Returns:

Object - instance of IDicomValue.

removeDataElement

void removeDataElement(IDataElement objIDataElement)

This method removes the data element from the data set.

Parameters:

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

removeDataElement

void removeDataElement(ITag objITag)

This method removes the data element from the data set.

Parameters:

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

getInvalidDataElements

ISingleCollection<IDataElement> getInvalidDataElements()

Validates DataSet for all DataElements and retrieves collection of invalid DataElements.

Returns:

ISingleCollection - collection of DataElements.

dispose

void dispose()
             throws java.io.IOException

This function disposes the DataSet.

Throws:

java.io.IOException - Signals if IO operation fails.

clone

java.lang.Object clone()

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

Returns:

IDataSet- object of IDataSet.

dumpDICOMInfo

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

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

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.