com.levigo.jadice.document
Interface SourceID

All Known Subinterfaces:

PageSegmentSource

All Known Implementing Classes:

ReaderListener.ReaderEvent

public interface SourceID

A PageSourceID uniquely identifies a Page using a tuple of information collected during the reading of one of its page segments:

• the read-ID of the read operation during which the page segment was read
• the index of the stream within the read operation from which the page segment was read
• the index of the page within the stream from which the page segment was read

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.
int	getStreamPageIndex() Get the index of the page within the stream from 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

getStreamPageIndex

int getStreamPageIndex()

Get the index of the page within the stream from which the page segment was read.

Returns:

the zero-based page index