cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class MultiFrameDimensionModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.MultiFrameDimensionModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class MultiFrameDimensionModule
extends Module

\* This module specifies the attributes of the Multi-frame Dimension Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
MultiFrameDimensionModule(IDataSet objIDataSet) Instantiates a new multi frame dimension module.

Method Summary

Methods

Modifier and Type	Method and Description
DimensionIndexSequence	getDimensionIndexSequence() Retrieves an instance of DimensionIndexSequence Uniquely identifies a set of dimensions referenced within the containing SOP Instance.
DimensionOrganizationSequence	getDimensionOrganizationSequence() Retrieves an instance of DimensionOrganizationSequencethat lists the Dimension Organization UIDs referenced by the containing SOP Instance.
java.lang.String	getDimensionOrganizationType() Returns Dimension Organization Type.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setDimensionOrganizationType(java.lang.String strDimensionOrganizationType) Sets Dimension Organization 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

MultiFrameDimensionModule

public MultiFrameDimensionModule(IDataSet objIDataSet)

Instantiates a new multi frame dimension 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

getDimensionOrganizationSequence

public DimensionOrganizationSequence getDimensionOrganizationSequence()

Retrieves an instance of DimensionOrganizationSequencethat lists the Dimension Organization UIDs referenced by the containing SOP Instance.

Returns:

- instance of Dimension Organization Sequence.

setDimensionOrganizationType

public void setDimensionOrganizationType(java.lang.String strDimensionOrganizationType)

Sets Dimension Organization Type

Parameters:

strDimensionOrganizationType - String value of Dimension Organization Type.

getDimensionOrganizationType

public java.lang.String getDimensionOrganizationType()

Returns Dimension Organization Type.

Returns:

String - String value of Dimension Organization Type.

getDimensionIndexSequence

public DimensionIndexSequence getDimensionIndexSequence()

Retrieves an instance of DimensionIndexSequence Uniquely identifies a set of dimensions referenced within the containing SOP Instance.

Returns:

- instance of Dimension Index 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:

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