cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class KeyObjectDocumentSeriesModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.KeyObjectDocumentSeriesModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class KeyObjectDocumentSeriesModule
extends Module

\* This module contains Attributes of the Key Object Document Series Module.

Field Summary

Fields

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

Constructor Summary

Constructors

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getModality() Retrieves the Type of equipment that originally acquired the data.
java.lang.String	getProtocolName() Retrieves Protocol Name.
ReferencedPerformedProcedureStepSequence	getReferencedPerformedProcedureStepSequence() Retrieves pre-initialized object of ReferencedPerformedProcedureStepSequence.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	getSeriesDate() Retrieves Series Date.
java.lang.String	getSeriesDescription() Retrieves Series Description.
SeriesDescriptionCodeSequence	getSeriesDescriptionCodeSequence() This method provides the pre-initialized object of Series Description Code Sequence.
java.lang.String	getSeriesInstanceUID() Retrieves the Unique identifier of the Series.
java.lang.String	getSeriesNumber() Retrieves A number that identifies the Series.
java.lang.String	getSeriesTime() Retrieves Series Time.
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
void	setModality(EnumModality enumModality) Sets the Type of equipment that originally acquired the data.
void	setProtocolName(java.lang.String strProtocolName) Sets the protocol name.
void	setSeriesDate(java.lang.String strSeriesDate) Sets the series date.
void	setSeriesDescription(java.lang.String strSeriesDescription) Sets the series description.
void	setSeriesInstanceUID(java.lang.String strSeriesInstanceUID) Sets the Unique identifier of the Series.
void	setSeriesNumber(java.lang.String strSeriesNumber) Sets A number that identifies the Series.
void	setSeriesTime(java.lang.String strSeriesTime) Sets the series time.
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

KeyObjectDocumentSeriesModule

public KeyObjectDocumentSeriesModule(IDataSet objIDataSet)

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

setModality

public void setModality(EnumModality enumModality)

Sets the Type of equipment that originally acquired the data.

Parameters:

enumModality - Enum value of the Type of equipment

getModality

public java.lang.String getModality()

Retrieves the Type of equipment that originally acquired the data.

Returns:

String - String value of the Type of equipment

setSeriesInstanceUID

public void setSeriesInstanceUID(java.lang.String strSeriesInstanceUID)

Sets the Unique identifier of the Series.

Parameters:

strSeriesInstanceUID - String value of number that identifies this Series

getSeriesInstanceUID

public java.lang.String getSeriesInstanceUID()

Retrieves the Unique identifier of the Series.

Returns:

String - String value of a number that identifies this Series.

setSeriesNumber

public void setSeriesNumber(java.lang.String strSeriesNumber)

Sets A number that identifies the Series.

Parameters:

strSeriesNumber - the str series number

getSeriesNumber

public java.lang.String getSeriesNumber()

Retrieves A number that identifies the Series.

Returns:

String - String value of a number that identifies this Series.

setSeriesDate

public void setSeriesDate(java.lang.String strSeriesDate)

Sets the series date.

Parameters:

strSeriesDate - : Date the Series started.

getSeriesDate

public java.lang.String getSeriesDate()

Retrieves Series Date.

Returns:

String - String value of SeriesDate

setSeriesTime

public void setSeriesTime(java.lang.String strSeriesTime)

Sets the series time.

Parameters:

strSeriesTime - : Time the Series started.

getSeriesTime

public java.lang.String getSeriesTime()

Retrieves Series Time.

Returns:

String - String value of Series Time.

setProtocolName

public void setProtocolName(java.lang.String strProtocolName)

Sets the protocol name.

Parameters:

strProtocolName - : User-defined description of the conditions under which the Series was performed.

getProtocolName

public java.lang.String getProtocolName()

Retrieves Protocol Name.

Returns:

String - String value of Protocol Name.

setSeriesDescription

public void setSeriesDescription(java.lang.String strSeriesDescription)

Sets the series description.

Parameters:

strSeriesDescription - : User provided description of the Series

getSeriesDescription

public java.lang.String getSeriesDescription()

Retrieves Series Description.

Returns:

String - String value of SeriesDescription.

getSeriesDescriptionCodeSequence

public SeriesDescriptionCodeSequence getSeriesDescriptionCodeSequence()

This method provides the pre-initialized object of Series Description Code Sequence.

Returns:

- object of Series Description Code 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

getReferencedPerformedProcedureStepSequence

public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()

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

ReferencedPerformedProcedureStepSequence - instance of ReferencedPerformedProcedureStepSequence.

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.