cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class FileSetIdentificationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.FileSetIdentificationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class FileSetIdentificationModule
extends Module

\* This module describes attributes in File Set Identification Module.

Field Summary

Fields

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

Constructor Summary

Constructors

Constructor and Description
FileSetIdentificationModule(IDataSet objIDataSet) Instantiates a new File Set Identification Module.

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String[]	getFileSetDescriptorFileID() Retrieves ID of a File (in the same File-set) used for user comments related to the File-set .
java.lang.String	getFileSetID() Retrieves User or implementation specific Identifier of File Set.
java.lang.String	getSpecificCharacterSetOfFileSetDescriptorFile() Retrieves Specific Character Set Of File Set Descriptor File .
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	setFileSetDescriptorFileID(java.lang.String[] strArrFileSetDescriptorFileID) Sets ID of a File (in the same File-set) used for user comments related to the File-set (e.g.
void	setFileSetID(java.lang.String strFileSetID) Sets User or implementation specific Identifier (up to 16 characters).
void	setSpecificCharacterSetOfFileSetDescriptorFile(java.lang.String strSpecificCharacterSetOfFileSetDescriptorFile) Sets Specific Character Set of File-set Descriptor File.
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 object of single collection.

Constructor Detail

FileSetIdentificationModule

public FileSetIdentificationModule(IDataSet objIDataSet)

Instantiates a new File Set Identification Module.

Parameters:

objIDataSet - Object of Data Set.

Method Detail

setFileSetID

public void setFileSetID(java.lang.String strFileSetID)

Sets User or implementation specific Identifier (up to 16 characters). The File-set ID is intended to be a short human readable label to easily (but not necessarily uniquely) identify a specific File-set to facilitate operator manipulation of the physical media on] which the File-set is stored.

Parameters:

strFileSetID - String value of File-Set ID.

getFileSetID

public java.lang.String getFileSetID()

Retrieves User or implementation specific Identifier of File Set.

Returns:

String - String value of File-Set ID.

setFileSetDescriptorFileID

public void setFileSetDescriptorFileID(java.lang.String[] strArrFileSetDescriptorFileID)

Sets ID of a File (in the same File-set) used for user comments related to the File-set (e.g. a readme file). The Specific Character set used may be specified in the Specific Character Set of the File-set Descriptor File (0004,1142).

Parameters:

strArrFileSetDescriptorFileID - String array of File-Set Descriptor ID.

getFileSetDescriptorFileID

public java.lang.String[] getFileSetDescriptorFileID()

Retrieves ID of a File (in the same File-set) used for user comments related to the File-set .

Returns:

String[] - String array of File-Set Descriptor File ID.

setSpecificCharacterSetOfFileSetDescriptorFile

public void setSpecificCharacterSetOfFileSetDescriptorFile(java.lang.String strSpecificCharacterSetOfFileSetDescriptorFile)

Sets Specific Character Set of File-set Descriptor File.

Parameters:

strSpecificCharacterSetOfFileSetDescriptorFile - String value of Specific Character Set of File-set Descriptor File.

getSpecificCharacterSetOfFileSetDescriptorFile

public java.lang.String getSpecificCharacterSetOfFileSetDescriptorFile()

Retrieves Specific Character Set Of File Set Descriptor File .

Returns:

String - String value of Specific Character Set Of File Set Descriptor File .

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

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