cdac.medinfo.sdk.dcm30_04.services.dicomdir

Class DICOMDIR

java.lang.Object

cdac.medinfo.sdk.dcm30_04.services.dicomdir.DICOMDIR

public class DICOMDIR
extends java.lang.Object

DICOMDIR is a unique and mandatory DICOM File within a File-set which contains the Media Storage Directory SOP Class. This class contains methods to read DICOMDIR file, create it and update it. This class also provides function to query and retrieve information from the DICOMDIR file.

Constructor Summary

Constructors

Constructor and Description
DICOMDIR(java.lang.String strDirectoryPath) Instantiates DICOMDIR.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	find(IDataSet objSourceDataSet, ISingleCollection<IDataSet> objRstDataSetCollection) This method finds the value of given data elements in the Dataset according to the match of key value.
cdac.medinfo.sdk.dcm30_04.services.dicomdir.EnumDICOMDIRMode	getDICOMDIRMode() This function retrieves the value of DICOMDIR Mode.
boolean	isDICOMDIRExist() This function tells whether the DICOMDIR file exists or not.
IDataSet	read() This function parses the DICOMDIR file and returns Data Set.
boolean	retrieve(IDataSet objSourceDataSet, ISingleCollection<IDataSet> objRstDataSetCollection) This method finds the data set in the DICOMDIR according to key value.
void	setDICOMDIRMode(cdac.medinfo.sdk.dcm30_04.services.dicomdir.EnumDICOMDIRMode enumDICOMDIRMode) This function sets the DICOMDIR Mode.
void	setIDICOMDIRPathFormater(IDICOMDIRPathFormatter objIDICOMDIRPathFormater) This function sets the DICOMDIR Path Formater.
void	setReferencedFileID(java.lang.String strReferencedFileID) This function sets the referenced file id , if the Dicom files are stored in Folder structure.
void	write(IDataSet objIDataSet) This function writes the information in the DICOMDIR file as well serializes the data set.
void	writeDICOMDIRFile(IDataSet objIDataSet) This function writes the DataSet information in the DICOMDIR file.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

DICOMDIR

public DICOMDIR(java.lang.String strDirectoryPath)
         throws java.io.IOException

Instantiates DICOMDIR. TO instantiate DICOMDIR , directory path in which DICOMDIR has to be created should be give.

Parameters:

strDirectoryPath - String value containing Directory Path in which DICOMDIR file has to be created.

Throws:

java.io.IOException - Signals if any IO Exception occurs.

Method Detail

isDICOMDIRExist

public boolean isDICOMDIRExist()

This function tells whether the DICOMDIR file exists or not. If file does not exist then it returns false other wise it returns true.

Returns:

true or false.

read

public IDataSet read()
              throws DICOMDIRException,
                     java.io.IOException

This function parses the DICOMDIR file and returns Data Set.

Returns:

IDataSet instance of DataSet.

Throws:

ParseException - Signals if parsing fails.

java.io.IOException - Signals if IOException occurs.v

DICOMDIRException

write

public void write(IDataSet objIDataSet)
           throws java.io.IOException,
                  DICOMDIRException

This function writes the information in the DICOMDIR file as well serializes the data set. When the DataSet is to be stored in DIOCMDIR then if the DICOMDIRFileFormatter is set to DICOMDIR class then call is made to the formatPath method . The file is stored withe the name returned from this method. Otherwise the file is stored with long file name.

Parameters:

objIDataSet - Instance of Data Set.

Throws:

java.io.IOException - signals if an IOException Occurs.

DICOMDIRException - signals if DICOMDIRException occurs.

writeDICOMDIRFile

public void writeDICOMDIRFile(IDataSet objIDataSet)
                       throws java.io.IOException,
                              DICOMDIRException

This function writes the DataSet information in the DICOMDIR file. If the DIOCMDIR file is already present then the dataset is added to the DICOMDIR File. When the DataSet is to be stored in DIOCMDIR then if the DICOMDIRFileFormatter is set to DICOMDIR class then call is made to the formatPath method . The file is stored with the name returned from this method .

Parameters:

objIDataSet - instance of DataSet that is to be added to the DICOMDIR File.

Throws:

java.io.IOException - Signals if an IOException occurs.

DICOMDIRException

find

public boolean find(IDataSet objSourceDataSet,
           ISingleCollection<IDataSet> objRstDataSetCollection)
             throws java.io.IOException

This method finds the value of given data elements in the Dataset according to the match of key value.

Parameters:

objSourceDataSet - instance of DataSet containing key value and other data elements that are to be retrieved.

objRstDataSetCollection - DataSet collection containing the matches.

Returns:

boolean - true or false.

Throws:

java.io.IOException - Signals if IOException occurs.

retrieve

public boolean retrieve(IDataSet objSourceDataSet,
               ISingleCollection<IDataSet> objRstDataSetCollection)
                 throws java.io.IOException

This method finds the data set in the DICOMDIR according to key value. Retrieves the Dicom Files in which the key value is present.

Parameters:

objSourceDataSet - instance of data set containing key value.

objRstDataSetCollection - data set collection containing all matched data set.

Returns:

true or false.

Throws:

java.io.IOException - Signals if IOException occurs.

setReferencedFileID

public void setReferencedFileID(java.lang.String strReferencedFileID)

This function sets the referenced file id , if the Dicom files are stored in Folder structure.

setIDICOMDIRPathFormater

public void setIDICOMDIRPathFormater(IDICOMDIRPathFormatter objIDICOMDIRPathFormater)

This function sets the DICOMDIR Path Formater.

Parameters:

IDICOMDIRPathFormatter - instance of DICOM File Formater.

setDICOMDIRMode

public void setDICOMDIRMode(cdac.medinfo.sdk.dcm30_04.services.dicomdir.EnumDICOMDIRMode enumDICOMDIRMode)

This function sets the DICOMDIR Mode. If the DICOMDIR mode is DICOMDIR_DIRECTORYMODE then files are stored in Directory Structure. The folder structure is PatientID, inside that StudyInstanceUID folder, inside that SeriesInstanceUID folder and then the dicom file stored with name SOPInstanceUID.

Parameters:

enumDICOMDIRMode - Enum value specifying storage mode in DICOMDIR

getDICOMDIRMode

public cdac.medinfo.sdk.dcm30_04.services.dicomdir.EnumDICOMDIRMode getDICOMDIRMode()

This function retrieves the value of DICOMDIR Mode.

Returns:

EnumDICOMDIRMode value of DICOMDIR Mode.