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 package org.treetank.bucket.interfaces;
28
29 import java.io.DataOutput;
30
31 import org.treetank.exception.TTIOException;
32
33 import com.google.common.hash.HashCode;
34
35 /**
36 * Interface to represent one bucket.
37 * A bucket is the atomic unique to be serializible and represents one bucket when stored.
38 * Pointers as well as any datas may be stored within one bucket.
39 *
40 * @author Sebastian Graf, University of Konstanz
41 *
42 */
43 public interface IBucket {
44
45 /**
46 * Getting the key of a bucket for dereferencing over any pointers as well, the access in the log and for
47 * retrieving buckets from the persistent storage.
48 *
49 * @return the key of the bucket
50 */
51 long getBucketKey();
52
53 /**
54 * Serializing to given dataput
55 *
56 * @param pOutput
57 * to serialize to
58 * @throws TTIOException
59 */
60 void serialize(final DataOutput pOutput) throws TTIOException;
61
62 /**
63 * Getting a secure hash for a bucket.
64 *
65 * @return the bytes representing a secure hash
66 */
67 HashCode secureHash();
68
69 }