cdac.medinfo.sdk.dcm30_04.baselibs

Class DirectoryRecordSequenceItem

java.lang.Object

cdac.medinfo.sdk.dcm30_04.baselibs.Item

cdac.medinfo.sdk.dcm30_04.baselibs.DirectoryRecordSequenceItem

All Implemented Interfaces:

IItem, ICollectionIterable<IDataElement>, java.io.Serializable, java.lang.Iterable<IDataElement>

public class DirectoryRecordSequenceItem
extends Item

Sequence of zero or more repeating Items where each Item contains a Directory Record by including the Directory Elements from (0004,1400) to (0004,1511) and Record selection Keys. A zero length Value indicates that no Directory Records are contained in the Root Directory Entity.

See Also:

Serialized Form

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getDirectoryRecordType() Retrieves Directory Record Type.
int	getMRDRDirectoryRecordOffset() Retrieves OOffset of the first byte (of the Item Data Element) of the Multi-Referenced File Directory Record.
int	getOffsetOfNextDirectoryRecord() Retrieves uniquely identifies a set of dimensions referenced within the containing SOP Instance.
int	getOffsetOfReferencedLowerLevelDirectoryEntity() Retrieves Offset of the first byte (of the Item Data Element) of the first Directory Record of the Referenced Lower Level Directory Entity.
java.lang.String	getPrivateRecordUID() Retrieves Private Record UID.
short	getRecordInUseFlag() Retrieves uniquely identifies a set of dimensions referenced within the containing SOP Instance.
java.lang.String[]	getReferencedFileID() Retrieves Referenced File ID.
java.lang.String[]	getReferencedRelatedGeneralSOPClassUIDInFile() Retrieves Referenced Related General SOP Class UID in File.
java.lang.String	getReferencedSOPClassUIDInFile() Retrieves Referenced SOP Class UID in File.
java.lang.String	getReferencedSOPInstanceUIDInFile() Retrieves Referenced SOP Instance UID in File.
java.lang.String	getReferencedTransferSyntaxUIDInFile() Retrieves Referenced Transfer Syntax UID in File.
void	setDirectoryRecordType(EnumDirectoryRecordType enumDirectoryRecordType) Defines a specialized type of Directory Record by reference to its position in the Media Storage Directory Information Model.
void	setMRDRDirectoryRecordOffset(int iMRDRDirectoryRecordOffset) Sets Offset of the first byte (of the Item Data Element) of the Multi-Referenced File Directory Record.
void	setOffsetOfNextDirectoryRecord(int iOffsetOfNextDirectoryRecord) Sets Offset of the first byte (of the Item Data Element) of the next Directory Record of the same Directory Entity.
void	setOffsetOfReferencedLowerLevelDirectoryEntity(int iOffsetOfReferencedLowerLevelDirectoryEntity) Sets Offset of the first byte (of the Item Data Element) of the first Directory Record of the Referenced Lower Level Directory Entity.
void	setPrivateRecordUID(java.lang.String strPrivateRecordUID) Required if the Directory Record Type (0004,1430) is of Value PRIVATE.
void	setRecordInUseFlag(EnumRecordInUseFlag enumRecordInUseFlag) This flag facilitates the deletion of referenced files.
void	setReferencedFileID(java.lang.String[] strArrReferencedFileID) A Multiple Value which represents the ordered components of the File ID containing a "referenced object" or Referenced SOP Instance.
void	setReferencedRelatedGeneralSOPClassUIDInFile(java.lang.String[] strArrReferencedRelatedGeneralSOPClassUIDInFile) Unique ID for the Related General SOP Class(es) related to the SOP Class of the Instance stored in the referenced file.
void	setReferencedSOPClassUIDInFile(java.lang.String strReferencedSOPClassUIDInFile) Unique ID for the SOP Class of the Instance stored in the referenced File.
void	setReferencedSOPInstanceUIDInFile(java.lang.String strReferencedSOPInstanceUIDInFile) Unique Identifier for the SOP Instance stored in the referenced file.
void	setReferencedTransferSyntaxUIDInFile(java.lang.String strReferencedTransferSyntaxUIDInFile) Unique Identifier for the Transfer Syntax used to encode the Instance stored in the referenced file.
boolean	validateForModule() Validates all the attributes in DirectoryRecordSequenceItem that are present in the DataSet

Methods inherited from class cdac.medinfo.sdk.dcm30_04.baselibs.Item

addDataElement, changeToUndefined, clone, contains, dumpDICOMInfo, getDataForTag, getDictionaryReader, getItemLength, getTransferSyntax, getValue, getValueLength, iterator, read, setDictionaryReader, setTransferSyntax, setValue, sortedIterator, validate, write

Methods inherited from class java.lang.Object

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

Method Detail

setOffsetOfNextDirectoryRecord

public void setOffsetOfNextDirectoryRecord(int iOffsetOfNextDirectoryRecord)

Sets Offset of the first byte (of the Item Data Element) of the next Directory Record of the same Directory Entity. This Offset is an unsigned integer representing a number of bytes starting with the first byte of the File Meta-information. A zero offset shall be used to mean that there is no other Directory Record in this Directory Entity. Required if the Directory Record Sequence (0004,1220) is not zero length.

Parameters:

iOffsetOfNextDirectoryRecord - long value of Offset Of Next Directory Record.

getOffsetOfNextDirectoryRecord

public int getOffsetOfNextDirectoryRecord()

Retrieves uniquely identifies a set of dimensions referenced within the containing SOP Instance.

Returns:

long - value of Dimension Organization UID.

setRecordInUseFlag

public void setRecordInUseFlag(EnumRecordInUseFlag enumRecordInUseFlag)

This flag facilitates the deletion of referenced files. Enumerated Values: FFFFH = record is in use. 0000H = record is inactive. Other Values are reserved and shall not be set by File-set Creators, but if present shall be interpreted as FFFFH by File-set Readers or Updaters. Required if the Directory Record Sequence (0004,1220) is not zero length. If a Directory Record is changed from in use to inactive, the FSU shall ensure that all Directory Records of referenced lower-level Directory Entities are changed to inactive.

Parameters:

enumRecordInUseFlag - enum value of Record in use flag.

getRecordInUseFlag

public short getRecordInUseFlag()

Retrieves uniquely identifies a set of dimensions referenced within the containing SOP Instance.

Returns:

short - value of Dimension Organization UID.

setOffsetOfReferencedLowerLevelDirectoryEntity

public void setOffsetOfReferencedLowerLevelDirectoryEntity(int iOffsetOfReferencedLowerLevelDirectoryEntity)

Sets Offset of the first byte (of the Item Data Element) of the first Directory Record of the Referenced Lower Level Directory Entity. This Offset is a number of bytes starting with the first byte of the File Meta Information. Required if the Directory Record Sequence (0004,1220) is not zero length. When no lower-level Directory Entity (containing at least one Directory Record) is referenced, this Attribute shall have a Value of 00000000H.

Parameters:

iOffsetOfReferencedLowerLevelDirectoryEntity - long value of Offset of Referenced Lower-Level Directory Entity.

getOffsetOfReferencedLowerLevelDirectoryEntity

public int getOffsetOfReferencedLowerLevelDirectoryEntity()

Retrieves Offset of the first byte (of the Item Data Element) of the first Directory Record of the Referenced Lower Level Directory Entity.

Returns:

String - value of Offset of Referenced Lower-Level Directory Entity.

setDirectoryRecordType

public void setDirectoryRecordType(EnumDirectoryRecordType enumDirectoryRecordType)

Defines a specialized type of Directory Record by reference to its position in the Media Storage Directory Information Model. Required if the Directory Record Sequence (0004,1220) is not zero length. Enumerated Values (see Section F.5): PATIENT, STUDY, SERIES, IMAGE, OVERLAY, MODALITY LUT, VOI LUT CURVE, TOPIC, VISIT, RESULTS, INTERPRETATION, STUDY COMPONENT, STORED PRINT RT DOSE, RT STRUCTURE SET, RT PLAN, RT TREAT RECORD, PRESENTATION, WAVEFORM, SR DOCUMENT, KEY OBJECT DOC, SPECTROSCOPY, RAW DATA, REGISTRATION FIDUCIAL, PRIVATE, MRDR.

Parameters:

enumDirectoryRecordType - Enum value of Directory Record Type.

getDirectoryRecordType

public java.lang.String getDirectoryRecordType()

Retrieves Directory Record Type.

Returns:

String - value of Directory Record Type.

setPrivateRecordUID

public void setPrivateRecordUID(java.lang.String strPrivateRecordUID)

Required if the Directory Record Type (0004,1430) is of Value PRIVATE. This UID is used to define a non-standard type of Directory Record by reference to its position in a private extension to the Basic Directory IOD Information Model

Parameters:

strPrivateRecordUID - String value of Private Record UID.

getPrivateRecordUID

public java.lang.String getPrivateRecordUID()

Retrieves Private Record UID.

Returns:

String - value of Private Record UID.

setReferencedFileID

public void setReferencedFileID(java.lang.String[] strArrReferencedFileID)

A Multiple Value which represents the ordered components of the File ID containing a "referenced object" or Referenced SOP Instance. A maximum of 8 components, each from 1 to 8 characters shall be used.

Parameters:

strArrReferencedFileID - String array of Referenced File ID.

getReferencedFileID

public java.lang.String[] getReferencedFileID()

Retrieves Referenced File ID.

Returns:

String - value of Referenced File ID.

setMRDRDirectoryRecordOffset

public void setMRDRDirectoryRecordOffset(int iMRDRDirectoryRecordOffset)

Sets Offset of the first byte (of the Item Data Element) of the Multi-Referenced File Directory Record. This Offset is a number of bytes starting with the first byte of the File Meta Information. When the Directory Record does not reference any SOP Instance this attribute shall not be present. Required if the Directory Record indirectly references a SOP Instance by a MRDR. Shall not be present if the Referenced File ID (0004,1500) is used for direct reference.

Parameters:

iMRDRDirectoryRecordOffset - long value of MRDR Directory Record Offset.

getMRDRDirectoryRecordOffset

public int getMRDRDirectoryRecordOffset()

Retrieves OOffset of the first byte (of the Item Data Element) of the Multi-Referenced File Directory Record.

Returns:

int - value of MRDR Directory Record Offset.

setReferencedSOPClassUIDInFile

public void setReferencedSOPClassUIDInFile(java.lang.String strReferencedSOPClassUIDInFile)

Unique ID for the SOP Class of the Instance stored in the referenced File. This UID shall be present whether the File is referenced directly by Referenced File ID (0004,1500) or indirectly by an MRDR Directory Record Offset (0004,1504).

Parameters:

strReferencedSOPClassUIDInFile - String value of Referenced SOP Class UID in File.

getReferencedSOPClassUIDInFile

public java.lang.String getReferencedSOPClassUIDInFile()

Retrieves Referenced SOP Class UID in File.

Returns:

String - value of Referenced SOP Class UID in File.

setReferencedSOPInstanceUIDInFile

public void setReferencedSOPInstanceUIDInFile(java.lang.String strReferencedSOPInstanceUIDInFile)

Unique Identifier for the SOP Instance stored in the referenced file. This UID shall be present whether the File is referenced directly by Referenced File ID (0004,1500) or indirectly by an MRDR Directory Record Offset.

Parameters:

strReferencedSOPInstanceUIDInFile - String value of Referenced SOP Instance UID in File.

getReferencedSOPInstanceUIDInFile

public java.lang.String getReferencedSOPInstanceUIDInFile()

Retrieves Referenced SOP Instance UID in File.

Returns:

String - value of Referenced SOP Instance UID in File.

setReferencedTransferSyntaxUIDInFile

public void setReferencedTransferSyntaxUIDInFile(java.lang.String strReferencedTransferSyntaxUIDInFile)

Unique Identifier for the Transfer Syntax used to encode the Instance stored in the referenced file. This UID shall be present whether the File is referenced directly by Referenced File ID (0004,1500) or indirectly by an MRDR Directory Record Offset.

Parameters:

strReferencedTransferSyntaxUIDInFile - String value of Referenced Transfer Syntax UID in File.

getReferencedTransferSyntaxUIDInFile

public java.lang.String getReferencedTransferSyntaxUIDInFile()

Retrieves Referenced Transfer Syntax UID in File.

Returns:

String - value of Referenced Transfer Syntax UID in File.

setReferencedRelatedGeneralSOPClassUIDInFile

public void setReferencedRelatedGeneralSOPClassUIDInFile(java.lang.String[] strArrReferencedRelatedGeneralSOPClassUIDInFile)

Unique ID for the Related General SOP Class(es) related to the SOP Class of the Instance stored in the referenced file.

Parameters:

strArrReferencedRelatedGeneralSOPClassUIDInFile - String array of Referenced Related General SOP Class UID in File.

getReferencedRelatedGeneralSOPClassUIDInFile

public java.lang.String[] getReferencedRelatedGeneralSOPClassUIDInFile()

Retrieves Referenced Related General SOP Class UID in File.

Returns:

String[] - value of Referenced Related General SOP Class UID in File.

validateForModule

public boolean validateForModule()
                          throws InvalidItemException

Validates all the attributes in DirectoryRecordSequenceItem that are present in the DataSet

Specified by:

validateForModule in interface IItem

Overrides:

validateForModule in class Item

Returns:

boolean - Success -true, Failure - false

Throws:

InvalidItemException - throws InvalidItemException If Mandatory or Conditional element fails.