cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class CompositeIOD

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.CompositeIOD

Direct Known Subclasses:

ImageIOD, NonImageIOD

public abstract class CompositeIOD
extends IOD

This class represents the Composite IODs which may consists of a collection of different types of modules. This category contains Image IODs as well as Non-Image IODs.

Constructor Summary

Constructors

Constructor and Description
CompositeIOD() Creates Composite IOD with default initialization.
CompositeIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
CompositeIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DataSet and DictionaryReader in its superclass IOD.
CompositeIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
CompositeIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the transfer syntax and DictionaryReader in its superclass IOD.
CompositeIOD(java.lang.String strFileName) Creates IOD from a DICOM file containing corresponding DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of Module and corresponding Attributs of IOD.
ClinicalTrialStudyModule	getClinicalTrialStudyModule() This method returns the ClinicalTrialStudyModule with preinitializing it.
ClinicalTrialSubjectModule	getClinicalTrialSubjectModule() This method returns the ClinicalTrialSubjectModule with preinitializing it.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Composite IOD according to the Module Table given in The DICOM Standard.

Methods inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IOD

addDataElement, getDataSet, getTransferSyntax, isPresent, removeDataElement, removeModule

Methods inherited from class java.lang.Object

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

Constructor Detail

CompositeIOD

public CompositeIOD()

Creates Composite IOD with default initialization.

CompositeIOD

public CompositeIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer syntax of IOD.

CompositeIOD

public CompositeIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DataSet and DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - the obj i dictionary reader_

CompositeIOD

public CompositeIOD(IDataSet objIDataSet_)

This constructor accepts the DataSet from the user in its superclass IOD.

Parameters:

objIDataSet_ - the obj i data set_

CompositeIOD

public CompositeIOD(ITransferSyntax objITransferSyntax_,
            IDictionaryReader objIDictionaryReader_)

This constructor initializes the transfer syntax and DictionaryReader in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer syntax of IOD.

objIDictionaryReader_ - Dictionary Reader used by IOD.

CompositeIOD

public CompositeIOD(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

getClinicalTrialSubjectModule

public ClinicalTrialSubjectModule getClinicalTrialSubjectModule()

This method returns the ClinicalTrialSubjectModule with preinitializing it.

Returns:

the clinical trial subject module

getClinicalTrialStudyModule

public ClinicalTrialStudyModule getClinicalTrialStudyModule()

This method returns the ClinicalTrialStudyModule with preinitializing it.

Returns:

the clinical trial study module

validate

public boolean validate()
                 throws InvalidIODException

This method validates Composite 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 Composite IOD are user optional modules

Overrides:

validate in class IOD

Returns:

- function status indicating success or failure

Throws:

InvalidIODException - the invalid iod exception

dumpDICOMInfo

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

Dumps the Name of Module and corresponding Attributs of IOD.

Specified by:

dumpDICOMInfo in class IOD

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.

isModulePresent

public boolean isModulePresent(java.lang.String strModuleName)

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

Overrides:

isModulePresent in class IOD

Parameters:

strModuleName - String value of module name

Returns:

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