cdac.medinfo.sdk.dcm30_04.dicommodel.basicstudydescriptor

Class BasicStudyDescriptorIOD

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.basicstudydescriptor.BasicStudyDescriptorIOD

public class BasicStudyDescriptorIOD
extends NonImageIOD

The Basic Study Descriptor IOD specifies one or more Study Descriptor that are related to an Image.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BasicStudyDescriptorIOD() Instantiates a new standalone modality lutiod.
BasicStudyDescriptorIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
BasicStudyDescriptorIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
BasicStudyDescriptorIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
BasicStudyDescriptorIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
BasicStudyDescriptorIOD(java.lang.String strFileName) Creates BasicStudyDescriptorIOD IOD from a DICOM file containing BasicStudyDescriptorIOD 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.
PatientSummaryModule	getPatientSummaryModule() Retrieves pre-initialized instance of Patient Summary Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
StudyContentModule	getStudyContentModule() Retrieves pre-initialized instance of Study Content Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Basic Study Descriptor IOD according to the Module Table given in The DICOM Standard.

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

getClinicalTrialStudyModule, getClinicalTrialSubjectModule

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_Study_Descriptor_IOD

public static final java.lang.String Basic_Study_Descriptor_IOD

The Constant Basic_Study_Descriptor_IOD.

See Also:

Constant Field Values

Constructor Detail

BasicStudyDescriptorIOD

public BasicStudyDescriptorIOD()

Instantiates a new standalone modality lutiod.

BasicStudyDescriptorIOD

public BasicStudyDescriptorIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

BasicStudyDescriptorIOD

public BasicStudyDescriptorIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

BasicStudyDescriptorIOD

public BasicStudyDescriptorIOD(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.

BasicStudyDescriptorIOD

public BasicStudyDescriptorIOD(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 .

BasicStudyDescriptorIOD

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

Creates BasicStudyDescriptorIOD IOD from a DICOM file containing BasicStudyDescriptorIOD 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

getPatientSummaryModule

public PatientSummaryModule getPatientSummaryModule()

Retrieves pre-initialized instance of Patient Summary 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 PatientSummaryModule.

getStudyContentModule

public StudyContentModule getStudyContentModule()

Retrieves pre-initialized instance of Study Content 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 StudyContentModule.

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:

- instance of SOPCommonModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Basic Study Descriptor 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:

boolean - 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 IOD,Module and corresponding Attributs of Module.

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.