cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class EncapsulatedDocumentSeriesModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.EncapsulatedDocumentSeriesModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class EncapsulatedDocumentSeriesModule
extends Module

This class defines the Encapsulated Document Series Attributes.

Author:

saloni

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
EncapsulatedDocumentSeriesModule(IDataSet objIDataSet)

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getModality() Retrieves Type of equipment that originally acquired the data used to create the images in this Series.
PerformedProcedureStepSummaryMacro	getPerformedProcedureStepSummaryMacro() Get the Instance of Performed Procedure Step Summary Macro Attributes.
java.lang.String	getProtocolName() Return Description of the conditions under which the Series was performed.
ReferencedPerformedProcedureStepSequence	getReferencedPerformedProcedureStepSequence() Returns provides the pre-initialized object of Referenced Performed Procedure Step 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
RequestAttributesSequence	getRequestAttributesSequence() Returns provides the pre-initialized object of Request Attributes 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
java.lang.String	getSeriesDescription() Return Description of the Series
SeriesDescriptionCodeSequence	getSeriesDescriptionCodeSequence() Returns provides the pre-initialized 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
java.lang.String	getSeriesInstanceUID() Retrieves a Unique identifier of the Series.
java.lang.String	getSeriesNumber() Retrieves a number that identifies the Series.
ISingleCollection<ITag>	getVectorOfKeys() Returns the collection of keys representing the DataElements that belong to this module.
void	setModality(EnumModality enumModality) Sets the Modality.
void	setProtocolName(java.lang.String strProtocolName) Sets Description of the conditions under which the Series was performed.
void	setSeriesDescription(java.lang.String strProtocolName) Set Description of the Series
void	setSeriesInstanceUID(java.lang.String strSeriesInstanceUID) Sets a Unique identifier of the Series.
void	setSeriesNumber(java.lang.String strSeriesNumber) Sets a number that identifies the Series.
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

EncapsulatedDocumentSeriesModule

public EncapsulatedDocumentSeriesModule(IDataSet objIDataSet)

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

Throws:

InvalidModuleException - - Throws when validation for any Module.

setModality

public void setModality(EnumModality enumModality)

Sets the Modality.

Parameters:

enumModality - : Type of equipment that originally acquired the data used to create the images in this Series.

getModality

public java.lang.String getModality()

Retrieves Type of equipment that originally acquired the data used to create the images in this Series.

Returns:

String - String value of Modality.

setSeriesInstanceUID

public void setSeriesInstanceUID(java.lang.String strSeriesInstanceUID)

Sets a Unique identifier of the Series.

Parameters:

strSeriesInstanceUID - String value of Unique identifier of the Series.

getSeriesInstanceUID

public java.lang.String getSeriesInstanceUID()

Retrieves a Unique identifier of the Series.

Returns:

String - value of Unique identifier of the Series.

setSeriesNumber

public void setSeriesNumber(java.lang.String strSeriesNumber)

Sets a number that identifies the Series.

Parameters:

strSeriesNumber - String value of number that identifies the Series.

getSeriesNumber

public java.lang.String getSeriesNumber()

Retrieves a number that identifies the Series.

Returns:

String - value of number that identifies the Series.

getReferencedPerformedProcedureStepSequence

public ReferencedPerformedProcedureStepSequence getReferencedPerformedProcedureStepSequence()

Returns provides the pre-initialized object of Referenced Performed Procedure Step 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

Returns:

- object of Referenced Performed Procedure Step Sequence.

setProtocolName

public void setProtocolName(java.lang.String strProtocolName)

Sets Description of the conditions under which the Series was performed.

Parameters:

strProtocolName - String value of Protocol Name

getProtocolName

public java.lang.String getProtocolName()

Return Description of the conditions under which the Series was performed.

Returns:

String - value of Protocol Name

setSeriesDescription

public void setSeriesDescription(java.lang.String strProtocolName)

Set Description of the Series

Parameters:

strProtocolName - String value of PSeriesDescription

getSeriesDescription

public java.lang.String getSeriesDescription()

Return Description of the Series

Returns:

String - value of SeriesDescription

getSeriesDescriptionCodeSequence

public SeriesDescriptionCodeSequence getSeriesDescriptionCodeSequence()

Returns provides the pre-initialized 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

Returns:

- object of RSeries Description Code Sequence

getRequestAttributesSequence

public RequestAttributesSequence getRequestAttributesSequence()

Returns provides the pre-initialized object of Request Attributes 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

Returns:

- object of Request Attributes Sequence

getPerformedProcedureStepSummaryMacro

public PerformedProcedureStepSummaryMacro getPerformedProcedureStepSummaryMacro()

Get the Instance of Performed Procedure Step Summary Macro Attributes.

Returns:

- object of Performed Procedure Step Summary Macro Attributes which the user programmer can populate

getVectorOfKeys

public ISingleCollection<ITag> getVectorOfKeys()

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 of tags