Top Description Methods
org.apache.derby.iapi.store.raw

public Interface ScanHandle

Known Direct Implementers
org.apache.derby.impl.store.raw.log.FlushedScanHandle
Imports
org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.store.access.DatabaseInstant, java.io.InputStream

Inteface for scanning the log from outside the RawStore.

Method Summary

Modifier and TypeMethod and Description
public void
close()

Close this scan.

public int
getGroup()

Get the group for the current log record.

public DatabaseInstant
getInstant()

Get the DatabaseInstant for the current log record.

public Loggable
getLoggable()

Get the Loggable associated with the currentLogRecord

public InputStream
getOptionalData()

Get an InputStream for reading the optional data associated with the current log record.

public Object
getTransactionId()

Get the TransactionId for the current log record.

public boolean

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.
next
()

Position to the next log record.

Method Detail

closeback to summary
public void close()

Close this scan.

getGroupback to summary
public int getGroup() throws StandardException

Get the group for the current log record.

Exceptions
StandardException:
Oops
getInstantback to summary
public DatabaseInstant getInstant() throws StandardException

Get the DatabaseInstant for the current log record.

Exceptions
StandardException:
Oops
getLoggableback to summary
public Loggable getLoggable() throws StandardException

Get the Loggable associated with the currentLogRecord

Exceptions
StandardException:
Oops
getOptionalDataback to summary
public 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.

Exceptions
StandardException:
Oops
getTransactionIdback to summary
public Object getTransactionId() throws StandardException

Get the TransactionId for the current log record.

Exceptions
StandardException:
Oops
nextback to summary
public boolean next() throws StandardException

Position to the next log record.

Returns:boolean

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.

Exceptions
StandardException:
Oops