cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class IntraOralImageModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.IntraOralImageModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class IntraOralImageModule
extends Module

\* This module contains IOD Attributes that describe a Digital Intra-oral X-Ray Image including its acquisition and positioning.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
IntraOralImageModule(IDataSet objIDataSet) Instantiates a new intra oral image module.

Method Summary

Methods

Modifier and Type	Method and Description
AnatomicRegionSequence	getAnatomicRegionSequence() Retrieves an instance of AnatomicRegionSequence which identifies the anatomic region of interest in this image.
java.lang.String	getImageLaterality() Retrieves Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined.
java.lang.String	getPositionerType() Retrieves Positioner Type.
PrimaryAnatomicStructureSequence	getPrimaryAnatomicStructureSequence() Retrieves an instance of PrimaryAnatomicStructureSequence which describes the primary anatomic structures of interest in this image.
ISingleCollection<ITag>	getVectorOfKeys() Returns the custom collection containing the list of DataElements belonging to the Mammographic Series Module specified by DICOM Standard.
void	setImageLaterality(EnumImageLaterality enumImageLaterality) Sets Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined.
void	setPositionerType(EnumPositionerType enumPositionerType) Sets Positioner Type.
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

IntraOralImageModule

public IntraOralImageModule(IDataSet objIDataSet)

Instantiates a new intra oral image 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:

- validation status as success or failure

Throws:

InvalidModuleException - - when the module is invalid

setPositionerType

public void setPositionerType(EnumPositionerType enumPositionerType)

Sets Positioner Type. Enumerated Values: MAMMOGRAPHIC,NONE.

Parameters:

enumPositionerType - the enum positioner type

getPositionerType

public java.lang.String getPositionerType()

Retrieves Positioner Type.

Returns:

String - String value of Positioner Type.

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 - - Enum value of Image Laterality.

getImageLaterality

public java.lang.String getImageLaterality()

Retrieves Laterality of (possibly paired) body part (as described in Anatomic Region Sequence(0008,2218)) examined.

Returns:

String - String value of Image Laterality.

getAnatomicRegionSequence

public AnatomicRegionSequence getAnatomicRegionSequence()

Retrieves an instance of AnatomicRegionSequence which identifies the anatomic region of interest in this image.

Returns:

AnatomicRegionSequence - instance of Anatomic Region Sequence.

getPrimaryAnatomicStructureSequence

public PrimaryAnatomicStructureSequence getPrimaryAnatomicStructureSequence()

Retrieves an instance of PrimaryAnatomicStructureSequence which describes the primary anatomic structures of interest in this image.

Returns:

PrimaryAnatomicStructureSequence - instance of Primary Anatomic Structure Sequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

Returns the custom collection containing the list of DataElements belonging to the Mammographic Series Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

ISingleCollection - custom collection containing the list of DataElements.