001: /*
002: * $Id: Index.java,v 1.22 2005/12/20 18:32:40 ahimanikya Exp $
003: * =======================================================================
004: * Copyright (c) 2002-2006 Axion Development Team. All rights reserved.
005: *
006: * Redistribution and use in source and binary forms, with or without
007: * modification, are permitted provided that the following conditions
008: * are met:
009: *
010: * 1. Redistributions of source code must retain the above
011: * copyright notice, this list of conditions and the following
012: * disclaimer.
013: *
014: * 2. Redistributions in binary form must reproduce the above copyright
015: * notice, this list of conditions and the following disclaimer in
016: * the documentation and/or other materials provided with the
017: * distribution.
018: *
019: * 3. The names "Tigris", "Axion", nor the names of its contributors may
020: * not be used to endorse or promote products derived from this
021: * software without specific prior written permission.
022: *
023: * 4. Products derived from this software may not be called "Axion", nor
024: * may "Tigris" or "Axion" appear in their names without specific prior
025: * written permission.
026: *
027: * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
028: * "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
029: * LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
030: * PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT
031: * OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
032: * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
033: * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
034: * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
035: * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
036: * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
037: * OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
038: * =======================================================================
039: */
040:
041: package org.axiondb;
042:
043: import java.io.File;
044:
045: import org.axiondb.event.TableModificationListener;
046:
047: /**
048: * A database index. (Right now, this class assumes an Index over a single column.
049: * Multipart indices will come later.)
050: * <p>
051: * TODO: Support expression and/or function e.g UPPER(name) <br>
052: * TODO: Support for Multi column index, very useful for composite keys
053: *
054: * @version $Revision: 1.22 $ $Date: 2005/12/20 18:32:40 $
055: * @author Morgan Delagrange
056: * @author Rodney Waldhoff
057: * @author Chuck Burdick
058: * @author Ahimanikya Satapathy
059: */
060: public interface Index extends TableModificationListener {
061:
062: public static final String ARRAY = "array";
063: public static final String BTREE = "btree";
064: public static final String DEFAULT = "default";
065: public static final String TTREE = "ttree";
066:
067: void changeRowId(Table table, Row row, int oldId, int newId)
068: throws AxionException;
069:
070: /**
071: * Returns the column I index.
072: */
073: Column getIndexedColumn();
074:
075: IndexLoader getIndexLoader();
076:
077: /**
078: * Returns a {@link RowIterator}which is inorder traversal of keys,
079: *
080: * @param source table/view for which we need to get inorder traversal
081: * @return
082: * @throws AxionException
083: */
084: RowIterator getInorderRowIterator(RowSource source)
085: throws AxionException;
086:
087: /**
088: * Returns my name.
089: */
090: String getName();
091:
092: /**
093: * Returns a {@link RowIterator}over the indexed rows, limited by the given
094: * {@link ComparisonOperator}/value pair, using the default sort order.
095: *
096: * @param operator the {@link ComparisonOperator}to apply
097: * @param value the value to compare the indexed column to
098: */
099: RowIterator getRowIterator(RowSource source, Function fn,
100: Object value) throws AxionException;
101:
102: /**
103: * Returns my type.
104: */
105: String getType();
106:
107: /**
108: * Whether or not I allow duplicate values.
109: */
110: boolean isUnique();
111:
112: void save(File dataDirectory) throws AxionException;
113:
114: void saveAfterTruncate(File dataDirectory) throws AxionException;
115:
116: /**
117: * Returns <tt>true</tt> iff
118: * {@link #getRowIterator(org.axiondb.RowSource,org.axiondb.ComparisonOperator,java.lang.Object)}
119: * can support the given operator, <tt>false</tt> otherwise.
120: */
121: boolean supportsFunction(Function fn);
122:
123: void truncate() throws AxionException;
124: }
|