cdac.medinfo.sdk.dcm30_04.dicommodel.sr

Class BasicTextSRIOD

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.sr.BasicTextSRIOD

public class BasicTextSRIOD
extends NonImageIOD

The Basic Text Structured Report (SR) IOD is intended for the representation of reports with minimal usage of coded entries (typically used in Document Title and headings) and a hierarchical tree of headings under which may appear text and subheadings. Reference to SOP Instances (e.g. images or waveforms or other SR Documents) is restricted to appear at the level of the leaves of this primarily textual tree. This structure simplifies the encoding of conventional textual reports as SR Documents, as well as their rendering.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BasicTextSRIOD() Instantiates a new basic text sriod.
BasicTextSRIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
BasicTextSRIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
BasicTextSRIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
BasicTextSRIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
BasicTextSRIOD(java.lang.String strFileName) Creates BasicTextSRIOD IOD from a DICOM file containing BasicTextSRIOD 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.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of ClinicalTrialSeriesModule.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of GeneralEquipmentModule.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of GeneralStudyModule.
PatientModule	getPatientModule() Retrieves pre-initialized instance of PatientModule.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of PatientStudyModule.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOPCommonModule.
SRDocumentContentModule	getSRDocumentContentModule() Retrieves pre-initialized instance of SRDocumentContentModule.
SRDocumentGeneralModule	getSRDocumentGeneralModule() Retrieves pre-initialized instance of SRDocumentGeneralModule.
SRDocumentSeriesModule	getSRDocumentSeriesModule() Retrieves pre-initialized instance of SRDocumentSeriesModule.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Non-Image IOD Basic Text SRIOD 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_TEXT_SR_IOD

public static final java.lang.String BASIC_TEXT_SR_IOD

The Constant BASIC_TEXT_SR_IOD.

See Also:

Constant Field Values

Constructor Detail

BasicTextSRIOD

public BasicTextSRIOD()

Instantiates a new basic text sriod.

BasicTextSRIOD

public BasicTextSRIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

BasicTextSRIOD

public BasicTextSRIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

BasicTextSRIOD

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

BasicTextSRIOD

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

BasicTextSRIOD

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

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

getPatientModule

public PatientModule getPatientModule()

Retrieves pre-initialized instance of PatientModule. 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:

PatientModule - instance of PatientModule.

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

Retrieves pre-initialized instance of GeneralStudyModule. 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:

GeneralStudyModule - instance of GeneralStudyModule.

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

Retrieves pre-initialized instance of PatientStudyModule. 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:

PatientStudyModule - instance of PatientStudyModule.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Retrieves pre-initialized instance of ClinicalTrialSeriesModule. 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:

ClinicalTrialSeriesModule - instance of ClinicalTrialSeriesModule.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

Retrieves pre-initialized instance of GeneralEquipmentModule. 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:

GeneralEquipmentModule - instance of GeneralEquipmentModule.

getSOPCommonModule

public SOPCommonModule getSOPCommonModule()

Retrieves pre-initialized instance of SOPCommonModule. 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.

getSRDocumentSeriesModule

public SRDocumentSeriesModule getSRDocumentSeriesModule()

Retrieves pre-initialized instance of SRDocumentSeriesModule. 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:

SRDocumentSeriesModule - instance of SRDocumentSeriesModule.

getSRDocumentGeneralModule

public SRDocumentGeneralModule getSRDocumentGeneralModule()

Retrieves pre-initialized instance of SRDocumentGeneralModule. 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:

SRDocumentGeneralModule - instance of SRDocumentGeneralModule.

getSRDocumentContentModule

public SRDocumentContentModule getSRDocumentContentModule()

Retrieves pre-initialized instance of SRDocumentContentModule. 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:

SRDocumentContentModule - instance of SRDocumentContentModule.

validate

public boolean validate()
                 throws InvalidIODException

This method validates Non-Image IOD Basic Text SRIOD 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 - status of validation as success or failure

Throws:

InvalidIODException - throws when the IOD is invalid.

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.