cdac.medinfo.sdk.dcm30_04.dicommodel.basicstructureddisplay

Class BasicStructuredDisplayIOD

java.lang.Object

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

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.NonImageIOD

cdac.medinfo.sdk.dcm30_04.dicommodel.basicstructureddisplay.BasicStructuredDisplayIOD

public class BasicStructuredDisplayIOD
extends NonImageIOD

The Basic Structured Display Information Object Definition (IOD) specifies an instance of a single screen structured display that hasbeen created for a patient.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BasicStructuredDisplayIOD() Instantiates a new image iod.
BasicStructuredDisplayIOD(IDataSet objIDataSet_) This constructor accepts the Data set from the user in its superclass IOD.
BasicStructuredDisplayIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes DictionaryReader in its superclass IOD.
BasicStructuredDisplayIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
BasicStructuredDisplayIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor accepts the DictionaryReader and TransferSyntax from the user in its superclass IOD.
BasicStructuredDisplayIOD(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.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Gets the clinical trial series module.
ClinicalTrialStudyModule	getClinicalTrialStudyModule() This method returns the ClinicalTrialStudyModule with preinitializing it.
ClinicalTrialSubjectModule	getClinicalTrialSubjectModule() This method returns the ClinicalTrialSubjectModule with preinitializing it.
CommonInstanceReferenceModule	getCommonInstanceReferenceModule() Retrieves pre-initialized instance of Common Instance Reference Module.
EnhancedGeneralEquipmentModule	getEnhancedGeneralEquipmentModule() Retrieves pre-initialized instance of Enhanced General Equipment Module.
GeneralEquipmentModule	getGeneralEquipmentModule() This method returns the GeneralEquipmentModule with preinitializing it.
GeneralSeriesModule	getGeneralSeriesModule() This method returns the GeneralSeriesModule with preinitializing it.
GeneralStudyModule	getGeneralStudyModule() This method returns the GeneralStudyModule with preinitializing it.
PatientModule	getPatientModule() This method returns the PatientModule with preinitializing it.
PatientStudyModule	getPatientStudyModule() This method returns the PatientStudyModule with preinitializing it.
PresentationSeriesModule	getPresentationSeriesModule() Retrieves pre-initialized instance of PresentationSeriesModule.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
StructuredDisplayAnnotationModule	getStructuredDisplayAnnotationModule() Retrieves pre-initialized instance of StructuredDisplayAnnotationModule .
StructuredDisplayImageBoxModule	getStructuredDisplayImageBoxModule() Retrieves pre-initialized instance of StructuredDisplayImageBoxModule.
StructuredDisplayModule	getStructuredDisplayModule() Retrieves pre-initialized instance of Structured Display Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Image 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

Field Detail

BASIC_STRUCTURED_DISPLAY_IOD

public static final java.lang.String BASIC_STRUCTURED_DISPLAY_IOD

The Constant BASIC_STRUCTURED_DISPLAY_IOD.

See Also:

Constant Field Values

Constructor Detail

BasicStructuredDisplayIOD

public BasicStructuredDisplayIOD()

Instantiates a new image iod.

BasicStructuredDisplayIOD

public BasicStructuredDisplayIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer Syntax of IOD.

BasicStructuredDisplayIOD

public BasicStructuredDisplayIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes DictionaryReader in its superclass IOD.

Parameters:

objIDictionaryReader_ - Dictionary Reader used by the IOD.

BasicStructuredDisplayIOD

public BasicStructuredDisplayIOD(ITransferSyntax objITransferSyntax_,
                         IDictionaryReader objIDictionaryReader_)

This constructor accepts the DictionaryReader and TransferSyntax from the user in its superclass IOD.

Parameters:

objITransferSyntax_ - Transfer Syntax of IOD.

objIDictionaryReader_ - Dictionary Reader used by the IOD.

BasicStructuredDisplayIOD

public BasicStructuredDisplayIOD(IDataSet objIDataSet_)

This constructor accepts the Data set from the user in its superclass IOD.

Parameters:

objIDataSet_ - the obj i data set_

BasicStructuredDisplayIOD

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

getPatientModule

public PatientModule getPatientModule()

This method returns the PatientModule with preinitializing it.

Returns:

the patient module

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

This method returns the GeneralStudyModule with preinitializing it.

Returns:

the general study module

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

This method returns the PatientStudyModule with preinitializing it.

Returns:

the patient study module

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Gets the clinical trial series module.

Returns:

the clinical trial series module

getGeneralSeriesModule

public GeneralSeriesModule getGeneralSeriesModule()

This method returns the GeneralSeriesModule with preinitializing it.

Returns:

the general series module

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

This method returns the GeneralEquipmentModule with preinitializing it.

Returns:

the general equipment module

getClinicalTrialSubjectModule

public ClinicalTrialSubjectModule getClinicalTrialSubjectModule()

This method returns the ClinicalTrialSubjectModule with preinitializing it.

Overrides:

getClinicalTrialSubjectModule in class CompositeIOD

Returns:

the clinical trial subject module

getClinicalTrialStudyModule

public ClinicalTrialStudyModule getClinicalTrialStudyModule()

This method returns the ClinicalTrialStudyModule with preinitializing it.

Overrides:

getClinicalTrialStudyModule in class CompositeIOD

Returns:

the clinical trial study module

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

Retrieves pre-initialized instance of SOP Common Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

SOPCommonModule - instance of SOPCommonModule.

getCommonInstanceReferenceModule

public CommonInstanceReferenceModule getCommonInstanceReferenceModule()

Retrieves pre-initialized instance of Common Instance Reference Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

- instance of CommonInstanceReferenceModule.

getEnhancedGeneralEquipmentModule

public EnhancedGeneralEquipmentModule getEnhancedGeneralEquipmentModule()

Retrieves pre-initialized instance of Enhanced General Equipment Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

EnhancedGeneralEquipmentModule - instance of EnhancedGeneralEquipmentModule.

getPresentationSeriesModule

public PresentationSeriesModule getPresentationSeriesModule()

Retrieves pre-initialized instance of PresentationSeriesModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

PresentationSeriesModule - instance of PresentationSeriesModule.

getStructuredDisplayModule

public StructuredDisplayModule getStructuredDisplayModule()

Retrieves pre-initialized instance of Structured Display Module. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

StructuredDisplayModule - instance of StructuredDisplayModule.

getStructuredDisplayImageBoxModule

public StructuredDisplayImageBoxModule getStructuredDisplayImageBoxModule()

Retrieves pre-initialized instance of StructuredDisplayImageBoxModule. Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

StructuredDisplayImageBoxModule - instance of StructuredDisplayImageBoxModule.

getStructuredDisplayAnnotationModule

public StructuredDisplayAnnotationModule getStructuredDisplayAnnotationModule()

Retrieves pre-initialized instance of StructuredDisplayAnnotationModule . Creates a new instance if no pre-existing module instance is available.If previously created instance is present then returns the same module instance.

Returns:

StructuredDisplayAnnotationModule - instance of StructuredDisplayAnnotationModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Image IOD according to the Module Table given in The DICOM Standard. The validate method fails if one of the mandatory modules are absent or any of the modules are invalid. The validate method also checks for conditional modules.

Overrides:

validate in class NonImageIOD

Returns:

- status of validation as 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.

Overrides:

dumpDICOMInfo in class CompositeIOD

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 NonImageIOD

Parameters:

strModuleName - String value of module name

Returns:

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