cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SRDocumentContentModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SRDocumentContentModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SRDocumentContentModule
extends Module

\* This module describes the attributes in SR Document Content Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SRDocumentContentModule(IDataSet objIDataSet) Instantiates a new sR document content module.

Method Summary

Methods

Modifier and Type	Method and Description
DocumentContentMacro	getDocumentContentMacro() Retrieves the instance of DocumentContentMacro.
DocumentRelationshipMacro	getDocumentRelationshipMacro() Retrieves the instance of Document Relationship Macro.
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

SRDocumentContentModule

public SRDocumentContentModule(IDataSet objIDataSet)

Instantiates a new sR document content 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

getDocumentContentMacro

public DocumentContentMacro getDocumentContentMacro()

Retrieves the instance of DocumentContentMacro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of DocumentContentMacro .

Returns:

- instance of DocumentContentMacro.

getDocumentRelationshipMacro

public DocumentRelationshipMacro getDocumentRelationshipMacro()

Retrieves the instance of Document Relationship Macro. If the instance is not already present a new instance is created and returned. It is used to set the attribtues of Document Relationship Macro .

Returns:

- instance of DocumentRelationshipMacro.

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