org.apache.derby.iapi.store.raw
Interface ScanHandle

All Known Implementing Classes:
FlushedScanHandle

public interface ScanHandle

Inteface for scanning the log from outside the RawStore.


Method Summary
 void close()
          Close this scan.
 int getGroup()
          Get the group for the current log record.
 DatabaseInstant getInstant()
          Get the DatabaseInstant for the current log record.
 Loggable getLoggable()
          Get the Loggable associated with the currentLogRecord
 java.io.InputStream getOptionalData()
          Get an InputStream for reading the optional data associated with the current log record.
 java.lang.Object getTransactionId()
          Get the TransactionId for the current log record.
 boolean next()
          Position to the next log record.
 

Method Detail

next

boolean next()
             throws StandardException
Position to the next log record.

Returns:
true if the log contains a next flushed log record and false otherwise. If this returns false it is incorrect to make any of the other calls on this interface.
Throws:
StandardException - Oops

getGroup

int getGroup()
             throws StandardException
Get the group for the current log record.

Throws:
StandardException - Oops

getLoggable

Loggable getLoggable()
                     throws StandardException
Get the Loggable associated with the currentLogRecord

Throws:
StandardException - Oops

getOptionalData

java.io.InputStream getOptionalData()
                                    throws StandardException
Get an InputStream for reading the optional data associated with the current log record. This may only be called once per log record.

Throws:
StandardException - Oops

getInstant

DatabaseInstant getInstant()
                           throws StandardException
Get the DatabaseInstant for the current log record.

Throws:
StandardException - Oops

getTransactionId

java.lang.Object getTransactionId()
                                  throws StandardException
Get the TransactionId for the current log record.

Throws:
StandardException - Oops

close

void close()
Close this scan.


Built on Thu 2010-12-23 20:49:13+0000, from revision ???

Apache Derby V10.6 Internals - Copyright © 2004,2007 The Apache Software Foundation. All Rights Reserved.