Quadcap Embeddable Database

com/quadcap/sql/meta/MetaIndexInfo.java

Go to the documentation of this file.

package com.quadcap.sql.meta;

/* Copyright 1999 - 2003 Quadcap Software.  All rights reserved.
 *
 * This software is distributed under the Quadcap Free Software License.
 * This software may be used or modified for any purpose, personal or
 * commercial.  Open Source redistributions are permitted.  Commercial
 * redistribution of larger works derived from, or works which bundle
 * this software requires a "Commercial Redistribution License"; see
 * http://www.quadcap.com/purchase.
 *
 * Redistributions qualify as "Open Source" under  one of the following terms:
 *   
 *    Redistributions are made at no charge beyond the reasonable cost of
 *    materials and delivery.
 *
 *    Redistributions are accompanied by a copy of the Source Code or by an
 *    irrevocable offer to provide a copy of the Source Code for up to three
 *    years at the cost of materials and delivery.  Such redistributions
 *    must allow further use, modification, and redistribution of the Source
 *    Code under substantially the same terms as this license.
 *
 * Redistributions of source code must retain the copyright notices as they
 * appear in each source code file, these license terms, and the
 * disclaimer/limitation of liability set forth as paragraph 6 below.
 *
 * Redistributions in binary form must reproduce this Copyright Notice,
 * these license terms, and the disclaimer/limitation of liability set
 * forth as paragraph 6 below, in the documentation and/or other materials
 * provided with the distribution.
 *
 * The Software is provided on an "AS IS" basis.  No warranty is
 * provided that the Software is free of defects, or fit for a
 * particular purpose.  
 *
 * Limitation of Liability. Quadcap Software shall not be liable
 * for any damages suffered by the Licensee or any third party resulting
 * from use of the Software.
 */

import java.io.IOException;

import java.util.Iterator;

import java.sql.DatabaseMetaData;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;

import com.quadcap.sql.Column;
import com.quadcap.sql.Constraint;
import com.quadcap.sql.Database;
import com.quadcap.sql.Expression;
import com.quadcap.sql.IndexConstraint;
import com.quadcap.sql.Relation;
import com.quadcap.sql.Row;
import com.quadcap.sql.Session;
import com.quadcap.sql.StaticCursor;
import com.quadcap.sql.Table;

import com.quadcap.sql.index.BCursor;
import com.quadcap.sql.index.Btree;

import com.quadcap.sql.types.*;

import com.quadcap.util.Debug;

/**
 * A Cursor supporting the <code>getIndexInfo</code> function.
 *
 * @author Stan Bailes
 */
public class MetaIndexInfo extends MetaCursor {
    static Column[] cols = {
        new Column("TABLE_CAT", typeString),            // 1
        new Column("TABLE_SCHEM", typeString),          // 2 
        new Column("TABLE_NAME", typeString),           // 3
        new Column("NON_UNIQUE", typeBinary),           // 4
        new Column("INDEX_QUALIFIER", typeString),      // 5
        new Column("INDEX_NAME", typeString),           // 6
        new Column("TYPE", typeShort),                  // 7
        new Column("ORDINAL_POSITION", typeInt),        // 8
        new Column("COLUMN_NAME", typeString),          // 9
        new Column("ASC_OR_DESC", typeString),          // 10
        new Column("CARDINALITY", typeInt),             // 11
        new Column("PAGES", typeInt),                   // 12
        new Column("FILTER_CONDITION", typeString)      // 13
    };

    static int[] sortColumns = { 4, 7, 6, 8 };

    public MetaIndexInfo(Session session, Expression predicate)
        throws SQLException
    {
        super(session, predicate);
        try {
            addColumns(cols);
            Database db = session.getDatabase();
            session.getTableWriteLock("#Schema");
            synchronized (db.getFile().getLock()) {
                Iterator iter = db.getRelationNameIterator();
                while (iter.hasNext()) {
                    String name = (String)iter.next();
                    Relation r = db.getRelation(name);
                    if (r instanceof Table) {
                        Table t = (Table)r;
                        int num = t.getNumConstraints();
                        for (int i = 0; i < num; i++) {
                            Constraint c = t.getConstraint(i);
                            if (c instanceof IndexConstraint) {
                                doConstraint(t, (IndexConstraint)c);
                            }
                        }
                    }
                }
            }
            sort();
        } catch (ValueException e) {
            Debug.print(e);
            SQLException te = new SQLException(e.toString(), "Q000N");
            te.setNextException(e);
            throw te;
        } catch (IOException e) {
            Debug.print(e);
            throw new SQLException(e.toString(), "Q000O");
        }           
    }

    public int[] getSortColumns() {
        return sortColumns;
    }

    void doConstraint(Table t, IndexConstraint c) throws SQLException {
        int[] colIndices = c.getColumns();
        for (int i = 0; i < colIndices.length; i++) {
            Column col = t.getColumn(colIndices[i]);
            Row row = doColumn(t, c, i, col);
            if (rowMatch(row)) {
                addRow(row);
            }
        }
    }

    Row doColumn(Table t, IndexConstraint c, int pos, Column col)
        throws SQLException
    {
        Type type = col.getType();
        Row row = new Row(18);
        row.set(1, ValueNull.valueNull);
        doTableName(2, row, t.getName());
        row.set(4, (c.isUnique() ? 
                    ValueBoolean.falseBoolean : 
                    ValueBoolean.trueBoolean));
        if (c.isGlobal()) {
            row.set(5, new ValueString("global"));
        } else {
            row.set(5, ValueNull.valueNull);
        }
        String iname = c.getName();
        if (iname == null) iname = "";
        row.set(6, new ValueString(iname));
        row.set(7, new ValueShort(DatabaseMetaData.tableIndexOther));
        row.set(8, new ValueShort(pos+1));
        row.set(9, new ValueString(col.getShortName()));
        row.set(10, new ValueString("A"));
        row.set(11, ValueNull.valueNull);
        row.set(12, ValueNull.valueNull);
        row.set(13, ValueNull.valueNull);
        return row;
    }

}