cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ClinicalTrialSeriesModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ClinicalTrialSeriesModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ClinicalTrialSeriesModule
extends Module

\* This module specifies attributes that identify a Series in the context of a clinical trial.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
ClinicalTrialSeriesModule(IDataSet objIDataSet) Creates Clinical Trial Series Module with default initialization.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClinicalTrialCooradinatingCenterName() Retrieves the name of the institution that is responsible for coordinating the medical imaging data for the clinical trial.
java.lang.String	getClinicalTrialSeriesDescription() Retrieves Clinical Trial Series Description.
java.lang.String	getClinicalTrialSeriesID() Retrieves Clinical Trial Series ID.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the collection of keys representing the DataElements that belong to this module.
void	setClinicalTrialCooradinatingCenterName(java.lang.String strClinicalTrialCooradinatingCenterName) The method is used to set The name of the institution that is responsible for coordinating the medical imaging data for the clinical trial.
void	setClinicalTrialSeriesDescription(java.lang.String strClinicalTrialSeriesDescription) Sets Clinical Trial Series Description.
void	setClinicalTrialSeriesID(java.lang.String strClinicalTrialSeriesID) Sets Clinical Trial Series ID.
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

ClinicalTrialSeriesModule

public ClinicalTrialSeriesModule(IDataSet objIDataSet)

Creates Clinical Trial Series 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

setClinicalTrialCooradinatingCenterName

public void setClinicalTrialCooradinatingCenterName(java.lang.String strClinicalTrialCooradinatingCenterName)

The method is used to set The name of the institution that is responsible for coordinating the medical imaging data for the clinical trial. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module HashMap

Parameters:

strClinicalTrialCooradinatingCenterName - The name of the clinical trial protocol.

getClinicalTrialCooradinatingCenterName

public java.lang.String getClinicalTrialCooradinatingCenterName()

Retrieves the name of the institution that is responsible for coordinating the medical imaging data for the clinical trial.

Returns:

String - name of the Clinical Trial Coordinating Center Name

setClinicalTrialSeriesID

public void setClinicalTrialSeriesID(java.lang.String strClinicalTrialSeriesID)

Sets Clinical Trial Series ID. An identifier of the series in the context of a clinical trial.

Parameters:

strClinicalTrialSeriesID - String value of Clinical Trial Series ID.

getClinicalTrialSeriesID

public java.lang.String getClinicalTrialSeriesID()

Retrieves Clinical Trial Series ID. An identifier of the series in the context of a clinical trial.

Returns:

String - String value of Clinical Trial Series ID.

setClinicalTrialSeriesDescription

public void setClinicalTrialSeriesDescription(java.lang.String strClinicalTrialSeriesDescription)

Sets Clinical Trial Series Description. A description of the series in the context of a clinical trial.

Parameters:

strClinicalTrialSeriesDescription - String value of Clinical Trial Series Description.

getClinicalTrialSeriesDescription

public java.lang.String getClinicalTrialSeriesDescription()

Retrieves Clinical Trial Series Description. A description of the series in the context of a clinical trial.

Returns:

String - String value of Clinical Trial Series Description.

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the collection of keys representing the DataElements that belong to this module.

Overrides:

getVectorOfKeys in class Module

Returns:

Collection of Tags - returns the collection containing the tags