com.levigo.jadice.document
Interface StreamSourceID

All Known Subinterfaces:

SourceID

All Known Implementing Classes:

ReaderListener.ReaderEvent

public interface StreamSourceID

A StreamSourceID uniquely identifies a stream which was used during a reading process. It consists of:

• the read-ID of the read operation during which the stream was read
• the index of the stream within the read operations performed by this reader

Implementors of this interface are required to provide useful hashCode() and equals() methods.

Method Summary

String	getReadID() Get the read-ID of the read operation during which the page segment was read.
int	getStreamIndex() Return the source stream's index within the read operation during which the page segment was read.

Method Detail

getReadID

String getReadID()

Get the read-ID of the read operation during which the page segment was read. This ID is, for example, derived from the ID of the Reader instance used to read the stream.

Returns:

the read-ID

getStreamIndex

int getStreamIndex()

Return the source stream's index within the read operation during which the page segment was read. Every Reader maintains a counter of streams that were loaded using the reader.

Returns:

the zero-based stream index