com.archimed.dicom.dir

Interface DirectoryRecord

public interface DirectoryRecord

represents a Directory Record within a DICOMDIR.

Method Summary

Methods

Modifier and Type	Method and Description
void	appendChild(DirectoryRecord directoryRecord, int seqLengthOpt, int groupLengthOpt) appends a child record of this record at the back of the dicomdir file.
void	appendNext(DirectoryRecord directoryRecord, int seqLengthOpt, int groupLengthOpt) appends a sibling record of this record at the back of the dicomdir file.
DirectoryRecord	getChild() returns the DirectoryRecord that is the child of this instance; or null if this DirectoryRecord has no child.
DicomObject	getDicomObject() returns a dicom object containing dicomtags specific to this Directory Record
DirectoryRecordType	getDirectoryRecordType() returns the Directory Record Type (0004,1430) of this DirectoryRecord
DirectoryRecord	getNext() returns the DirectoryRecord that is the sibling of this instance; or null if this DirectoryRecord has no sibling.
ReferencedFileId	getReferencedFileId() returns the Referenced File Id (0004,1500) of this DirectoryRecord
boolean	isInUse() returns the status of the Record In-use flag (0004,1410)
void	setChild(DirectoryRecord childDirectoryRecord) sets the child DirectoryRecord of this instance; use null if this DirectoryRecord shouldn't have a child record.
void	setDicomObject(DicomObject dicomObject) use this method to store specific dicom tag-value pairs in this Directory Record. Note: this object may be altered when this DirectoryRecord is serialized
void	setDirectoryRecordType(DirectoryRecordType directoryRecordType) updates the Directory Record Type (0004,1430) of this DirectoryRecord
void	setInUse(boolean inUse) updates the status of the Record In-use flag (0004,1410)
void	setNext(DirectoryRecord nextDirectoryRecord) sets the sibling DirectoryRecord of this instance; use null if this DirectoryRecord shouldn't have a child record.
void	setReferencedFileId(java.lang.String[] refFileIdComponents) updates the Referenced File Id (0004,1500) of this DirectoryRecord.

Method Detail

isInUse

boolean isInUse()

returns the status of the Record In-use flag (0004,1410)

setInUse

void setInUse(boolean inUse)

updates the status of the Record In-use flag (0004,1410)

getReferencedFileId

ReferencedFileId getReferencedFileId()

returns the Referenced File Id (0004,1500) of this DirectoryRecord

setReferencedFileId

void setReferencedFileId(java.lang.String[] refFileIdComponents)

updates the Referenced File Id (0004,1500) of this DirectoryRecord. Use null if this DirectoryRecord does not reference any file.

See Also:

ReferencedFileId

getDirectoryRecordType

DirectoryRecordType getDirectoryRecordType()

returns the Directory Record Type (0004,1430) of this DirectoryRecord

setDirectoryRecordType

void setDirectoryRecordType(DirectoryRecordType directoryRecordType)

updates the Directory Record Type (0004,1430) of this DirectoryRecord

getDicomObject

DicomObject getDicomObject()

returns a dicom object containing dicomtags specific to this Directory Record

setDicomObject

void setDicomObject(DicomObject dicomObject)

use this method to store specific dicom tag-value pairs in this Directory Record.
Note: this object may be altered when this DirectoryRecord is serialized

getChild

DirectoryRecord getChild()

returns the DirectoryRecord that is the child of this instance; or null if this DirectoryRecord has no child.

setChild

void setChild(DirectoryRecord childDirectoryRecord)

sets the child DirectoryRecord of this instance; use null if this DirectoryRecord shouldn't have a child record.

See Also:

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

getNext

DirectoryRecord getNext()

returns the DirectoryRecord that is the sibling of this instance; or null if this DirectoryRecord has no sibling.

setNext

void setNext(DirectoryRecord nextDirectoryRecord)

sets the sibling DirectoryRecord of this instance; use null if this DirectoryRecord shouldn't have a child record.

See Also:

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

appendNext

void appendNext(DirectoryRecord directoryRecord,
              int seqLengthOpt,
              int groupLengthOpt)
                throws java.io.IOException,
                       DicomException

appends a sibling record of this record at the back of the dicomdir file. This method is only supported when working with a JITDicomDirReader and appends a Directory Record Sequence Item at the end of the Directory Record Sequence. The directory record should be of the same level than this directory record.

Parameters:

directoryRecord - the DirectoryRecord to append

seqLengthOpt - whether or not to use sequences (if occuring) with defined length or undefined length within the directory record sequence item. Specify DicomWriter.SEQLEN_DEFINED or DicomWriter.SEQLEN_UNDEFINED.

groupLengthOpt - whether or not to write group lengths in this record or not. Specify DicomWriter.GRPLEN_NONE or DicomWriter.GRPLEN_ALL.

Throws:

java.io.IOException

DicomException

appendChild

void appendChild(DirectoryRecord directoryRecord,
               int seqLengthOpt,
               int groupLengthOpt)
                 throws java.io.IOException,
                        DicomException

appends a child record of this record at the back of the dicomdir file. This method is only supported when working with a JITDicomDirReader and appends a Directory Record Sequence Item at the end of the Directory Record Sequence. The directory record should be one level lower than this directory record.

Parameters:

directoryRecord - the DirectoryRecord to append

seqLengthOpt - whether or not to use sequences (if occuring) with defined length or undefined length within the directory record sequence item. Specify DicomWriter.SEQLEN_DEFINED or DicomWriter.SEQLEN_UNDEFINED.

groupLengthOpt - whether or not to write group lengths in this record or not. Specify DicomWriter.GRPLEN_NONE or DicomWriter.GRPLEN_ALL.

Throws:

java.io.IOException

DicomException