cdac.medinfo.sdk.dcm30_04.dicommodel.print

Class StoredPrintIOD

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.print.StoredPrintIOD

public class StoredPrintIOD
extends NonImageIOD

The Stored Print IOD describes all the print parameters to print a single film. The Stored Print IOD contains one or more references to Image SOP Instances. There is a many to one relationship between the Stored Print IOD and the Printer IOD. Images referenced by the Stored Print IOD shall be Preformatted Grayscale or Preformatted Color Images or other grayscale images where all grayscale transformations up to and including VOI LUT have been applied.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
StoredPrintIOD() Instantiates a new stored print iod.
StoredPrintIOD(IDataSet objIDataSet_) This constructor accepts the DataSet from the user in its superclass IOD.
StoredPrintIOD(IDictionaryReader objIDictionaryReader_) This constructor initializes the DictionaryReader in its superclass IOD.
StoredPrintIOD(ITransferSyntax objITransferSyntax_) This constructor initializes the TransferSyntax in its superclass IOD.
StoredPrintIOD(ITransferSyntax objITransferSyntax_, IDictionaryReader objIDictionaryReader_) This constructor initializes the TransferSyntax and DictionaryReader in its super class IOD.
StoredPrintIOD(java.lang.String strFileName) Creates StoredPrintIOD IOD from a DICOM file containing StoredPrintIOD 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.
AnnotationListModule	getAnnotationListModule() Retrieves pre-initialized instance of Annotation List Module.
ClinicalTrialSeriesModule	getClinicalTrialSeriesModule() Retrieves pre-initialized instance of Clinical Trial Series Module.
FilmBoxModule	getFilmBoxModule() Retrieves pre-initialized instance of Film Box Module.
GeneralEquipmentModule	getGeneralEquipmentModule() Retrieves pre-initialized instance of General Equipment Module.
GeneralSeriesModule	getGeneralSeriesModule() Retrieves pre-initialized instance of General Series Module.
GeneralStudyModule	getGeneralStudyModule() Retrieves pre-initialized instance of General Study Module.
ImageBoxListModule	getImageBoxListModule() Retrieves pre-initialized instance of Image Box List Module.
ImageOverlayBoxListModule	getImageOverlayBoxListModule() Retrieves pre-initialized instance of Image Overlay Box List Module.
PatientModule	getPatientModule() Retrieves pre-initialized instance of Patient Module.
PatientStudyModule	getPatientStudyModule() Retrieves pre-initialized instance of Patient Study Module.
PresentationLUTListModule	getPresentationLUTListModule() Retrieves pre-initialized instance of Presentation LUT List Module.
PrinterCharacteristicsModule	getPrinterCharacteristicsModule() Retrieves pre-initialized instance of Printer Characteristics Module.
SOPCommonModule	getSOPCommonModule() Retrieves pre-initialized instance of SOP Common Module.
boolean	isModulePresent(java.lang.String strModuleName) Checks whether the Module is present in the IOD or not.
boolean	validate() This method validates Stored Print 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

STORED_PRINT_IOD

public static final java.lang.String STORED_PRINT_IOD

The Constant STORED_PRINT_IOD.

See Also:

Constant Field Values

Constructor Detail

StoredPrintIOD

public StoredPrintIOD()

Instantiates a new stored print iod.

StoredPrintIOD

public StoredPrintIOD(ITransferSyntax objITransferSyntax_)

This constructor initializes the TransferSyntax in its superclass IOD.

Parameters:

objITransferSyntax_ - - specifies the DICOM Standard defined TransfeSyntax.

StoredPrintIOD

public StoredPrintIOD(IDictionaryReader objIDictionaryReader_)

This constructor initializes the DictionaryReader in its superclass IOD.

Parameters:

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

StoredPrintIOD

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

StoredPrintIOD

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

StoredPrintIOD

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

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

getAnnotationListModule

public AnnotationListModule getAnnotationListModule()

Retrieves pre-initialized instance of Annotation List 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 AnnotationListModule.

getClinicalTrialSeriesModule

public ClinicalTrialSeriesModule getClinicalTrialSeriesModule()

Retrieves pre-initialized instance of Clinical Trial Series 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 ClinicalTrialSeriesModule.

getFilmBoxModule

public FilmBoxModule getFilmBoxModule()

Retrieves pre-initialized instance of Film Box 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 FilmBoxModule.

getGeneralEquipmentModule

public GeneralEquipmentModule getGeneralEquipmentModule()

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

- instance of GeneralEquipmentModule.

getGeneralStudyModule

public GeneralStudyModule getGeneralStudyModule()

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

getGeneralSeriesModule

public GeneralSeriesModule getGeneralSeriesModule()

Retrieves pre-initialized instance of General Series 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 GeneralSeriesModule.

getImageBoxListModule

public ImageBoxListModule getImageBoxListModule()

Retrieves pre-initialized instance of Image Box List 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 ImageBoxListModule.

getImageOverlayBoxListModule

public ImageOverlayBoxListModule getImageOverlayBoxListModule()

Retrieves pre-initialized instance of Image Overlay Box List 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 ImageOverlayBoxListModule.

getPatientModule

public PatientModule getPatientModule()

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

getPatientStudyModule

public PatientStudyModule getPatientStudyModule()

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

getPrinterCharacteristicsModule

public PrinterCharacteristicsModule getPrinterCharacteristicsModule()

Retrieves pre-initialized instance of Printer Characteristics 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 PrinterCharacteristicsModule.

getPresentationLUTListModule

public PresentationLUTListModule getPresentationLUTListModule()

Retrieves pre-initialized instance of Presentation LUT List 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 PresentationLUTListModule.

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 Stored Print 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.