1 /**
2 * Copyright (c) 2011, University of Konstanz, Distributed Systems Group
3 * All rights reserved.
4 *
5 * Redistribution and use in source and binary forms, with or without
6 * modification, are permitted provided that the following conditions are met:
7 * * Redistributions of source code must retain the above copyright
8 * notice, this list of conditions and the following disclaimer.
9 * * Redistributions in binary form must reproduce the above copyright
10 * notice, this list of conditions and the following disclaimer in the
11 * documentation and/or other materials provided with the distribution.
12 * * Neither the name of the University of Konstanz nor the
13 * names of its contributors may be used to endorse or promote products
14 * derived from this software without specific prior written permission.
15 *
16 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
17 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
18 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
19 * DISCLAIMED. IN NO EVENT SHALL <COPYRIGHT HOLDER> BE LIABLE FOR ANY
20 * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
21 * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
22 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
23 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
25 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
26 */
27
28 package org.treetank.io;
29
30 import org.treetank.bucket.UberBucket;
31 import org.treetank.bucket.interfaces.IBucket;
32 import org.treetank.exception.TTException;
33 import org.treetank.exception.TTIOException;
34
35 /**
36 * Interface for reading the stored buckets in every backend.
37 *
38 * @author Sebastian Graf, University of Konstanz
39 *
40 */
41 public interface IBackendReader {
42
43 /**
44 * Getting a reference for the given pointer.
45 *
46 * @param pKey
47 * the reference for the bucket to be determined
48 * @return a {@link IBucket} as the base for a bucket
49 * @throws TTException
50 * if something bad happens during read
51 */
52 IBucket read(final long pKey) throws TTIOException;
53
54 /**
55 * Reading the UberBucket
56 *
57 * @return the most recent UberBucket
58 * @throws TTException
59 */
60 UberBucket readUber() throws TTIOException;
61
62 /**
63 * Closing the storage.
64 *
65 * @throws TTIOException
66 * if something bad happens while access
67 */
68 void close() throws TTIOException;
69
70 }