Top Fields Constructors Methods
org.apache.derby.impl.store.raw.log

public Class FlushedScanHandle

extends Object
implements ScanHandle
Class Inheritance
All Implemented Interfaces
org.apache.derby.iapi.store.raw.ScanHandle
Imports
org.apache.derby.shared.common.reference.SQLState, org.apache.derby.impl.store.raw.log.LogCounter, .LogRecord, .StreamLogScan, org.apache.derby.iapi.services.io.ArrayInputStream, org.apache.derby.shared.common.sanity.SanityManager, org.apache.derby.shared.common.error.StandardException, org.apache.derby.iapi.store.raw.Loggable, .ScanHandle, .ScannedTransactionHandle, org.apache.derby.iapi.store.raw.log.LogFactory, .LogInstant, org.apache.derby.iapi.store.raw.xact.TransactionId, org.apache.derby.iapi.store.access.DatabaseInstant, java.io.IOException, .InputStream, java.util.Enumeration

Field Summary

Modifier and TypeField and Description
pack-priv StreamLogScan
fs

pack-priv int
groupsIWant

pack-priv LogFactory
lf

pack-priv LogRecord
lr

pack-priv ArrayInputStream
rawInput

pack-priv boolean
readOptionalData

Constructor Summary

AccessConstructor and Description
pack-priv
FlushedScanHandle(LogToFile lf, DatabaseInstant start, int groupsIWant)

Method Summary

Modifier and TypeMethod and Description
public void
close()

Implements org.apache.derby.iapi.store.raw.ScanHandle.close.

Close this scan.

public int
getGroup()

Implements org.apache.derby.iapi.store.raw.ScanHandle.getGroup.

Get the group for the current log record.

public DatabaseInstant
getInstant()

Implements org.apache.derby.iapi.store.raw.ScanHandle.getInstant.

Get the DatabaseInstant for the current log record.

public Loggable
getLoggable()

Implements org.apache.derby.iapi.store.raw.ScanHandle.getLoggable.

Get the Loggable associated with the currentLogRecord

public InputStream
getOptionalData()

Implements org.apache.derby.iapi.store.raw.ScanHandle.getOptionalData.

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

public Object
getTransactionId()

Implements org.apache.derby.iapi.store.raw.ScanHandle.getTransactionId.

Get the TransactionId for the current log record.

public boolean
next()

Implements org.apache.derby.iapi.store.raw.ScanHandle.next.

Position to the next log record.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

fsback to summary
pack-priv StreamLogScan fs
groupsIWantback to summary
pack-priv int groupsIWant
lfback to summary
pack-priv LogFactory lf
lrback to summary
pack-priv LogRecord lr
rawInputback to summary
pack-priv ArrayInputStream rawInput
readOptionalDataback to summary
pack-priv boolean readOptionalData

Constructor Detail

FlushedScanHandleback to summary
pack-priv FlushedScanHandle(LogToFile lf, DatabaseInstant start, int groupsIWant) throws StandardException

Method Detail

closeback to summary
public void close()

Implements org.apache.derby.iapi.store.raw.ScanHandle.close.

Doc from org.apache.derby.iapi.store.raw.ScanHandle.close.

Close this scan.

getGroupback to summary
public int getGroup() throws StandardException

Implements org.apache.derby.iapi.store.raw.ScanHandle.getGroup.

Get the group for the current log record.

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

Implements org.apache.derby.iapi.store.raw.ScanHandle.getInstant.

Doc from org.apache.derby.iapi.store.raw.ScanHandle.getInstant.

Get the DatabaseInstant for the current log record.

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

Implements org.apache.derby.iapi.store.raw.ScanHandle.getLoggable.

Get the Loggable associated with the currentLogRecord

Exceptions
StandardException:
Oops
getOptionalDataback to summary
public InputStream getOptionalData() throws StandardException

Implements org.apache.derby.iapi.store.raw.ScanHandle.getOptionalData.

Doc from org.apache.derby.iapi.store.raw.ScanHandle.getOptionalData.

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

Implements org.apache.derby.iapi.store.raw.ScanHandle.getTransactionId.

Doc from org.apache.derby.iapi.store.raw.ScanHandle.getTransactionId.

Get the TransactionId for the current log record.

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

Implements org.apache.derby.iapi.store.raw.ScanHandle.next.

Doc from org.apache.derby.iapi.store.raw.ScanHandle.next.

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