cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class IOD

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD

Direct Known Subclasses:

BasicDirectoryIOD, CompositeIOD, NormalizedIOD

public abstract class IOD
extends java.lang.Object

\* The class IOD provides the methods related to add or remove DataElements checking presence of modules, validate method and getter for Dataset.

Constructor Summary

Constructors

Constructor and Description
IOD() This constructor assumes that the IOD will have default TransferSyntax, empty DataSet, and default DictionaryReader.
IOD(IDataSet objIDataSet_) This constructor assumes that the IOD will have TransferSyntax specified by the DataSet, DataSet specified by the user, and default DictionaryReader.
IOD(IDictionaryReader objIDictionaryReader_) This constructor assumes that the IOD with DictionaryReader specified by the user at the time of IOD creation.
IOD(ITransferSyntax objITransferSyntax_) This constructor assumes that the IOD will have TransferSyntax specified by the user, empty DataSet, and default DictionaryReader.
IOD(ITransferSyntax objITransferSyntax, IDictionaryReader objIDictionaryReader_) This constructor assumes that the IOD will have TransferSyntax and Dictionary Reader specified by the DataSet,.
IOD(java.lang.String strFileName) Creates IOD from a DICOM file containing corresponding DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	addDataElement(java.lang.String strDataElementName, java.lang.Object objValue) This method adds the data element in IOD.
abstract void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the name and value of contents of IOD that is, Module and its corresponding Attributes in readable form to the specified stream.
IDataSet	getDataSet() This method provides the DataSet if and only if the IOD is valid according to the rules specified in the DICOM Standard PS3.
ITransferSyntax	getTransferSyntax() This method returns the TransferSyntax set in the IOD.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	isPresent(int iGroupNumber, int iElementNumber) Checks if the DataElement for the given GroupNumber,ElementNumber pair exists in IOD.
boolean	removeDataElement(java.lang.String strDataElementName, boolean isForceFullyDelete) This method removes the data element from the IOD.
boolean	removeModule(java.lang.String strModuleName, boolean isForceFullyDelete) This method removes the module from the IOD.
boolean	validate() This method validates IOD according to the Module Table given in The DICOM Standard.

Methods inherited from class java.lang.Object

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

Constructor Detail

IOD

public IOD()

This constructor assumes that the IOD will have default TransferSyntax, empty DataSet, and default DictionaryReader.

IOD

public IOD(ITransferSyntax objITransferSyntax_)

This constructor assumes that the IOD will have TransferSyntax specified by the user, empty DataSet, and default DictionaryReader.

Parameters:

objITransferSyntax_ - TransferSyntax specified by the user

IOD

public IOD(IDictionaryReader objIDictionaryReader_)

This constructor assumes that the IOD with DictionaryReader specified by the user at the time of IOD creation.

Parameters:

objIDictionaryReader_ - DictionaryReader specified by the user

IOD

public IOD(IDataSet objIDataSet_)

This constructor assumes that the IOD will have TransferSyntax specified by the DataSet, DataSet specified by the user, and default DictionaryReader.

Parameters:

objIDataSet_ - Data set specified by the user

IOD

public IOD(ITransferSyntax objITransferSyntax,
   IDictionaryReader objIDictionaryReader_)

This constructor assumes that the IOD will have TransferSyntax and Dictionary Reader specified by the DataSet,.

Parameters:

objITransferSyntax - TransferSyntax specified by the user

objIDictionaryReader_ - DictionaryReader specified by the user

IOD

public IOD(java.lang.String strFileName)
    throws java.io.IOException,
           InvalidIODException

Creates IOD from a DICOM file containing corresponding DICOM data.

Parameters:

strFileName - DICOM File with absolute path.

Throws:

java.io.IOException - signals Exception caused due to wrong I/O operations.

ParseException - signals if some parse exceptions occurred.

InvalidIODException

Method Detail

getDataSet

public IDataSet getDataSet()

This method provides the DataSet if and only if the IOD is valid according to the rules specified in the DICOM Standard PS3.

Returns:

objIDataSet - IOD returns the Dataset which is a transmission time entity in Dicom communication

getTransferSyntax

public ITransferSyntax getTransferSyntax()

This method returns the TransferSyntax set in the IOD.

Returns:

the transfer syntax

validate

public boolean validate()
                 throws InvalidIODException

This method validates IOD according to the Module Table given in The DICOM Standard. The validate method fails if one of the modules are present but are invalid because both the modules in IOD are user optional modules

Returns:

- function status indicating success or failure

Throws:

InvalidIODException - the invalid iod exception

removeModule

public boolean removeModule(java.lang.String strModuleName,
                   boolean isForceFullyDelete)

This method removes the module from the IOD.

Parameters:

strModuleName - String value of Module Name.

isForceFullyDelete - boolean variable which decides to delete the Module forcefully or not. if isForceFullyDelete is true then module is forcefully deleted. if isForceFullyDelete is false then module is deleted based on Validation Mode specified (LOW/HIGH/STRICT)

Returns:

boolean - returns true if module is deleted from the IOD otherwise false is returned.

isPresent

public boolean isPresent(int iGroupNumber,
                int iElementNumber)

Checks if the DataElement for the given GroupNumber,ElementNumber pair exists in IOD.

Parameters:

iGroupNumber - - Group Number of the DataElement.

iElementNumber - - Element Number of the DataElement.

Returns:

- true,if DataElement is present. false, if DataElement is absent.

isModulePresent

public boolean isModulePresent(java.lang.String strModuleName)

Checks whether the Module is present in the IOD or not.

Parameters:

strModuleName - String value of module name

Returns:

boolean - true if the module is present in the IOD, else false is returned.

removeDataElement

public boolean removeDataElement(java.lang.String strDataElementName,
                        boolean isForceFullyDelete)

This method removes the data element from the IOD.

Parameters:

strDataElementName - String name of the Data Element.

isForceFullyDelete - boolean variable which decides to delete the data element forcefully or not. if isForceFullyDelete is true then the data element is forcefully deleted. if isForceFullyDelete is false then the data element is deleted based on Validation Mode specified (LOW/HIGH/STRICT)

Returns:

boolean - returns true if the data element strDataElementName is deleted from the IOD otherwise false is returned.

addDataElement

public boolean addDataElement(java.lang.String strDataElementName,
                     java.lang.Object objValue)

This method adds the data element in IOD.

Parameters:

strDataElementName - Data Element Name that is to be added to the IOD.

objValue - - The value of the data element to be added in data set.

Returns:

boolean - true if the data element is added in IOD other wise false is returned.

dumpDICOMInfo

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

Dumps the name and value of contents of IOD that is, Module and its corresponding Attributes in readable form to the specified stream.

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.