org.dcm4che.media
Interface DirReader

All Known Subinterfaces:

DirWriter

public interface DirReader

Since:

May, 2002

Version:

$Revision: 3922 $ $Date: 2005-10-05 18:26:16 +0200 (Mi, 05 Okt 2005) $

Author:

gunter zeilinger

Field Summary

static int	CONSISTENCY Description of the Field
static int	INCONSISTENCY Description of the Field

Method Summary

void	close() Description of the Method
java.io.File	getDescriptorFile() Gets the descriptorFile attribute of the DirReader object
java.io.File	getDescriptorFile(java.io.File root) Gets the descriptorFile attribute of the DirReader object
Dataset	getFileSetInfo() Gets the fileSetInfo attribute of the DirReader object
DirRecord	getFirstRecord() Gets the firstRecord attribute of the DirReader object
DirRecord	getFirstRecord(boolean onlyInUse) Gets the firstRecord attribute of the DirReader object
DirRecord	getFirstRecordBy(java.lang.String type, Dataset keys, boolean ignorePNCase) Gets the firstRecordBy attribute of the DirReader object
java.io.File	getRefFile(java.io.File root, java.lang.String[] fileIDs) Gets the refFile attribute of the DirReader object
java.io.File	getRefFile(java.lang.String[] fileIDs) Gets the refFile attribute of the DirReader object
boolean	isEmpty(boolean onlyInUse) Gets the empty attribute of the DirReader object

Field Detail

CONSISTENCY

static final int CONSISTENCY

Description of the Field

See Also:

Constant Field Values

INCONSISTENCY

static final int INCONSISTENCY

Description of the Field

See Also:

Constant Field Values

Method Detail

getFileSetInfo

Dataset getFileSetInfo()

Gets the fileSetInfo attribute of the DirReader object

Returns:

The fileSetInfo value

getRefFile

java.io.File getRefFile(java.io.File root,
                        java.lang.String[] fileIDs)

Gets the refFile attribute of the DirReader object

Parameters:

root - Description of the Parameter

fileIDs - Description of the Parameter

Returns:

The refFile value

getRefFile

java.io.File getRefFile(java.lang.String[] fileIDs)

Gets the refFile attribute of the DirReader object

Parameters:

fileIDs - Description of the Parameter

Returns:

The refFile value

getDescriptorFile

java.io.File getDescriptorFile(java.io.File root)
                               throws DcmValueException

Gets the descriptorFile attribute of the DirReader object

Parameters:

root - Description of the Parameter

Returns:

The descriptorFile value

Throws:

DcmValueException - Description of the Exception

getDescriptorFile

java.io.File getDescriptorFile()
                               throws DcmValueException

Gets the descriptorFile attribute of the DirReader object

Returns:

The descriptorFile value

Throws:

DcmValueException - Description of the Exception

isEmpty

boolean isEmpty(boolean onlyInUse)
                throws java.io.IOException

Gets the empty attribute of the DirReader object

Parameters:

onlyInUse - Description of the Parameter

Returns:

The empty value

Throws:

java.io.IOException - Description of the Exception

getFirstRecord

DirRecord getFirstRecord()
                         throws java.io.IOException

Gets the firstRecord attribute of the DirReader object

Returns:

The firstRecord value

Throws:

java.io.IOException - Description of the Exception

getFirstRecord

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

Gets the firstRecord attribute of the DirReader object

Parameters:

onlyInUse - Description of the Parameter

Returns:

The firstRecord value

Throws:

java.io.IOException - Description of the Exception

getFirstRecordBy

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

Gets the firstRecordBy attribute of the DirReader object

Parameters:

type - Description of the Parameter

keys - Description of the Parameter

ignorePNCase - Description of the Parameter

Returns:

The firstRecordBy value

Throws:

java.io.IOException - Description of the Exception

close

void close()
           throws java.io.IOException

Description of the Method

Throws:

java.io.IOException - Description of the Exception