cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class EncapsulatedDocumentModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.EncapsulatedDocumentModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class EncapsulatedDocumentModule
extends Module

This Module specifies the Attributes that identify and describe general information about Encapsulated Document.

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
EncapsulatedDocumentModule(IDataSet objIDataSet) Instantiates a new EncapsulatedDocumentModule

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getAcquisitionDateTime() Retrieves date and time that the original generation of the data in the document started
java.lang.String	getBurnedInAnnotation() Returns Indicates whether or not the encapsulated document contains sufficient burned in annotation to identify the patient and date the data was acquired.
ConceptNameCodeSequence	getConceptNameCodeSequence() Retrieves Concept Name CodeSequence
java.lang.String	getContentDate() Retrieves date the content creation started.
java.lang.String	getContentTime() Retrieves time the content creation started
DocumentClassCodeSequence	getDocumentClassCodeSequence() Retrieves Document Class Code Sequence
java.lang.String	getDocumentTitle() Retrieves the title of the document.
ISingleCollection<byte[]>	getEncapsulatedDocument() Retrieves the Encapsulated Document stream,containing a document encoded according to the MIME Type.
java.lang.String	getHL7InstanceIdentifier() Retrieves the Instance Identifier of the encapsulated HL7 Structured Document,encoded as a UID (OID or UUID), concatenated with a caret ("^") andExtension value (if Extension is present in Instance Identifier
java.lang.String	getImageLaterality() Returns Laterality of the (possibly paired) body part that is the subject of the encapsulated document.
java.lang.String	getInstanceNumber() Retrieves A number that identifies this SOP Instance.
java.lang.String[]	getListOfMIMETypes() Return List of MIME Types
java.lang.String	getMIMETypeOfEncapsulatedDocument() Return MIME Type of EncapsulatedDocument
java.lang.String	getRecognizableVisualFeatures() Returns Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set ofimages to identify the patient.
SourceInstanceSequence	getSourceInstanceSequence() Retrieves Source Instance Sequence
ISingleCollection<ITag>	getVectorOfKeys() This method returns the vector of keys representing the DataElements that belong to this module.
java.lang.String	getVerificationFlag() Returns whether the Encapsulated Document is Verified
void	setAcquisitionDateTime(java.lang.String strAcquisitionDateTime) Sets date and time that the original generation of the data in the document started
void	setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation) Sets Indicates whether or not the encapsulated document contains sufficient burned in annotation to identify the patient and date the data was acquired.
void	setContentDate(java.lang.String strContentDate) Sets date the content creation started.
void	setContentTime(java.lang.String strContentTime) Sets time the content creation started
void	setDocumentTitle(java.lang.String strDocumentTitle) Sets the title of the document.
void	setEncapsulatedDocument(ISingleCollection<byte[]> vectEncapsulatedDocument) Sets the Encapsulated Document stream,containing a document encoded according to the MIME Type.
void	setHL7InstanceIdentifier(java.lang.String strHL7InstanceIdentifier) Sets the Instance Identifier of the encapsulated HL7 Structured Document,encoded as a UID (OID or UUID), concatenated with a caret ("^") andExtension value (if Extension is present in Instance Identifier
void	setImageLaterality(EnumSetupDeviceType enumImageLaterality) Sets Laterality of the (possibly paired) body part that is the subject of the encapsulated document.
void	setInstanceNumber(java.lang.String strInstanceNumber) Sets A number that identifies this SOP Instance.
void	setListOfMIMETypes(java.lang.String[] strArrListOfMIMETypes) Sets List of MIME Types
void	setMIMETypeOfEncapsulatedDocument(java.lang.String strMIMETypeOfEncapsulatedDocument) Sets MIME Type of EncapsulatedDocument
void	setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures) Sets Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set ofimages to identify the patient.
void	setVerificationFlag(EnumVerificationFlag enumVerificationFlag) Sets whether the Encapsulated Document is Verified
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

EncapsulatedDocumentModule

public EncapsulatedDocumentModule(IDataSet objIDataSet)

Instantiates a new EncapsulatedDocumentModule

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

setInstanceNumber

public void setInstanceNumber(java.lang.String strInstanceNumber)

Sets A number that identifies this SOP Instance. The value shall be unique within a series.

Parameters:

strInstanceNumber - String value of Instance Number.

getInstanceNumber

public java.lang.String getInstanceNumber()

Retrieves A number that identifies this SOP Instance. The value shall be unique within a series.

Returns:

String - value of Instance Number.

setContentDate

public void setContentDate(java.lang.String strContentDate)

Sets date the content creation started.

Parameters:

strContentDate - String value of date the content creation started.

getContentDate

public java.lang.String getContentDate()

Retrieves date the content creation started.

Returns:

String - value of date the content creation started.

setContentTime

public void setContentTime(java.lang.String strContentTime)

Sets time the content creation started

Parameters:

strContentTime - String value of time the content creation started

getContentTime

public java.lang.String getContentTime()

Retrieves time the content creation started

Returns:

String - value of time the content creation started

setAcquisitionDateTime

public void setAcquisitionDateTime(java.lang.String strAcquisitionDateTime)

Sets date and time that the original generation of the data in the document started

Parameters:

strAcquisitionDateTime - String value of date and time that the original generation of the data in the document started

getAcquisitionDateTime

public java.lang.String getAcquisitionDateTime()

Retrieves date and time that the original generation of the data in the document started

Returns:

String - value of date and time that the original generation of the data in the document started

setImageLaterality

public void setImageLaterality(EnumSetupDeviceType enumImageLaterality)

Sets Laterality of the (possibly paired) body part that is the subject of the encapsulated document.

Parameters:

enumImageLaterality - enum value of Image Laterality.

getImageLaterality

public java.lang.String getImageLaterality()

Returns Laterality of the (possibly paired) body part that is the subject of the encapsulated document.

Returns:

String - value of Image Laterality.

setBurnedInAnnotation

public void setBurnedInAnnotation(EnumBurnedInAnnotation enumBurnedInAnnotation)

Sets Indicates whether or not the encapsulated document contains sufficient burned in annotation to identify the patient and date the data was acquired.

Parameters:

enumBurnedInAnnotation - enum value of BurnedInAnnotation

getBurnedInAnnotation

public java.lang.String getBurnedInAnnotation()

Returns Indicates whether or not the encapsulated document contains sufficient burned in annotation to identify the patient and date the data was acquired.

Returns:

String - value of BurnedInAnnotation

setRecognizableVisualFeatures

public void setRecognizableVisualFeatures(EnumRecognizableVisualFeatures enumRecognizableVisualFeatures)

Sets Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set ofimages to identify the patient.

Parameters:

enumRecognizableVisualFeatures - enum value of Recognizable VisualFeatures

getRecognizableVisualFeatures

public java.lang.String getRecognizableVisualFeatures()

Returns Indicates whether or not the image contains sufficiently recognizable visual features to allow the image or a reconstruction from a set ofimages to identify the patient.

Returns:

String - value of Recognizable VisualFeatures

getSourceInstanceSequence

public SourceInstanceSequence getSourceInstanceSequence()

Retrieves Source Instance Sequence

Returns:

- instance of Source Instance Sequence

setDocumentTitle

public void setDocumentTitle(java.lang.String strDocumentTitle)

Sets the title of the document.

Parameters:

strDocumentTitle - -title of the document.

getDocumentTitle

public java.lang.String getDocumentTitle()

Retrieves the title of the document.

Returns:

String value of title of the document.

getConceptNameCodeSequence

public ConceptNameCodeSequence getConceptNameCodeSequence()

Retrieves Concept Name CodeSequence

Returns:

- instance of Concept Name CodeSequence

getDocumentClassCodeSequence

public DocumentClassCodeSequence getDocumentClassCodeSequence()

Retrieves Document Class Code Sequence

Returns:

- instance of Document Class Code Sequence

setVerificationFlag

public void setVerificationFlag(EnumVerificationFlag enumVerificationFlag)

Sets whether the Encapsulated Document is Verified

Parameters:

enumVerificationFlag - enum value of Verification Flag

getVerificationFlag

public java.lang.String getVerificationFlag()

Returns whether the Encapsulated Document is Verified

Returns:

String - value of Verification Flag

setHL7InstanceIdentifier

public void setHL7InstanceIdentifier(java.lang.String strHL7InstanceIdentifier)

Sets the Instance Identifier of the encapsulated HL7 Structured Document,encoded as a UID (OID or UUID), concatenated with a caret ("^") andExtension value (if Extension is present in Instance Identifier

Parameters:

strHL7InstanceIdentifier - -HL7InstanceIdentifier.

getHL7InstanceIdentifier

public java.lang.String getHL7InstanceIdentifier()

Retrieves the Instance Identifier of the encapsulated HL7 Structured Document,encoded as a UID (OID or UUID), concatenated with a caret ("^") andExtension value (if Extension is present in Instance Identifier

Returns:

String value of HL7InstanceIdentifier.

setMIMETypeOfEncapsulatedDocument

public void setMIMETypeOfEncapsulatedDocument(java.lang.String strMIMETypeOfEncapsulatedDocument)

Sets MIME Type of EncapsulatedDocument

Parameters:

strMIMETypeOfEncapsulatedDocument - String value of MIME Type of EncapsulatedDocument

getMIMETypeOfEncapsulatedDocument

public java.lang.String getMIMETypeOfEncapsulatedDocument()

Return MIME Type of EncapsulatedDocument

Returns:

String - value of MIME Type of EncapsulatedDocument

setListOfMIMETypes

public void setListOfMIMETypes(java.lang.String[] strArrListOfMIMETypes)

Sets List of MIME Types

Parameters:

strArrListOfMIMETypes - String value o List of MIME Types

getListOfMIMETypes

public java.lang.String[] getListOfMIMETypes()

Return List of MIME Types

Returns:

String - value of List of MIME Types

setEncapsulatedDocument

public void setEncapsulatedDocument(ISingleCollection<byte[]> vectEncapsulatedDocument)

Sets the Encapsulated Document stream,containing a document encoded according to the MIME Type.

Parameters:

vectEncapsulatedDocument - collection of byte array of Encapsulated Document

getEncapsulatedDocument

public ISingleCollection<byte[]> getEncapsulatedDocument()

Retrieves the Encapsulated Document stream,containing a document encoded according to the MIME Type.

Returns:

ISingleCollection - collection of byte array of EncapsulatedDocument

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