org.sdmxsource.sdmx.api.util

Interface ReadableDataLocation

All Superinterfaces:

java.io.Serializable

All Known Subinterfaces:

WriteableDataLocation

All Known Implementing Classes:

InMemoryReadableDataLocation, OverflowWriteableDataLocation, ReadableDataLocationTmp, WriteableDataLocationTmp

public interface ReadableDataLocation
extends java.io.Serializable

ReadableDataLocation is capable of reading and re-reading the same source of data many times

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes (and removes if appropriate) any resources that are held open
ReadableDataLocation	copy() Returns a copy of this ReadableDataLocation.
java.io.InputStream	getInputStream() This method is guaranteed to return a new InputStream on each method call.
java.lang.String	getName() If this ReadableDataLocation originated from a file, then this will be the original file name, regardless of where the stream is actually held.
boolean	isClosed() Returns whether this ReadableDataLocation is closed or not.

Method Detail

getInputStream

java.io.InputStream getInputStream()

This method is guaranteed to return a new InputStream on each method call. The InputStream will be reading the same underlying data source.

Returns:

a new InputStream

getName

java.lang.String getName()

If this ReadableDataLocation originated from a file, then this will be the original file name, regardless of where the stream is actually held. This method may return null if the name is not relevant.

Returns:

the name or null.

close

void close()

Closes (and removes if appropriate) any resources that are held open

isClosed

boolean isClosed()

Returns whether this ReadableDataLocation is closed or not.

Returns:

true if closed

copy

ReadableDataLocation copy()

Returns a copy of this ReadableDataLocation.

Returns:

a new copy of this object.