KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > quadcap > sql > file > SegmentManager


1 package com.quadcap.sql.file;
2
3 /* Copyright 1997 - 2003 Quadcap Software. All rights reserved.
4  *
5  * This software is distributed under the Quadcap Free Software License.
6  * This software may be used or modified for any purpose, personal or
7  * commercial. Open Source redistributions are permitted. Commercial
8  * redistribution of larger works derived from, or works which bundle
9  * this software requires a "Commercial Redistribution License"; see
10  * http://www.quadcap.com/purchase.
11  *
12  * Redistributions qualify as "Open Source" under one of the following terms:
13  *
14  * Redistributions are made at no charge beyond the reasonable cost of
15  * materials and delivery.
16  *
17  * Redistributions are accompanied by a copy of the Source Code or by an
18  * irrevocable offer to provide a copy of the Source Code for up to three
19  * years at the cost of materials and delivery. Such redistributions
20  * must allow further use, modification, and redistribution of the Source
21  * Code under substantially the same terms as this license.
22  *
23  * Redistributions of source code must retain the copyright notices as they
24  * appear in each source code file, these license terms, and the
25  * disclaimer/limitation of liability set forth as paragraph 6 below.
26  *
27  * Redistributions in binary form must reproduce this Copyright Notice,
28  * these license terms, and the disclaimer/limitation of liability set
29  * forth as paragraph 6 below, in the documentation and/or other materials
30  * provided with the distribution.
31  *
32  * The Software is provided on an "AS IS" basis. No warranty is
33  * provided that the Software is free of defects, or fit for a
34  * particular purpose.
35  *
36  * Limitation of Liability. Quadcap Software shall not be liable
37  * for any damages suffered by the Licensee or any third party resulting
38  * from use of the Software.
39  */
40
41 import java.io.IOException JavaDoc;
42 import java.io.InputStream JavaDoc;
43 import java.io.OutputStream JavaDoc;
44
45 /**
46  * Interface to be implemented by segment allocators
47  *
48  * @author Stan Bailes
49  */
50 public interface SegmentManager {
51     /**
52      * Return a new input stream, reading from the region with the specified
53      * root segment.
54      *
55      * @param segment the root segment of the region
56      * @return an InputStream bound to the region.
57      * @exception IOException if the segment number isn't valid, or if another
58      * error is detected trying to access the region.
59      */
60     public RandomAccessInputStream getInputStream(long seg)
61         throws IOException JavaDoc;
62
63     /**
64      * Return a new output stream, writing to the region with the specified
65      * root segment.
66      *
67      * @param segment the root segment of the region
68      * @return an OutputStream bound to the region.
69      * @exception IOException if the segment number isn't valid, or if another
70      * error is detected trying to access the region.
71      */
72     public RandomAccessOutputStream getOutputStream(long seg)
73         throws IOException JavaDoc;
74
75     /**
76      * Return the random-access region with the specified root segment.
77      */
78     public RandomAccess getStream(long seg) throws IOException JavaDoc;
79     
80     /**
81      * Destroy the stream with the specified root segment and free up the
82 7 * storage it was using.
83      *
84      * @param segment the root segment of the region
85      *
86      * @exception IOException if the segment number isn't valid, or if another
87      * error is detected trying to access the region.
88      */
89     public void freeSegment(long seg) throws IOException JavaDoc;
90
91     /**
92      * Create a new segment with the specified bytes value and return
93      * its reference
94      *
95      * @param buf the value to write to the new segment
96      * @return the segment id
97      */
98     public long putBytes(byte[] buf) throws IOException JavaDoc;
99
100     /**
101      * Return the segment as a byte array
102      *
103      * @param seg the segment id
104      * @return the value of the segment's bytes
105      */
106     public byte[] getBytes(long seg) throws IOException JavaDoc;
107
108     /**
109      * Update a segment with new value bytes.
110      *
111      * @param buf the value to write to the segment
112      * @param seg the segment id
113      */
114     public void updateBytes(long seg, byte[] buf) throws IOException JavaDoc;
115 }
116
Popular Tags