KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > derby > iapi > store > raw > ScanHandle


1 /*
2
3    Derby - Class org.apache.derby.iapi.store.raw.ScanHandle
4
5    Licensed to the Apache Software Foundation (ASF) under one or more
6    contributor license agreements. See the NOTICE file distributed with
7    this work for additional information regarding copyright ownership.
8    The ASF licenses this file to you under the Apache License, Version 2.0
9    (the "License"); you may not use this file except in compliance with
10    the License. You may obtain a copy of the License at
11
12       http://www.apache.org/licenses/LICENSE-2.0
13
14    Unless required by applicable law or agreed to in writing, software
15    distributed under the License is distributed on an "AS IS" BASIS,
16    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
17    See the License for the specific language governing permissions and
18    limitations under the License.
19
20  */
21
22 package org.apache.derby.iapi.store.raw;
23
24 import org.apache.derby.iapi.error.StandardException;
25 import org.apache.derby.iapi.store.access.DatabaseInstant;
26 import java.io.InputStream JavaDoc;
27
28 /**
29   Inteface for scanning the log from outside the RawStore.
30   */
31 public interface ScanHandle
32 {
33     /**
34       Position to the next log record.
35       @return true if the log contains a next flushed log record and
36                false otherwise. If this returns false it is incorrect
37                to make any of the other calls on this interface.
38       @exception StandardException Oops
39       */
40     public boolean next() throws StandardException;
41
42     /**
43       Get the group for the current log record.
44       @exception StandardException Oops
45       */
46     public int getGroup() throws StandardException;
47
48     /**
49       Get the Loggable associated with the currentLogRecord
50       @exception StandardException Oops
51       */
52     public Loggable getLoggable() throws StandardException;
53     /**
54       Get an InputStream for reading the optional data associated with
55       the current log record. This may only be called once per log record.
56       @exception StandardException Oops
57       */
58     public InputStream JavaDoc getOptionalData() throws StandardException;
59     /**
60       Get the DatabaseInstant for the current log record.
61       @exception StandardException Oops
62       */
63     public DatabaseInstant getInstant() throws StandardException;
64     /**
65       Get the TransactionId for the current log record.
66       @exception StandardException Oops
67       */
68     public Object JavaDoc getTransactionId() throws StandardException;
69     /**
70       Close this scan.
71       */
72     public void close();
73 }
74
Popular Tags