cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class OcularRegionImagedModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.OcularRegionImagedModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class OcularRegionImagedModule
extends Module

\* This module specifies the Attributes that identify the Ocular Region Imaged Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
OcularRegionImagedModule(IDataSet objIDataSet) Instantiates a new ocular region imaged module.

Method Summary

Methods

Modifier and Type	Method and Description
GeneralAnatomyMandatoryMacro	getGeneralAnatomyMandatoryMacro() Returns instance of GeneralAnatomyMandatoryMacro.
java.lang.String	getImageLaterality() Retrieves Laterality of object imaged (as described in Anatomic Region Sequence (0008,2218)) examined.
RelativeImagePositionCodeSequence	getRelativeImagePositionCodeSequence() This method Returns provides the pre-initialized object of Relative Image Position Code Sequence return - object of Relative Image Position Code Sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setImageLaterality(EnumImageLaterality enumImageLaterality) Sets Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined.
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

OcularRegionImagedModule

public OcularRegionImagedModule(IDataSet objIDataSet)

Instantiates a new ocular region imaged module.

Parameters:

objIDataSet - the obj i data set

Method Detail

setImageLaterality

public void setImageLaterality(EnumImageLaterality enumImageLaterality)

Sets Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined. Enumerated Values: R = right L = left U = unpaired B = both left and right

Parameters:

enumImageLaterality - the enum image laterality

getImageLaterality

public java.lang.String getImageLaterality()

Retrieves Laterality of object imaged (as described in Anatomic Region Sequence (0008,2218)) examined.

Returns:

the image laterality

getRelativeImagePositionCodeSequence

public RelativeImagePositionCodeSequence getRelativeImagePositionCodeSequence()

This method Returns provides the pre-initialized object of Relative Image Position Code Sequence return - object of Relative Image Position Code Sequence. If the module contans 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:

SourceImageSequence - the Relative Image Position Code Sequence

getGeneralAnatomyMandatoryMacro

public GeneralAnatomyMandatoryMacro getGeneralAnatomyMandatoryMacro()

Returns instance of GeneralAnatomyMandatoryMacro.

Returns:

Instance of GeneralAnatomyMandatoryMacro

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:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - - If validation of Module fails

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:

vector of Tags - returns the vector containing the collection of tags