cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class SOPCommonModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.SOPCommonModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class SOPCommonModule
extends Module

\* This module specifies the Attributes that describe SOP Common Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
SOPCommonModule(IDataSet objIDataSet) Instantiates a new sOP common module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAuthorizationEquipmentCertificationNumber() Retrieves Authorization Equipment Certification Number.
CodingSchemeIdentificationSequence	getCodingSchemeIdentificationSequence() This method provides the pre-initialized object of Contributing Equipment Sequence.
java.lang.String	getContentQualification() Retrieves Content Qualification Indicator.
ContributingEquipmentSequence	getContributingEquipmentSequence() This method provides the pre-initialized object of Contributing Equipment Sequence.
ConversionSourceAttributesSequence	getConversionSourceAttributesSequence() This method provides the pre-initialized object of Conversion Source Attributes Sequence.
DigitalSignaturesMacro	getDigitalSignaturesMacro() This method provides the Digital Signatures Macro which is the part of SOP Common Module.
EncryptedAttributesSequence	getEncryptedAttributesSequence() This method provides the pre-initialized object of Contributing Equipment Sequence.
HL7StructuredDocumentReferenceSequence	getHL7StructuredDocumentReferenceSequence() This method provides the pre-initialized object of HL7 Structured Document Reference Sequence.
java.lang.String	getInstanceCreationDate() Retrieves the Instance Creation Date.
java.lang.String	getInstanceCreationTime() Retrieves the Instance Creation Time.
java.lang.String	getInstanceCreatorUID() Retrieves the UID of Instance Creator.
java.lang.String	getInstanceNumber() Retrieves the Instance Number.
java.lang.String	getLongitudinalTemporalInformationModified() Retrieves Longitudinal Temporal Information Modified.
OriginalAttributesSequence	getOriginalAttributesSequence() This method provides the pre-initialized object of Original Attributes Sequence.
java.lang.String	getOriginalSpecializedSOPClassUID() Retrieves the Original Specialized SOP Class UID.
PrivateDataElementCharacteristicsSequence	getPrivateDataElementCharacteristicsSequence() This method provides the pre-initialized object of Private Data Element Characteristics Sequence.
java.lang.String	getQueryRetrieveView() Retrieves Query/Retrieve View.
java.lang.String[]	getRelatedGeneralSOPClassUID() Retrieves the UID of Related General SOP Class.
java.lang.String	getSOPAuthorizationComment() Retrieves the comment for SOP Authorization.
java.lang.String	getSOPAuthorizationDateandTime() Retrieves the SOP Authorization Date and Time.
java.lang.String	getSOPClassUID() Retrieves the UID of SOP Class.
java.lang.String	getSOPInstanceStatus() Retrieves the status of SOPInstance.
java.lang.String	getSOPInstanceUID() Retreives the UID of SOP Instance.
java.lang.String[]	getSpecificCharacterSet() Retrieves the Specific Character Set.
java.lang.String	getTimezoneOffsetFromUTC() Retrieves the Time zone Offset From UTC.
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	setAuthorizationEquipmentCertificationNumber(java.lang.String strAuthorizationEquipmentCertificationNumber) The method is used to set The certification number issued to the Application Entity that set the SOP Instance Status.
void	setContentQualification(EnumContentQualification enumContentQualification) Sets Content Qualification Indicator Enumerated Values: 1) PRODUCT 2) RESEARCH 3) SERVICE
void	setInstanceCreationDate(java.lang.String strInstanceCreationDate) The method is used to set Date the SOP Instance was created.
void	setInstanceCreationTime(java.lang.String strInstanceCreationTime) The method is used to set Time the SOP Instance was created.
void	setInstanceCreatorUID(java.lang.String strInstanceCreatorUID) The method is used to set Uniquely identifies device which created the SOP Instance.
void	setInstanceNumber(java.lang.String strInstanceNumber) The method is used to set A number that identifies this Composite object instance.
void	setLongitudinalTemporalInformationModified(EnumLongitudinalTemporalInformationModified enumLongitudinalTemporalInformationModified) Sets status of Longitudinal Temporal Information Modified.
void	setOriginalSpecializedSOPClassUID(java.lang.String strOriginalSpecializedSOPClassUID) The method is used to set The SOP Class in which the Instance was originally encoded, but which has been replaced during a fall-back conversion to the current Related General SOP Class.
void	setQueryRetrieveView(EnumQueryRetrieveView enumQueryRetrieveView) Sets Query/Retrieve View.
void	setRelatedGeneralSOPClassUID(java.lang.String[] arrStrRelatedGeneralSOPClassUID) This method is used to set Uniquely identifies a Related General SOP Class for the SOP Class of this Instance.
void	setSOPAuthorizationComment(java.lang.String strSOPAuthorizationComment) The method is used to set Any comments associated with the setting of the SOP Instance Status DE based on the transfer syntax and populates the DE with right values.
void	setSOPAuthorizationDateandTime(java.lang.String strSOPAuthorizationDateandTime) The method is used to set The date and time when the SOP Instance DE based on the transfer syntax and populates the DE with right values.
void	setSOPClassUID(java.lang.String strSOPClassUID) The method is used to set Unique identifier the SOP Class.
void	setSOPInstanceStatus(java.lang.String strSOPInstanceStatus) The method is used to set A flag that indicates the storage status of the SOP Instance.
void	setSOPInstanceUID(java.lang.String strSOPInstanceUID) The method is used to set Unique identifier the SOP Instance.
void	setSpecificCharacterSet(java.lang.String[] arrStrSpecificCharacterSet) This method is used to set Character Set that expands or replaces the Basic Graphic Set.
void	setTimezoneOffsetFromUTC(java.lang.String strTimezoneOffsetFromUTC) The method is used to set Contains the offset from UTC to the timezone for all DA and TM Attributes present in this SOP Instance.
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

SOPCommonModule

public SOPCommonModule(IDataSet objIDataSet)

Instantiates a new sOP common 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:

- returns validation status as success or failure.

Throws:

InvalidModuleException - If validation of Module fails.

setSOPClassUID

public void setSOPClassUID(java.lang.String strSOPClassUID)

The method is used to set Unique identifier the SOP Class. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strSOPClassUID - the str sop class uid

setSOPInstanceUID

public void setSOPInstanceUID(java.lang.String strSOPInstanceUID)

The method is used to set Unique identifier the SOP Instance. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strSOPInstanceUID - Unique identifier the SOP Instance.

setSpecificCharacterSet

public void setSpecificCharacterSet(java.lang.String[] arrStrSpecificCharacterSet)

This method is used to set Character Set that expands or replaces the Basic Graphic Set. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

arrStrSpecificCharacterSet - Character Set that expands or replaces the Basic Graphic Set.

setInstanceCreationDate

public void setInstanceCreationDate(java.lang.String strInstanceCreationDate)

The method is used to set Date the SOP Instance was created. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strInstanceCreationDate - Date the SOP Instance was created.

setInstanceCreationTime

public void setInstanceCreationTime(java.lang.String strInstanceCreationTime)

The method is used to set Time the SOP Instance was created. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strInstanceCreationTime - Time the SOP Instance was created.

setInstanceCreatorUID

public void setInstanceCreatorUID(java.lang.String strInstanceCreatorUID)

The method is used to set Uniquely identifies device which created the SOP Instance. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strInstanceCreatorUID - Uniquely identifies device which created the SOP Instance.

setRelatedGeneralSOPClassUID

public void setRelatedGeneralSOPClassUID(java.lang.String[] arrStrRelatedGeneralSOPClassUID)

This method is used to set Uniquely identifies a Related General SOP Class for the SOP Class of this Instance. The function accepts a String Value and creates the DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

arrStrRelatedGeneralSOPClassUID - Uniquely identifies a Related General SOP Class for the SOP Class of this Instance.

setOriginalSpecializedSOPClassUID

public void setOriginalSpecializedSOPClassUID(java.lang.String strOriginalSpecializedSOPClassUID)

The method is used to set The SOP Class in which the Instance was originally encoded, but which has been replaced during a fall-back conversion to the current Related General SOP Class. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strOriginalSpecializedSOPClassUID - Unique identifier of Original Specialized SOP Class.

setTimezoneOffsetFromUTC

public void setTimezoneOffsetFromUTC(java.lang.String strTimezoneOffsetFromUTC)

The method is used to set Contains the offset from UTC to the timezone for all DA and TM Attributes present in this SOP Instance. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strTimezoneOffsetFromUTC - Contains the offset from UTC to the timezone for all DA and TM Attributes present in this SOP Instance.

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

The method is used to set A number that identifies this Composite object instance. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strInstanceNumber - A number that identifies this Composite object instance.

setSOPInstanceStatus

public void setSOPInstanceStatus(java.lang.String strSOPInstanceStatus)

The method is used to set A flag that indicates the storage status of the SOP Instance. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strSOPInstanceStatus - A flag that indicates the storage status of the SOP Instance.

setSOPAuthorizationDateandTime

public void setSOPAuthorizationDateandTime(java.lang.String strSOPAuthorizationDateandTime)

The method is used to set The date and time when the SOP Instance DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strSOPAuthorizationDateandTime - The date and time when the SOP Instance

setSOPAuthorizationComment

public void setSOPAuthorizationComment(java.lang.String strSOPAuthorizationComment)

The method is used to set Any comments associated with the setting of the SOP Instance Status DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strSOPAuthorizationComment - Any comments associated with the setting of the SOP Instance Status

setAuthorizationEquipmentCertificationNumber

public void setAuthorizationEquipmentCertificationNumber(java.lang.String strAuthorizationEquipmentCertificationNumber)

The method is used to set The certification number issued to the Application Entity that set the SOP Instance Status. DE based on the transfer syntax and populates the DE with right values. This De is then added to the Module DataSet

Parameters:

strAuthorizationEquipmentCertificationNumber - The certification number issued to the Application Entity that set the SOP Instance Status.

setLongitudinalTemporalInformationModified

public void setLongitudinalTemporalInformationModified(EnumLongitudinalTemporalInformationModified enumLongitudinalTemporalInformationModified)

Sets status of Longitudinal Temporal Information Modified. Indicates whether or not the date and time attributes in the instance have been modified during de-identification. Enumerated Values: 1) UNMODIFIED 2) MODIFIED 3) REMOVED

Parameters:

enumLongitudinalTemporalInformationModified - the enum Longitudinal Temporal Information Modified

setQueryRetrieveView

public void setQueryRetrieveView(EnumQueryRetrieveView enumQueryRetrieveView)

Sets Query/Retrieve View. The view requested during the C-MOVE operation that resulted in the transfer of this instance. Enumerated Values: 1) CLASSIC 2) ENHANCED

Parameters:

enumQueryRetrieveView - the enum Query/Retrieve View

setContentQualification

public void setContentQualification(EnumContentQualification enumContentQualification)

Sets Content Qualification Indicator Enumerated Values: 1) PRODUCT 2) RESEARCH 3) SERVICE

Parameters:

enumContentQualification - the enum Content Qualification

getSOPClassUID

public java.lang.String getSOPClassUID()

Retrieves the UID of SOP Class.

Returns:

String - returns the UID of SOP Class

getSOPInstanceUID

public java.lang.String getSOPInstanceUID()

Retreives the UID of SOP Instance.

Returns:

String - retruns the SOP Instance UID

getSpecificCharacterSet

public java.lang.String[] getSpecificCharacterSet()

Retrieves the Specific Character Set.

Returns:

String[] - returns the Specific Character Set

getInstanceCreationDate

public java.lang.String getInstanceCreationDate()

Retrieves the Instance Creation Date.

Returns:

String - returns the Date of Instance Creation

getInstanceCreationTime

public java.lang.String getInstanceCreationTime()

Retrieves the Instance Creation Time.

Returns:

String - returns the Time of Instance Creation

getInstanceCreatorUID

public java.lang.String getInstanceCreatorUID()

Retrieves the UID of Instance Creator.

Returns:

String - return the Instance Creator UID

getRelatedGeneralSOPClassUID

public java.lang.String[] getRelatedGeneralSOPClassUID()

Retrieves the UID of Related General SOP Class.

Returns:

String - returns Related General SOP Class UID

getOriginalSpecializedSOPClassUID

public java.lang.String getOriginalSpecializedSOPClassUID()

Retrieves the Original Specialized SOP Class UID.

Returns:

String - returns the UID of Original Specialized SOP Class

getTimezoneOffsetFromUTC

public java.lang.String getTimezoneOffsetFromUTC()

Retrieves the Time zone Offset From UTC.

Returns:

String - returns Time zone Offset From UTC

getContributingEquipmentSequence

public ContributingEquipmentSequence getContributingEquipmentSequence()

This method provides the pre-initialized object of Contributing Equipment Sequence.

Returns:

objContributingEquipmentSequence - object of Contributing Equipment 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

getCodingSchemeIdentificationSequence

public CodingSchemeIdentificationSequence getCodingSchemeIdentificationSequence()

This method provides the pre-initialized object of Contributing Equipment Sequence.

Returns:

objCodingSchemeIdentificationSequence - object of Contributing Equipment 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

getEncryptedAttributesSequence

public EncryptedAttributesSequence getEncryptedAttributesSequence()

This method provides the pre-initialized object of Contributing Equipment Sequence.

Returns:

objEncryptedAttributesSequence - object of Contributing Equipment 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

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves the Instance Number.

Returns:

String - returns Instance Number

getSOPInstanceStatus

public java.lang.String getSOPInstanceStatus()

Retrieves the status of SOPInstance.

Returns:

String - returns SOP Instance Status

getSOPAuthorizationDateandTime

public java.lang.String getSOPAuthorizationDateandTime()

Retrieves the SOP Authorization Date and Time.

Returns:

String - returns SOP Authorization Date and Time

getSOPAuthorizationComment

public java.lang.String getSOPAuthorizationComment()

Retrieves the comment for SOP Authorization.

Returns:

String - returns SOP Authorization Comment

getAuthorizationEquipmentCertificationNumber

public java.lang.String getAuthorizationEquipmentCertificationNumber()

Retrieves Authorization Equipment Certification Number.

Returns:

String - the number of Authorization Equipment Certification

getOriginalAttributesSequence

public OriginalAttributesSequence getOriginalAttributesSequence()

This method provides the pre-initialized object of Original Attributes Sequence.

Returns:

- object of Original 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

getHL7StructuredDocumentReferenceSequence

public HL7StructuredDocumentReferenceSequence getHL7StructuredDocumentReferenceSequence()

This method provides the pre-initialized object of HL7 Structured Document Reference Sequence.

Returns:

- object of HL7 Structured Document Reference 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

getLongitudinalTemporalInformationModified

public java.lang.String getLongitudinalTemporalInformationModified()

Retrieves Longitudinal Temporal Information Modified.

Returns:

String - String value of Longitudinal Temporal Information Modified.

getQueryRetrieveView

public java.lang.String getQueryRetrieveView()

Retrieves Query/Retrieve View.

Returns:

String - String value of Query/Retrieve View.

getConversionSourceAttributesSequence

public ConversionSourceAttributesSequence getConversionSourceAttributesSequence()

This method provides the pre-initialized object of Conversion Source Attributes Sequence.

Returns:

- object of Conversion Source 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

getContentQualification

public java.lang.String getContentQualification()

Retrieves Content Qualification Indicator.

Returns:

String - String value of Content Qualification.

getPrivateDataElementCharacteristicsSequence

public PrivateDataElementCharacteristicsSequence getPrivateDataElementCharacteristicsSequence()

This method provides the pre-initialized object of Private Data Element Characteristics Sequence.

Returns:

- object of Private Data Element Characteristics 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

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

getDigitalSignaturesMacro

public DigitalSignaturesMacro getDigitalSignaturesMacro()

This method provides the Digital Signatures Macro which is the part of SOP Common Module.

Returns:

object of Digital Signatures Macro which can be populated by the user programmer