org.dcm4che.media
Interface DirRecord

public interface DirRecord

Since:

May, 2002

Version:

$Revision: 5254 $ $Date: 2007-10-05 10:51:47 +0200 (Fr, 05 Okt 2007) $

Author:

gunter zeilinger

Field Summary

static java.lang.String	CURVE
static java.lang.String	ENCAP_DOC
static java.lang.String	FIDUCIAL
static java.lang.String	HL7_STRUC_DOC
static java.lang.String	IMAGE
static int	IN_USE Description of the Field
static int	INACTIVE Description of the Field
static java.lang.String	KEY_OBJECT_DOC
static java.lang.String	MODALITY_LUT
static java.lang.String	OVERLAY
static java.lang.String	PATIENT
static java.lang.String	PRESENTATION
static java.lang.String	PRIVATE
static java.lang.String	RAW_DATA
static java.lang.String	REGISTRATION
static java.lang.String	RT_DOSE
static java.lang.String	RT_PLAN
static java.lang.String	RT_STRUCTURE_SET
static java.lang.String	RT_TREAT_RECORD
static java.lang.String	SERIES
static java.lang.String	SPECTROSCOPY
static java.lang.String	SR_DOCUMENT
static java.lang.String	STEREOMETRIC
static java.lang.String	STORED_PRINT
static java.lang.String	STUDY
static java.lang.String	VALUE_MAP
static java.lang.String	VOI_LUT
static java.lang.String	WAVEFORM

Method Summary

Dataset	getDataset() Gets the dataset attribute of the DirRecord object
DirRecord	getFirstChild() Gets the firstChild attribute of the DirRecord object
DirRecord	getFirstChild(boolean onlyInUse) Gets the firstChild attribute of the DirRecord object
DirRecord	getFirstChildBy(java.lang.String type, Dataset keys, boolean ignorePNCase) Gets the firstChildBy attribute of the DirRecord object
int	getInUseFlag() Gets the inUseFlag attribute of the DirRecord object
DirRecord	getNextSibling() Gets the nextSibling attribute of the DirRecord object
DirRecord	getNextSibling(boolean onlyInUse) Gets the nextSibling attribute of the DirRecord object
DirRecord	getNextSiblingBy(java.lang.String type, Dataset keys, boolean ignorePNCase) Gets the nextSiblingBy attribute of the DirRecord object
java.lang.String[]	getRefFileIDs() Gets the refFileIDs attribute of the DirRecord object
java.lang.String	getRefSOPClassUID() Gets the refSOPClassUID attribute of the DirRecord object
java.lang.String	getRefSOPInstanceUID() Gets the refSOPInstanceUID attribute of the DirRecord object
java.lang.String	getRefSOPTransferSyntaxUID() Gets the refSOPTransferSyntaxUID attribute of the DirRecord object
java.lang.String	getType() Gets the type attribute of the DirRecord object
boolean	match(java.lang.String type, Dataset keys, boolean ignorePNCase) Description of the Method
void	reload()

Field Detail

INACTIVE

static final int INACTIVE

Description of the Field

See Also:

Constant Field Values

IN_USE

static final int IN_USE

Description of the Field

See Also:

Constant Field Values

PATIENT

static final java.lang.String PATIENT

See Also:

Constant Field Values

RT_PLAN

static final java.lang.String RT_PLAN

See Also:

Constant Field Values

RT_TREAT_RECORD

static final java.lang.String RT_TREAT_RECORD

See Also:

Constant Field Values

RT_STRUCTURE_SET

static final java.lang.String RT_STRUCTURE_SET

See Also:

Constant Field Values

RT_DOSE

static final java.lang.String RT_DOSE

See Also:

Constant Field Values

KEY_OBJECT_DOC

static final java.lang.String KEY_OBJECT_DOC

See Also:

Constant Field Values

SR_DOCUMENT

static final java.lang.String SR_DOCUMENT

See Also:

Constant Field Values

PRESENTATION

static final java.lang.String PRESENTATION

See Also:

Constant Field Values

VOI_LUT

static final java.lang.String VOI_LUT

See Also:

Constant Field Values

MODALITY_LUT

static final java.lang.String MODALITY_LUT

See Also:

Constant Field Values

WAVEFORM

static final java.lang.String WAVEFORM

See Also:

Constant Field Values

CURVE

static final java.lang.String CURVE

See Also:

Constant Field Values

OVERLAY

static final java.lang.String OVERLAY

See Also:

Constant Field Values

IMAGE

static final java.lang.String IMAGE

See Also:

Constant Field Values

STORED_PRINT

static final java.lang.String STORED_PRINT

See Also:

Constant Field Values

SERIES

static final java.lang.String SERIES

See Also:

Constant Field Values

STUDY

static final java.lang.String STUDY

See Also:

Constant Field Values

SPECTROSCOPY

static final java.lang.String SPECTROSCOPY

See Also:

Constant Field Values

RAW_DATA

static final java.lang.String RAW_DATA

See Also:

Constant Field Values

REGISTRATION

static final java.lang.String REGISTRATION

See Also:

Constant Field Values

FIDUCIAL

static final java.lang.String FIDUCIAL

See Also:

Constant Field Values

ENCAP_DOC

static final java.lang.String ENCAP_DOC

See Also:

Constant Field Values

VALUE_MAP

static final java.lang.String VALUE_MAP

See Also:

Constant Field Values

HL7_STRUC_DOC

static final java.lang.String HL7_STRUC_DOC

See Also:

Constant Field Values

STEREOMETRIC

static final java.lang.String STEREOMETRIC

See Also:

Constant Field Values

PRIVATE

static final java.lang.String PRIVATE

See Also:

Constant Field Values

Method Detail

reload

void reload()
            throws java.io.IOException,
                   DcmValueException

Throws:

java.io.IOException

DcmValueException

getType

java.lang.String getType()

Gets the type attribute of the DirRecord object

Returns:

The type value

getInUseFlag

int getInUseFlag()

Gets the inUseFlag attribute of the DirRecord object

Returns:

The inUseFlag value

getRefFileIDs

java.lang.String[] getRefFileIDs()

Gets the refFileIDs attribute of the DirRecord object

Returns:

The refFileIDs value

getRefSOPClassUID

java.lang.String getRefSOPClassUID()

Gets the refSOPClassUID attribute of the DirRecord object

Returns:

The refSOPClassUID value

getRefSOPInstanceUID

java.lang.String getRefSOPInstanceUID()

Gets the refSOPInstanceUID attribute of the DirRecord object

Returns:

The refSOPInstanceUID value

getRefSOPTransferSyntaxUID

java.lang.String getRefSOPTransferSyntaxUID()

Gets the refSOPTransferSyntaxUID attribute of the DirRecord object

Returns:

The refSOPTransferSyntaxUID value

getDataset

Dataset getDataset()

Gets the dataset attribute of the DirRecord object

Returns:

The dataset value

getFirstChild

DirRecord getFirstChild()
                        throws java.io.IOException

Gets the firstChild attribute of the DirRecord object

Returns:

The firstChild value

Throws:

java.io.IOException - Description of the Exception

getFirstChild

DirRecord getFirstChild(boolean onlyInUse)
                        throws java.io.IOException

Gets the firstChild attribute of the DirRecord object

Parameters:

onlyInUse - Description of the Parameter

Returns:

The firstChild value

Throws:

java.io.IOException - Description of the Exception

getFirstChildBy

DirRecord getFirstChildBy(java.lang.String type,
                          Dataset keys,
                          boolean ignorePNCase)
                          throws java.io.IOException

Gets the firstChildBy attribute of the DirRecord object

Parameters:

type - Description of the Parameter

keys - Description of the Parameter

ignorePNCase - Description of the Parameter

Returns:

The firstChildBy value

Throws:

java.io.IOException - Description of the Exception

getNextSibling

DirRecord getNextSibling()
                         throws java.io.IOException

Gets the nextSibling attribute of the DirRecord object

Returns:

The nextSibling value

Throws:

java.io.IOException - Description of the Exception

getNextSibling

DirRecord getNextSibling(boolean onlyInUse)
                         throws java.io.IOException

Gets the nextSibling attribute of the DirRecord object

Parameters:

onlyInUse - Description of the Parameter

Returns:

The nextSibling value

Throws:

java.io.IOException - Description of the Exception

getNextSiblingBy

DirRecord getNextSiblingBy(java.lang.String type,
                           Dataset keys,
                           boolean ignorePNCase)
                           throws java.io.IOException

Gets the nextSiblingBy attribute of the DirRecord object

Parameters:

type - Description of the Parameter

keys - Description of the Parameter

ignorePNCase - Description of the Parameter

Returns:

The nextSiblingBy value

Throws:

java.io.IOException - Description of the Exception

match

boolean match(java.lang.String type,
              Dataset keys,
              boolean ignorePNCase)

Description of the Method

Parameters:

type - Description of the Parameter

keys - Description of the Parameter

ignorePNCase - Description of the Parameter

Returns:

Description of the Return Value