cdac.medinfo.sdk.dcm30_04.dicommodel.study

Class StudyIOD

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.study.StudyIOD

public class StudyIOD
extends NormalizedIOD

The Study Information Object Definition is an abstraction of the information that describes a diagnostic imaging study. It includes such information as the reason for performing the study, the radiological procedure performed, and the time and date of the radiological procedure. The Study IOD is tailored by Service Class Definitions that use services that facilitate the exchange of Study-related information between DICOM Application Entities.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	STUDY_IOD The Constant STUDY_IOD.

Fields inherited from class cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NormalizedIOD

NORMALIZED_IOD

Constructor Summary

Constructors

Constructor and Description
StudyIOD() Instantiates a new study iod.
StudyIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
StudyIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
StudyIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
StudyIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
StudyIOD(java.lang.String strFileName) Creates StudyIOD IOD from a DICOM file containing StudyIOD DICOM data.

Method Summary

Methods

Modifier and Type	Method and Description
void	dumpDICOMInfo(IDicomStream objIDicomStream) Dumps the Name of IOD,Module and corresponding Attributs of Module.
SOPCommonModule	getSOPCommonModule() This method returns the SOPCommonModule with preinitializing it.
StudyAcquisitionModule	getStudyAcquisitionModule() This method returns the StudyAcquisitionModule with preinitializing it.
StudyClassificationModule	getStudyClassificationModule() This method returns the StudyIdentificationModule with preinitializing it.
StudyIdentificationModule	getStudyIdentificationModule() This method returns the StudyIdentificationModule with preinitializing it.
StudyReadModule	getStudyReadModule() This method returns the StudyReadModule with preinitializing it.
StudyRelationshipModule	getStudyRelationshipModule() This method returns the StudyRelationshipModule with preinitializing it.
StudySchedulingModule	getStudySchedulingModule() This method returns the StudySchedulingModule with preinitializing it.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.

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

addDataElement, getDataSet, getTransferSyntax, isPresent, removeDataElement, removeModule, validate

Methods inherited from class java.lang.Object

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

Field Detail

STUDY_IOD

public static final java.lang.String STUDY_IOD

The Constant STUDY_IOD.

See Also:

Constant Field Values

Constructor Detail

StudyIOD

public StudyIOD()

Instantiates a new study iod.

StudyIOD

public StudyIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

StudyIOD

public StudyIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - - specifies the DICOM Dictionary reader to be used .

StudyIOD

public StudyIOD(IDataSet objIDataSet_)

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

Parameters:

objIDataSet_ - - specifies the data set to be set in the IOD.

StudyIOD

public StudyIOD(ITransferSyntax objITransferSyntax_,
        IDictionaryReader objIDictionaryReader_)

This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.

Parameters:

objITransferSyntax_ - specifies the DICOM Standard defined TransfeSyntax.

objIDictionaryReader_ - specifies the DICOM Dictionary reader to be used .

StudyIOD

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

Creates StudyIOD IOD from a DICOM file containing StudyIOD DICOM data.

Parameters:

strFileName - DICOM File with absolute path.

Throws:

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

ParseException - signals if some parse exceptions are occurred.

InvalidIODException - signals if some IOD exceptions are occurred.

Method Detail

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

This method returns the SOPCommonModule with preinitializing it.

Returns:

instance of SOPCommonModule.

getStudyRelationshipModule

public StudyRelationshipModule getStudyRelationshipModule()

This method returns the StudyRelationshipModule with preinitializing it.

Returns:

instance of StudyRelationshipModule.

getStudyIdentificationModule

public StudyIdentificationModule getStudyIdentificationModule()

This method returns the StudyIdentificationModule with preinitializing it.

Returns:

instance of StudyIdentificationModule.

getStudyClassificationModule

public StudyClassificationModule getStudyClassificationModule()

This method returns the StudyIdentificationModule with preinitializing it.

Returns:

instance of StudyClassificationModule.

getStudySchedulingModule

public StudySchedulingModule getStudySchedulingModule()

This method returns the StudySchedulingModule with preinitializing it.

Returns:

instance of StudySchedulingModule.

getStudyAcquisitionModule

public StudyAcquisitionModule getStudyAcquisitionModule()

This method returns the StudyAcquisitionModule with preinitializing it.

Returns:

instance of StudyAcquisitionModule.

getStudyReadModule

public StudyReadModule getStudyReadModule()

This method returns the StudyReadModule with preinitializing it.

Returns:

instance of StudyReadModule.

dumpDICOMInfo

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

Dumps the Name of IOD,Module and corresponding Attributs of Module.

Overrides:

dumpDICOMInfo in class NormalizedIOD

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 NormalizedIOD

Parameters:

strModuleName - String value of module name

Returns:

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