cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class BasicAnnotationPresentationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.BasicAnnotationPresentationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class BasicAnnotationPresentationModule
extends Module

\* This module describes the attributes in Basic Annotation Presentation Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
BasicAnnotationPresentationModule(IDataSet objIDataSet) Creates Basic Annotation Presentation Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
short	getAnnotationPosition() Retrieves the position of the annotation box in the parent film box.
java.lang.String	getTextString() Retrieves Text string.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setAnnotationPosition(short sAnnotationPosition) Sets the position of the annotation box in the parent film box.
void	setTextString(java.lang.String strTextString) Sets Text string.
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

BasicAnnotationPresentationModule

public BasicAnnotationPresentationModule(IDataSet objIDataSet)

Creates Basic Annotation Presentation Module with default initialization.

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:

true, if validate module

Throws:

InvalidModuleException - - If validation of Module fails

setAnnotationPosition

public void setAnnotationPosition(short sAnnotationPosition)

Sets the position of the annotation box in the parent film box.

Parameters:

sAnnotationPosition - short value of Annotation Position.

getAnnotationPosition

public short getAnnotationPosition()

Retrieves the position of the annotation box in the parent film box.

Returns:

short - short value of Annotation Position.

setTextString

public void setTextString(java.lang.String strTextString)

Sets Text string.

Parameters:

strTextString - String value of Text string.

getTextString

public java.lang.String getTextString()

Retrieves Text string.

Returns:

String - String value of Text string.

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