com.archimed.dicom

Class FileBulkDataReference

java.lang.Object

com.archimed.dicom.FileBulkDataReference

All Implemented Interfaces:

BulkDataReference, DataElementValue

public class FileBulkDataReference
extends java.lang.Object
implements BulkDataReference

A BulkDataReference based on an underlying file.

Constructor Summary

Constructors

Constructor and Description
FileBulkDataReference(java.nio.file.Path path)
FileBulkDataReference(java.nio.file.Path path, java.nio.ByteOrder byteOrder)

Method Summary

Methods

Modifier and Type	Method and Description
java.nio.ByteOrder	getByteOrder() return the byte order of the data read from the inputstream.
java.lang.String	getDescription() returns a descriptive value of this bulk data reference, typically used in dump methods.
java.io.InputStream	getInputStream() returns an inputstream of the bulk data reference.
long	getLength() returns the length of this bulk data reference, i.o.w.
long	getOffset() returns zero.
void	release() called by JDT when the inputstream is no longer needed.
void	resolve() resolves the BulkDataReference.

Methods inherited from class java.lang.Object

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

Constructor Detail

FileBulkDataReference

public FileBulkDataReference(java.nio.file.Path path)

FileBulkDataReference

public FileBulkDataReference(java.nio.file.Path path,
                     java.nio.ByteOrder byteOrder)

Method Detail

resolve

public void resolve()
             throws java.io.IOException

resolves the BulkDataReference. This method is called by JDT immediately before JDT will access the inputstream of the bulk data reference. It gives implementors the possibility to resolve the offset,length and inputstream of a bulk data reference just-in-time.

Specified by:

resolve in interface BulkDataReference

Throws:

java.io.IOException

getLength

public long getLength()

returns the length of this bulk data reference, i.o.w. the total number of bytes that JDT will be able to read from the inputstream returned with BulkDataReference.getInputStream(). Implementations may return -1 as long as the bulk data reference is not resolved.

Specified by:

getLength in interface BulkDataReference

Specified by:

getLength in interface DataElementValue

Returns:

getOffset

public long getOffset()

returns zero.

Specified by:

getOffset in interface BulkDataReference

Returns:

getByteOrder

public java.nio.ByteOrder getByteOrder()

return the byte order of the data read from the inputstream. JDT will perform byte swapping when the returned byte order does not match the byte order of the transfer syntax when streaming data of a BulkDataReference to a DICOM file or dataset.

Specified by:

getByteOrder in interface BulkDataReference

Returns:

getInputStream

public java.io.InputStream getInputStream()

returns an inputstream of the bulk data reference. The method may return null as long as the inputstream is not resolved.

Specified by:

getInputStream in interface BulkDataReference

Returns:

release

public void release()
             throws java.io.IOException

called by JDT when the inputstream is no longer needed. This gives implementors the possibility to clean up any possible resources asssociated with the inputstream.

Specified by:

release in interface BulkDataReference

Throws:

java.io.IOException

getDescription

public java.lang.String getDescription()

returns a descriptive value of this bulk data reference, typically used in dump methods. This method is allowed to return null in which case JDT will generate a description.

Specified by:

getDescription in interface BulkDataReference

Specified by:

getDescription in interface DataElementValue

Returns:

a descriptive value