01: /* Copyright (c) 2001-2005, The HSQL Development Group
02: * All rights reserved.
03: *
04: * Redistribution and use in source and binary forms, with or without
05: * modification, are permitted provided that the following conditions are met:
06: *
07: * Redistributions of source code must retain the above copyright notice, this
08: * list of conditions and the following disclaimer.
09: *
10: * Redistributions in binary form must reproduce the above copyright notice,
11: * this list of conditions and the following disclaimer in the documentation
12: * and/or other materials provided with the distribution.
13: *
14: * Neither the name of the HSQL Development Group nor the names of its
15: * contributors may be used to endorse or promote products derived from this
16: * software without specific prior written permission.
17: *
18: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
19: * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
20: * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
21: * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG,
22: * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
23: * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
24: * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25: * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
26: * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
27: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
28: * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
29: */
30:
31: package org.hsqldb.persist;
32:
33: import java.io.IOException;
34:
35: import org.hsqldb.rowio.RowInputInterface;
36:
37: /**
38: * Interface for a store for CachedObject object.
39: *
40: * @author fredt@users
41: * @version 1.8.0
42: * @since 1.8.0
43: */
44: public interface PersistentStore {
45:
46: int INT_STORE_SIZE = 4;
47: int LONG_STORE_SIZE = 8;
48:
49: /** get object */
50: CachedObject get(int key);
51:
52: /** get object, ensuring future gets will return the same instance of the object */
53: CachedObject getKeep(int key);
54:
55: int getStorageSize(int key);
56:
57: /** add new object */
58: void add(CachedObject object) throws IOException;
59:
60: /** add object previously removed from persistnce */
61: void restore(CachedObject object) throws IOException;
62:
63: CachedObject get(RowInputInterface in) throws IOException;
64:
65: CachedObject getNewInstance(int size) throws IOException;
66:
67: /** remove the persisted image but not the cached copy */
68: void removePersistence(int i);
69:
70: /** remove both persisted and cached copies */
71: void remove(int i);
72:
73: /** remove the cached copies */
74: void release(int i);
75:
76: /** commit persisted image */
77: void commit(CachedObject object);
78: }
|