cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class AcquisitionContextModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.AcquisitionContextModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class AcquisitionContextModule
extends Module

\* This module specifies Attributes for description of the conditions present during data acquisition.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
AcquisitionContextModule(IDataSet objIDataSet) Instantiates a new acquisition context module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionContextDescription() Retrieves Free-text description of the image-acquisition context.
AcquisitionContextSequence	getAcquisitionContextSequence() Retrieves pre-initialized object of Acquisition Context 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.
void	setAcquisitionContextDescription(java.lang.String strAcquisitionContextDescription) Sets Free-text description of the image-acquisition context.
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

AcquisitionContextModule

public AcquisitionContextModule(IDataSet objIDataSet)

Instantiates a new acquisition context 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

setAcquisitionContextDescription

public void setAcquisitionContextDescription(java.lang.String strAcquisitionContextDescription)

Sets Free-text description of the image-acquisition context.

Parameters:

strAcquisitionContextDescription - String value of Acquisition Context Description.

getAcquisitionContextSequence

public AcquisitionContextSequence getAcquisitionContextSequence()

Retrieves pre-initialized object of Acquisition Context 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:

AcquisitionContextSequence - instance of Acquisition Context Sequence.

getAcquisitionContextDescription

public java.lang.String getAcquisitionContextDescription()

Retrieves Free-text description of the image-acquisition context.

Returns:

String - String value of Acquisition Context Description.

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