com.archimed.dicom.dir
Interface DicomDir

public interface DicomDir

represents a DICOMDIR.

Method Summary

long	commit() Commits the changes made to a DICOM file.
DicomObject	getFileMetaInformation() gets the 'File Meta-Information' as a DicomObject
FilesetIdentification	getFilesetIdentification() gives a reference to the FilesetIdentification data of this DicomDir
DirectoryRecord	getRootDirectoryRecord() gives a reference to the Root Directory Record
boolean	isFilesetConsistent() Status of the 'File-set Consistency Flag' (0004,1212)
java.util.Iterator	iterator() returns an iterator of DirectyRecords to loop through all DirectoryRecords of the dicomdir (starting with the Root Directory Record)
java.util.Iterator	query(QueryTag queryTag, QueryMode queryMode, java.lang.String searchPattern) queries the dicomdir to find all DirectoryRecords that contains the tag - value pair specified
void	setFileMetaInformation(DicomObject fileMetaInformation) updates this DicomDirs 'File Meta-Information'
void	setFilesetConsistent(boolean filesetConsistent) Sets the status of the 'File-set Consistency Flag' (0004,1212)
void	setFilesetIdentification(FilesetIdentification filesetIdentification) update this DicomDirs FilesetIdentification data
void	setRootDirectoryRecord(DirectoryRecord rootDirectoryRecord) update the root directory record of this DicomDir

Method Detail

iterator

java.util.Iterator iterator()

returns an iterator of DirectyRecords to loop through all DirectoryRecords of the dicomdir (starting with the Root Directory Record)

Returns:

an iterator containing DirectoryRecords

query

java.util.Iterator query(QueryTag queryTag,
                         QueryMode queryMode,
                         java.lang.String searchPattern)

queries the dicomdir to find all DirectoryRecords that contains the tag - value pair specified

Returns:

an iterator containing DirectoryRecords

getRootDirectoryRecord

DirectoryRecord getRootDirectoryRecord()

gives a reference to the Root Directory Record

Returns:

the Root Directory Record

setRootDirectoryRecord

void setRootDirectoryRecord(DirectoryRecord rootDirectoryRecord)

update the root directory record of this DicomDir

See Also:

DicomDirBuilder.newDirectoryRecord(DirectoryRecordType), DicomDirBuilder.newDirectoryRecord(DirectoryRecordType, boolean)

getFilesetIdentification

FilesetIdentification getFilesetIdentification()

gives a reference to the FilesetIdentification data of this DicomDir

Returns:

the Fileset Identification

setFilesetIdentification

void setFilesetIdentification(FilesetIdentification filesetIdentification)

update this DicomDirs FilesetIdentification data

Parameters:

filesetIdentification - the fileset identification data

See Also:

DicomDirBuilder.newFilesetIdentification()

getFileMetaInformation

DicomObject getFileMetaInformation()

gets the 'File Meta-Information' as a DicomObject

Returns:

the file meta-information

See Also:

DicomObject.setFileMetaInformation(DicomObject), DicomObject.getFileMetaInformation()

setFileMetaInformation

void setFileMetaInformation(DicomObject fileMetaInformation)

updates this DicomDirs 'File Meta-Information'

See Also:

DicomObject.setFileMetaInformation(DicomObject), DicomObject.getFileMetaInformation()

isFilesetConsistent

boolean isFilesetConsistent()

Status of the 'File-set Consistency Flag' (0004,1212)

Returns:

true if this fileset is consistent

setFilesetConsistent

void setFilesetConsistent(boolean filesetConsistent)

Sets the status of the 'File-set Consistency Flag' (0004,1212)

commit

long commit()
            throws java.io.IOException

Commits the changes made to a DICOM file. This method should be used when using the JIT DicomDir implementation for appending to an existing DICOMDIR file.

Throws:

java.io.IOException