cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class ClinicalTrialStudyModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.ClinicalTrialStudyModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class ClinicalTrialStudyModule
extends Module

This class specifies attributes that identify a Study 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
ClinicalTrialStudyModule(IDataSet objIDataSet) Instantiates a new clinical trial study module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getClinicalTrialTimePointDescription() Retrieves Clinical Trial Time Point Description.
java.lang.String	getClinicalTrialTimePointID() Retrieves Clinical Trial Time Point ID.
ConsentforClinicalTrialUseSequence	getConsentforClinicalTrialUseSequence() This method provides the pre-initialized object of Consent for Clinical Trial Use Sequence.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector containing the list of DataElements belonging to the CT Image Module specified by DICOM Standard.
void	setClinicalTrialTimePointDescription(java.lang.String strClinicalTrialTimePointDescription) This method is used to set the Clinical Trial Time Point Description in Clinical Trial Study Module.
void	setClinicalTrialTimePointID(java.lang.String strClinicalTrialTimePointID) This method is used to set the Clinical Trial Time Point ID in Clinical Trial Study 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

ClinicalTrialStudyModule

public ClinicalTrialStudyModule(IDataSet objIDataSet)

Instantiates a new clinical trial study module.

Parameters:

objIDataSet - the obj i data set

Method Detail

setClinicalTrialTimePointID

public void setClinicalTrialTimePointID(java.lang.String strClinicalTrialTimePointID)

This method is used to set the Clinical Trial Time Point ID in Clinical Trial Study Module.

Parameters:

strClinicalTrialTimePointID - : An identifier specifying the one or more studies that are grouped together as a clinical time point or submission in a clinical trial.

setClinicalTrialTimePointDescription

public void setClinicalTrialTimePointDescription(java.lang.String strClinicalTrialTimePointDescription)

This method is used to set the Clinical Trial Time Point Description in Clinical Trial Study Module.

Parameters:

strClinicalTrialTimePointDescription - : A description of a set of one or more studies that are grouped together to represent a clinical time point or submission in a clinical trial.

getClinicalTrialTimePointID

public java.lang.String getClinicalTrialTimePointID()

Retrieves Clinical Trial Time Point ID.

Returns:

String - String value of Clinical Trial Time Point ID

getClinicalTrialTimePointDescription

public java.lang.String getClinicalTrialTimePointDescription()

Retrieves Clinical Trial Time Point Description.

Returns:

String - String value of Clinical Trial Time Point Description

getConsentforClinicalTrialUseSequence

public ConsentforClinicalTrialUseSequence getConsentforClinicalTrialUseSequence()

This method provides the pre-initialized object of Consent for Clinical Trial Use Sequence.

Returns:

- object of Consent for Clinical Trial Use 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

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 - status indicating success or failure

Throws:

InvalidModuleException - - If validation of Module fails

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

This method returns the vector 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