cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class DisplayedAreaModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.DisplayedAreaModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class DisplayedAreaModule
extends Module

\* This module describes Attributes required to define a Specified Displayed Area space.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
DisplayedAreaModule(IDataSet objIDataSet) Instantiates a new displayed area module.

Method Summary

Methods

Modifier and Type	Method and Description
DisplayedAreaSelectionSequence	getDisplayedAreaSelectionSequence() Retrieves pre-initialized object of Displayed Area Selection 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
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
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

DisplayedAreaModule

public DisplayedAreaModule(IDataSet objIDataSet)

Instantiates a new displayed area 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:

boolean - returns validation status as success or failure

Throws:

InvalidModuleException - If validation of Module fails

getDisplayedAreaSelectionSequence

public DisplayedAreaSelectionSequence getDisplayedAreaSelectionSequence()

Retrieves pre-initialized object of Displayed Area Selection 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:

DisplayedAreaSelectionSequence - instance of Displayed Area Selection Sequence.

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.