Quadcap Embeddable Database

com/quadcap/sql/AddIndexEntry.java

Go to the documentation of this file.

package com.quadcap.sql;

/* 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.Externalizable;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

import java.sql.SQLException;

import com.quadcap.sql.file.ByteUtil;
import com.quadcap.sql.file.SubPageManager;

import com.quadcap.sql.io.Extern;

import com.quadcap.sql.index.Btree;

import com.quadcap.util.Util;

/**
 * Log step to add a entry to an index.
 *
 * @author Stan Bailes
 */
public class AddIndexEntry extends ModIndexEntry implements Externalizable {
    long                        rowId;

    /**
     * Default constructor
     */
    public AddIndexEntry() {}

    /**
     * Explicit constructor from key and rowId
     */
    public AddIndexEntry(Session session, Constraint constraint,
                         byte[] key, long rowId) {
        super(session, constraint, key);
        this.rowId = rowId;
    }

    /**
     * LogStep.redo(): Store the new entry in the index
     */
    public void redo(Session session) throws IOException, SQLException {
        if (index == null) {
            getIndex(session);
        }
        if (session.getConnection().inRecovery()) {
            rowId = session.getLog().getRowMap(rowId);
        }
        index.set(key, key.length, session.getBuf8(rowId), 0, 8);
    }

    /**
     * LogStep.undo(): Remove the entry from the index
     */
    public void undo(Session session) throws IOException {
        if (index == null) {
            getIndex(session);
        }
        index.delete(key);
    }

    /**
     * Externalizable: Read me from a stream
     */
    public void readExternal(ObjectInput in)
        throws IOException, ClassNotFoundException
    {
        super.readExternal(in);
        rowId = in.readLong();
    }
    
    /**
     * Externalizable: Write me to a stream
     */
    public void writeExternal(ObjectOutput out) throws IOException {
        super.writeExternal(out);
        out.writeLong(rowId);
    }

    /**
     * My class's Extern object
     */
    static Extern extern;
    public void setExtern(Extern extern) { AddIndexEntry.extern = extern; }
    public Extern getExtern() { return extern; }

    //#ifdef DEBUG
    /**
     * For debugging, return a string representation
     */
    public String toString() {
        return "Add: " + super.toString() + ", rowId = " +
            SubPageManager.toString(rowId);
    }
    //#endif

}