cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class DXSeriesModule

java.lang.Object

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.Module

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.DXSeriesModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class DXSeriesModule
extends Module

\* This module specifies the Attributes that identify and describe general information about the DX Series.

Field Summary

Fields

Modifier and Type	Field and Description
static ISingleCollection<ITag>	objSingleCollection The obj single collection.

Constructor Summary

Constructors

Constructor and Description
DXSeriesModule(IDataSet objIDataSet) Instantiates a new dX series module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getModality() Retrieves the Modality in General Series Module.
java.lang.String	getPresentationIntentType() Retrieves the intent of the images that are contained within this Series.
ReferencedPerformedProcedureStepSequence	getReferencedPerformedProcedureStepSequence() Retrieves the pre-initialized object of Referenced Performed Procedure Step Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.
SOPInstanceReferenceMacro	getSOPInstanceReferenceMacro() Retrieves the instance of SOPInstanceReferenceMacro.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setModality(EnumModality enumModality) Sets the Modality in General Series Module.
void	setPresentationIntentType(EnumPresentationIntentType enumPresentationIntentType) Sets the intent of the images that are contained within this Series.
boolean	validateModule() This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types.

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

add, dumpDICOMInfo, getDictionaryReader, getTransferSyntax, isPresent, isPresent, iterator, remove

Methods inherited from class java.lang.Object

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

Field Detail

objSingleCollection

public static ISingleCollection<ITag> objSingleCollection

The obj single collection.

Constructor Detail

DXSeriesModule

public DXSeriesModule(IDataSet objIDataSet)

Instantiates a new dX series module.

Parameters:

objIDataSet - the obj i data set

Method Detail

validateModule

public boolean validateModule()
                       throws InvalidModuleException

This method validates each Attribute in the Module according to the Type of the Attribute.Attributes are of 5 types. Type 1,Type 2 are Mandatory: Mandatory Attributes have to present in the Module. Type 1C,2C are Conditional: Conditional Attributes' presence depend on a condition. If the condition is satisfied the Attribute has to be present. Type 3 are Optional Optional Attributes can be added as and when required.

Specified by:

validateModule in interface IModule

Specified by:

validateModule in class Module

Returns:

- returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

setModality

public void setModality(EnumModality enumModality)

Sets the Modality in General Series Module.

Parameters:

enumModality - the enum modality

getModality

public java.lang.String getModality()

Retrieves the Modality in General Series Module.

Returns:

- String value of Modality.

getReferencedPerformedProcedureStepSequence

public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()

Retrieves the pre-initialized object of Referenced Performed Procedure Step Sequence.If the module contains the sequence object it returns the same otherwise it creates the sequence adds to the module with proper initialization and then returns the object of sequence.

Returns:

- object of Referenced Performed Procedure Step Sequence.

setPresentationIntentType

public void setPresentationIntentType(EnumPresentationIntentType enumPresentationIntentType)

Sets the intent of the images that are contained within this Series. Enumerated Values: FOR PRESENTATION, FOR PROCESSING.

Parameters:

enumPresentationIntentType - the enum presentation intent type

getPresentationIntentType

public java.lang.String getPresentationIntentType()

Retrieves the intent of the images that are contained within this Series.

Returns:

- String value of Presentation Intent Type.

getSOPInstanceReferenceMacro

public SOPInstanceReferenceMacro getSOPInstanceReferenceMacro()

Retrieves the instance of SOPInstanceReferenceMacro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of SOPInstanceReferenceMacro in CR Image Module.

Returns:

- instance of SOPInstanceReferenceMacro.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

- the customized collection containing the dataelement tags that belong to this module