cdac.medinfo.sdk.dcm30_04.dicommodel.modules

Class DirectoryInformationModule

java.lang.Object

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

cdac.medinfo.sdk.dcm30_04.dicommodel.modules.DirectoryInformationModule

All Implemented Interfaces:

IModule, ICollectionIterable, java.lang.Iterable

public class DirectoryInformationModule
extends Module

\* This module describes Attributes required to define a Directory Information 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
DirectoryInformationModule(IDataSet objIDataSet) Instantiates a new Directory Information Module.

Method Summary

Methods

Modifier and Type	Method and Description
DirectoryRecordSequence	getDirectoryRecordSequence() Retrieves pre-initialized object of Directory Record 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
short	getFileSetConsistencyFlag() Retrieves File Set Consistency Flag.
int	getOffsetOfFirstDirectoryRecordOfRootDirectoryEntity() Retrieves Offset of the first byte (of the Item Data Element) of the first Directory Record of the Root Directory Entity.
int	getOffsetOfLastDirectoryRecordOfRootDirectoryEntity() Retrieves Offset of the first byte (of the Item Data Element) of the last Directory Record of the Root Directory Entity.
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	setFileSetConsistencyFlag(EnumFileSetConsistencyFlag enumFileSetConsistencyFlag) This Flag indicates that an inconsistency within the Directory or between the Directory and the Files of the File-set may exist.
void	setOffsetOfFirstDirectoryRecordOfRootDirectoryEntity(int iOffsetOfFirstDirectoryRecordOfRootDirectory) Sets Offset of the first byte (of the Item Data Element) of the first Directory Record of the Root Directory Entity.
void	setOffsetOfLastDirectoryRecordOfRootDirectoryEntity(int iOffsetOfLastDirectoryRecordOfRootDirectory) Sets Offset of the Last Directory Record of the Root Directory Entity Offset of the first byte (of the Item Data Element) of the last Directory Record of the Root Directory Entity.
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

DirectoryInformationModule

public DirectoryInformationModule(IDataSet objIDataSet)

Instantiates a new Directory Information Module.

Parameters:

objIDataSet - Object of Data Set.

Method Detail

setOffsetOfFirstDirectoryRecordOfRootDirectoryEntity

public void setOffsetOfFirstDirectoryRecordOfRootDirectoryEntity(int iOffsetOfFirstDirectoryRecordOfRootDirectory)

Sets Offset of the first byte (of the Item Data Element) of the first Directory Record of the Root Directory Entity. This Offset is a number of bytes starting with the first byte of the File Meta Information. When the Root Directory Entity contains no Directory Record, this offset shall be set to 00000000H.

Parameters:

iOffsetOfFirstDirectoryRecordOfRootDirectory - int value of Offset of the First Directory Record of the Root Directory.

getOffsetOfFirstDirectoryRecordOfRootDirectoryEntity

public int getOffsetOfFirstDirectoryRecordOfRootDirectoryEntity()

Retrieves Offset of the first byte (of the Item Data Element) of the first Directory Record of the Root Directory Entity.

Returns:

int - int value of Offset of the First Directory Record of the Root Directory.

setOffsetOfLastDirectoryRecordOfRootDirectoryEntity

public void setOffsetOfLastDirectoryRecordOfRootDirectoryEntity(int iOffsetOfLastDirectoryRecordOfRootDirectory)

Sets Offset of the Last Directory Record of the Root Directory Entity Offset of the first byte (of the Item Data Element) of the last Directory Record of the Root Directory Entity. This Offset is a number of bytes starting with the first byte of the File Meta Information. When the Root Directory Entity contains no Directory Record, this offset shall be set to 00000000H.

Parameters:

iOffsetOfLastDirectoryRecordOfRootDirectory - int value of Offset of the Last Directory Record of the Root Directory.

getOffsetOfLastDirectoryRecordOfRootDirectoryEntity

public int getOffsetOfLastDirectoryRecordOfRootDirectoryEntity()

Retrieves Offset of the first byte (of the Item Data Element) of the last Directory Record of the Root Directory Entity.

Returns:

int - int value of Offset of the last Directory Record of the Root Directory.

setFileSetConsistencyFlag

public void setFileSetConsistencyFlag(EnumFileSetConsistencyFlag enumFileSetConsistencyFlag)

This Flag indicates that an inconsistency within the Directory or between the Directory and the Files of the File-set may exist. Enumerated Values: 0000H: no known inconsistencies FFFFH: the FSR or FSU shall assume that inconsistencies are present.

Parameters:

shFileSetConsistencyFlag - short value of File Set Consistency Flag.

getFileSetConsistencyFlag

public short getFileSetConsistencyFlag()

Retrieves File Set Consistency Flag.

Returns:

short - short value of File Set Consistency Flag.

getDirectoryRecordSequence

public DirectoryRecordSequence getDirectoryRecordSequence()

Retrieves pre-initialized object of Directory Record 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:

DirectoryRecordSequence - instance of Directory Record Sequence.

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