001: package com.quadcap.sql.file;
002:
003: /* Copyright 1997 - 2003 Quadcap Software. All rights reserved.
004: *
005: * This software is distributed under the Quadcap Free Software License.
006: * This software may be used or modified for any purpose, personal or
007: * commercial. Open Source redistributions are permitted. Commercial
008: * redistribution of larger works derived from, or works which bundle
009: * this software requires a "Commercial Redistribution License"; see
010: * http://www.quadcap.com/purchase.
011: *
012: * Redistributions qualify as "Open Source" under one of the following terms:
013: *
014: * Redistributions are made at no charge beyond the reasonable cost of
015: * materials and delivery.
016: *
017: * Redistributions are accompanied by a copy of the Source Code or by an
018: * irrevocable offer to provide a copy of the Source Code for up to three
019: * years at the cost of materials and delivery. Such redistributions
020: * must allow further use, modification, and redistribution of the Source
021: * Code under substantially the same terms as this license.
022: *
023: * Redistributions of source code must retain the copyright notices as they
024: * appear in each source code file, these license terms, and the
025: * disclaimer/limitation of liability set forth as paragraph 6 below.
026: *
027: * Redistributions in binary form must reproduce this Copyright Notice,
028: * these license terms, and the disclaimer/limitation of liability set
029: * forth as paragraph 6 below, in the documentation and/or other materials
030: * provided with the distribution.
031: *
032: * The Software is provided on an "AS IS" basis. No warranty is
033: * provided that the Software is free of defects, or fit for a
034: * particular purpose.
035: *
036: * Limitation of Liability. Quadcap Software shall not be liable
037: * for any damages suffered by the Licensee or any third party resulting
038: * from use of the Software.
039: */
040:
041: import java.io.IOException;
042: import java.io.InputStream;
043: import java.io.OutputStream;
044:
045: /**
046: * Interface to be implemented by segment allocators
047: *
048: * @author Stan Bailes
049: */
050: public interface SegmentManager {
051: /**
052: * Return a new input stream, reading from the region with the specified
053: * root segment.
054: *
055: * @param segment the root segment of the region
056: * @return an InputStream bound to the region.
057: * @exception IOException if the segment number isn't valid, or if another
058: * error is detected trying to access the region.
059: */
060: public RandomAccessInputStream getInputStream(long seg)
061: throws IOException;
062:
063: /**
064: * Return a new output stream, writing to the region with the specified
065: * root segment.
066: *
067: * @param segment the root segment of the region
068: * @return an OutputStream bound to the region.
069: * @exception IOException if the segment number isn't valid, or if another
070: * error is detected trying to access the region.
071: */
072: public RandomAccessOutputStream getOutputStream(long seg)
073: throws IOException;
074:
075: /**
076: * Return the random-access region with the specified root segment.
077: */
078: public RandomAccess getStream(long seg) throws IOException;
079:
080: /**
081: * Destroy the stream with the specified root segment and free up the
082: 7 * storage it was using.
083: *
084: * @param segment the root segment of the region
085: *
086: * @exception IOException if the segment number isn't valid, or if another
087: * error is detected trying to access the region.
088: */
089: public void freeSegment(long seg) throws IOException;
090:
091: /**
092: * Create a new segment with the specified bytes value and return
093: * its reference
094: *
095: * @param buf the value to write to the new segment
096: * @return the segment id
097: */
098: public long putBytes(byte[] buf) throws IOException;
099:
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;
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;
115: }
|