cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class KeyObjectDocumentModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.KeyObjectDocumentModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class KeyObjectDocumentModule
extends Module

\* This module defines the general Attributes of a Key Object Selection Document. These Attributes identify and provide context for the Key Object Selection Document

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
KeyObjectDocumentModule(IDataSet objIDataSet) Instantiates a new key object document module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getContentDate() Retrieves the date the document content creation started.
java.lang.String	getContentTime() Retrieves the time the document content creation started.
CurrentRequestedProcedureEvidenceSequence	getCurrentRequestedProcedureEvidenceSequence() Retrieves pre-initialized object of CurrentRequestedProcedureEvidenceSequence.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
IdenticalDocumentsSequence	getIdenticalDocumentsSequence() Retrieves pre-initialized object of IdenticalDocumentsSequence.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
java.lang.String	getInstanceNumber() Retrieves a number number that identifies the Document.
ReferencedRequestSequence	getReferencedRequestSequence() Retrieves pre-initialized object of ReferencedRequestSequence.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 custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setContentDate(java.lang.String strContentDate) Sets the date the document content creation started.
void	setContentTime(java.lang.String strContentTime) Sets the time the document content creation started.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets a number number that identifies the Document.
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

KeyObjectDocumentModule

public KeyObjectDocumentModule(IDataSet objIDataSet)

Instantiates a new key object document 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

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets a number number that identifies the Document.

Parameters:

strInstanceNumber - String value of number number.

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves a number number that identifies the Document.

Returns:

String - String value of a number

setContentDate

public void setContentDate(java.lang.String strContentDate)

Sets the date the document content creation started.

Parameters:

strContentDate - String value of date

getContentDate

public java.lang.String getContentDate()

Retrieves the date the document content creation started.

Returns:

String - String value of a date

setContentTime

public void setContentTime(java.lang.String strContentTime)

Sets the time the document content creation started.

Parameters:

strContentTime - String value of time

getContentTime

public java.lang.String getContentTime()

Retrieves the time the document content creation started.

Returns:

String - String value of a time

getReferencedRequestSequence

public ReferencedRequestSequence getReferencedRequestSequence()

Retrieves pre-initialized object of ReferencedRequestSequence.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:

ReferencedRequestSequence - instance of ReferencedRequestSequence.

getCurrentRequestedProcedureEvidenceSequence

public CurrentRequestedProcedureEvidenceSequence getCurrentRequestedProcedureEvidenceSequence()

Retrieves pre-initialized object of CurrentRequestedProcedureEvidenceSequence.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:

CurrentRequestedProcedureEvidenceSequence - instance of CurrentRequestedProcedureEvidenceSequence.

getIdenticalDocumentsSequence

public IdenticalDocumentsSequence getIdenticalDocumentsSequence()

Retrieves pre-initialized object of IdenticalDocumentsSequence.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:

IdenticalDocumentsSequence - instance of IdenticalDocumentsSequence.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the custom collection containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.

Overrides:

getVectorOfKeys in class Module

Returns:

collection - custom collection containing the list of DataElements belonging to the CT Image Module