|
Quadcap Embeddable Database |
00001 package com.quadcap.sql.file; 00002 00003 /* Copyright 1997 - 2003 Quadcap Software. All rights reserved. 00004 * 00005 * This software is distributed under the Quadcap Free Software License. 00006 * This software may be used or modified for any purpose, personal or 00007 * commercial. Open Source redistributions are permitted. Commercial 00008 * redistribution of larger works derived from, or works which bundle 00009 * this software requires a "Commercial Redistribution License"; see 00010 * http://www.quadcap.com/purchase. 00011 * 00012 * Redistributions qualify as "Open Source" under one of the following terms: 00013 * 00014 * Redistributions are made at no charge beyond the reasonable cost of 00015 * materials and delivery. 00016 * 00017 * Redistributions are accompanied by a copy of the Source Code or by an 00018 * irrevocable offer to provide a copy of the Source Code for up to three 00019 * years at the cost of materials and delivery. Such redistributions 00020 * must allow further use, modification, and redistribution of the Source 00021 * Code under substantially the same terms as this license. 00022 * 00023 * Redistributions of source code must retain the copyright notices as they 00024 * appear in each source code file, these license terms, and the 00025 * disclaimer/limitation of liability set forth as paragraph 6 below. 00026 * 00027 * Redistributions in binary form must reproduce this Copyright Notice, 00028 * these license terms, and the disclaimer/limitation of liability set 00029 * forth as paragraph 6 below, in the documentation and/or other materials 00030 * provided with the distribution. 00031 * 00032 * The Software is provided on an "AS IS" basis. No warranty is 00033 * provided that the Software is free of defects, or fit for a 00034 * particular purpose. 00035 * 00036 * Limitation of Liability. Quadcap Software shall not be liable 00037 * for any damages suffered by the Licensee or any third party resulting 00038 * from use of the Software. 00039 */ 00040 00041 import java.io.IOException; 00042 import java.io.InputStream; 00043 import java.io.OutputStream; 00044 00045 /** 00046 * Interface to be implemented by segment allocators 00047 * 00048 * @author Stan Bailes 00049 */ 00050 public interface SegmentManager { 00051 /** 00052 * Return a new input stream, reading from the region with the specified 00053 * root segment. 00054 * 00055 * @param segment the root segment of the region 00056 * @return an InputStream bound to the region. 00057 * @exception IOException if the segment number isn't valid, or if another 00058 * error is detected trying to access the region. 00059 */ 00060 public RandomAccessInputStream getInputStream(long seg) 00061 throws IOException; 00062 00063 /** 00064 * Return a new output stream, writing to the region with the specified 00065 * root segment. 00066 * 00067 * @param segment the root segment of the region 00068 * @return an OutputStream bound to the region. 00069 * @exception IOException if the segment number isn't valid, or if another 00070 * error is detected trying to access the region. 00071 */ 00072 public RandomAccessOutputStream getOutputStream(long seg) 00073 throws IOException; 00074 00075 /** 00076 * Return the random-access region with the specified root segment. 00077 */ 00078 public RandomAccess getStream(long seg) throws IOException; 00079 00080 /** 00081 * Destroy the stream with the specified root segment and free up the 00082 7 * storage it was using. 00083 * 00084 * @param segment the root segment of the region 00085 * 00086 * @exception IOException if the segment number isn't valid, or if another 00087 * error is detected trying to access the region. 00088 */ 00089 public void freeSegment(long seg) throws IOException; 00090 00091 /** 00092 * Create a new segment with the specified bytes value and return 00093 * its reference 00094 * 00095 * @param buf the value to write to the new segment 00096 * @return the segment id 00097 */ 00098 public long putBytes(byte[] buf) throws IOException; 00099 00100 /** 00101 * Return the segment as a byte array 00102 * 00103 * @param seg the segment id 00104 * @return the value of the segment's bytes 00105 */ 00106 public byte[] getBytes(long seg) throws IOException; 00107 00108 /** 00109 * Update a segment with new value bytes. 00110 * 00111 * @param buf the value to write to the segment 00112 * @param seg the segment id 00113 */ 00114 public void updateBytes(long seg, byte[] buf) throws IOException; 00115 }