com.levigo.jadice.document
Interface SourceID

All Superinterfaces:

StreamSourceID

All Known Implementing Classes:

ReaderListener.ReaderEvent

public interface SourceID
extends StreamSourceID

A SourceID uniquely identifies a page using a tuple of information collected during the reading process:

• 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

Note that the page being identified here is a format-specific page, not a document-independent jadice Page object.

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

Method Summary

int	getStreamPageIndex() Get the index of the page within the stream from which the page segment was read.

Methods inherited from interface com.levigo.jadice.document.StreamSourceID

getReadID, getStreamIndex

Method Detail

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