001: /*
002: * $Id: BaseIndex.java,v 1.5 2005/12/20 18:32:40 ahimanikya Exp $
003: * =======================================================================
004: * Copyright (c) 2002-2005 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.engine.indexes;
042:
043: import java.io.File;
044: import java.util.Comparator;
045:
046: import org.axiondb.AxionException;
047: import org.axiondb.Column;
048: import org.axiondb.DataType;
049: import org.axiondb.Function;
050: import org.axiondb.Index;
051: import org.axiondb.IndexLoader;
052: import org.axiondb.RowIterator;
053: import org.axiondb.RowSource;
054: import org.axiondb.event.BaseTableModificationListener;
055: import org.axiondb.event.TableModificationListener;
056:
057: /**
058: * Abstract base implementation of {@link Index}.
059: *
060: * @version $Revision: 1.5 $ $Date: 2005/12/20 18:32:40 $
061: * @author Chuck Burdick
062: */
063: public abstract class BaseIndex extends BaseTableModificationListener
064: implements Index, TableModificationListener {
065:
066: public BaseIndex(String name, Column column, boolean unique) {
067: _name = name;
068: _col = column;
069: _isUnique = unique;
070: _dataType = _col.getDataType();
071: }
072:
073: public Column getIndexedColumn() {
074: return _col;
075: }
076:
077: public abstract IndexLoader getIndexLoader();
078:
079: public abstract RowIterator getInorderRowIterator(RowSource source)
080: throws AxionException;
081:
082: public String getName() {
083: return _name;
084: }
085:
086: public abstract RowIterator getRowIterator(RowSource source,
087: Function fn, Object value) throws AxionException;
088:
089: public boolean isUnique() {
090: return _isUnique;
091: }
092:
093: public abstract void save(File dataDirectory) throws AxionException;
094:
095: public abstract void saveAfterTruncate(File dataDirectory)
096: throws AxionException;
097:
098: public abstract boolean supportsFunction(Function fn);
099:
100: public abstract void truncate() throws AxionException;
101:
102: protected Comparator getComparator() {
103: return _dataType;
104: }
105:
106: protected DataType getDataType() {
107: return _dataType;
108: }
109:
110: private Column _col = null;
111: private DataType _dataType = null;
112: private boolean _isUnique = false;
113:
114: private String _name = null;
115: }
|