001: // kelondroIndex.java
002: // ------------------
003: // part of the Kelondro Database
004: // (C) by Michael Peter Christen; mc@anomic.de
005: // first published on http://www.anomic.de
006: // Frankfurt, Germany, 2005
007: // created: 26.10.2005
008: //
009: // This program is free software; you can redistribute it and/or modify
010: // it under the terms of the GNU General Public License as published by
011: // the Free Software Foundation; either version 2 of the License, or
012: // (at your option) any later version.
013: //
014: // This program is distributed in the hope that it will be useful,
015: // but WITHOUT ANY WARRANTY; without even the implied warranty of
016: // MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
017: // GNU General Public License for more details.
018: //
019: // You should have received a copy of the GNU General Public License
020: // along with this program; if not, write to the Free Software
021: // Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
022: //
023: // Using this software in any meaning (reading, learning, copying, compiling,
024: // running) means that you agree that the Author(s) is (are) not responsible
025: // for cost, loss of data or any harm that may be caused directly or indirectly
026: // by usage of this softare or this documentation. The usage of this software
027: // is on your own risk. The installation and usage (starting/running) of this
028: // software may allow other people or application to access your computer and
029: // any attached devices and is highly dependent on the configuration of the
030: // software which must be done by the user of the software; the author(s) is
031: // (are) also not responsible for proper configuration and usage of the
032: // software, even if provoked by documentation provided together with
033: // the software.
034: //
035: // Any changes to this file according to the GPL as documented in the file
036: // gpl.txt aside this file in the shipment you received can be done to the
037: // lines that follows this copyright notice here, but changes must not be
038: // done inside the copyright notive above. A re-distribution must contain
039: // the intact and unchanged copyright notice.
040: // Contributions and changes to the program code must be marked as such.
041:
042: /* A kelondroIndex is a table with indexed access on the first column
043: Elements may be selected from the table with logarithmic computation time
044: using the get-method. Inserts have also the same computation order and
045: can be done with the put-method.
046:
047: The kelondro Database provides two implementations of this interface:
048: kelondroTree and kelondroHashtable
049: */
050:
051: package de.anomic.kelondro;
052:
053: import java.io.IOException;
054: import java.util.ArrayList;
055: import java.util.Date;
056: import java.util.List;
057:
058: public interface kelondroIndex {
059:
060: public String filename(); // returns a unique identified for this index; can be a real or artificial file name
061:
062: public int size();
063:
064: public kelondroProfile profile();
065:
066: public kelondroRow row();
067:
068: public boolean has(byte[] key) throws IOException; // use this only if there is no get in case that has returns true
069:
070: public kelondroRow.Entry get(byte[] key) throws IOException;
071:
072: public kelondroRow.Entry put(kelondroRow.Entry row)
073: throws IOException;
074:
075: public kelondroRow.Entry put(kelondroRow.Entry row, Date entryDate)
076: throws IOException;
077:
078: public void putMultiple(List<kelondroRow.Entry> rows)
079: throws IOException; // for R/W head path optimization
080:
081: public void addUnique(kelondroRow.Entry row) throws IOException; // no double-check
082:
083: public void addUniqueMultiple(List<kelondroRow.Entry> rows)
084: throws IOException; // no double-check
085:
086: public ArrayList<kelondroRowSet> removeDoubles() throws IOException; // removes all elements that are double (to be used after all addUnique)
087:
088: public kelondroRow.Entry remove(byte[] key, boolean keepOrder)
089: throws IOException;
090:
091: public kelondroRow.Entry removeOne() throws IOException;
092:
093: public kelondroCloneableIterator<byte[]> keys(boolean up,
094: byte[] firstKey) throws IOException; // iterates only the key
095:
096: public kelondroCloneableIterator<kelondroRow.Entry> rows(
097: boolean up, byte[] firstKey) throws IOException; // iterates the whole row
098:
099: public void close();
100:
101: public void reset() throws IOException;
102: }
|