Quadcap Embeddable Database

com/quadcap/sql/DatabaseRoot.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.File;
import java.io.IOException;
import java.io.ObjectInput;
import java.io.ObjectOutput;

import java.util.Properties;

import com.quadcap.sql.file.DatafileRoot;

/**
 * The persistent root block of the database.
 *
 * @author Stan Bailes
 */
public class DatabaseRoot implements Externalizable, DatafileRoot {
    int                                 buildNumber             = -1;
    long                                tableIndexNode          = -1;
    long                                indexIndexNode          = -1;
    long                                forwardDepsNode         = -1;
    long                                reverseDepsNode         = -1;
    long                                blobRefCountRoot        = -1;
    long                                nextTransId             = 1;
    String                              dbFileName              = null;
    String                              unused1                 = null;
    String                              unused2                 = null;
    String                              backupDir               = null;

    /** Backups roll; Number of backups to keep. */
    int                                 backupCount             = 1;

    /** bitmap SUN=1 - SAT=7 */
    int                                 backupDays              = 0;

    /** minutes after midnight */
    int                                 backupTime              = 0;

    /** Julian day of previous backup. */
    int                                 backupLastDay           = -1;

    String                              backupFormat            = "xml.gz";

    Database                            db;

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

    /**
     * Explicit constuctor for database creation
     */
    public DatabaseRoot(Database db, String dbFileName, Properties props)
        throws IOException
    {
        this.dbFileName = dbFileName;
        this.unused2 = "";
        this.unused1 = "";
        this.buildNumber = Version.buildNumber;
        tableIndexNode = db.getFile().newPage();
        indexIndexNode = db.getFile().newPage();
        forwardDepsNode = db.getFile().newPage();
        reverseDepsNode = db.getFile().newPage();
        blobRefCountRoot = db.getFile().newPage();
        backupDir = props.getProperty("backup-directory");
    }

    /**
     * Set the database which owns this root
     */
    public void setDatabase(Database db) {
        this.db = db;
    }

    /**
     * Return the build number
     */
    public int getBuildNumber() { return buildNumber; }

    /**
     * Return the root block of the relation index
     */
    public long getRelationIndexNode() { return tableIndexNode; }

    /**
     * Return the root block of the index index
     */    
    public long getIndexIndexNode() { return indexIndexNode; }

    /**
     * Return the root block of the forward dependencies graph
     */    
    public long getForwardDepsNode() { return forwardDepsNode; }

    /**
     * Return the root block of the reverse dependencies graph
     */    
    public long getReverseDepsNode() { return reverseDepsNode; }

    /**
     * Return the root block of the blob ref count index
     */    
    public long getBlobRefCountRoot() { return blobRefCountRoot; }

    /**
     * Return the next transaction id
     */    
    public long getNextTransId() { return nextTransId++; }

    /**
     * Return the backup directory name
     */    
    public String getBackupDir() { return backupDir; }

    /**
     * Return the backup count
     */    
    public int getBackupCount() { return backupCount; }

    /**
     * Return the backup days
     */    
    public int getBackupDays() { return backupDays; }

    /**
     * Return the backup last day
     */    
    public int getBackupLastDay() { return backupLastDay; }

    /**
     * Return the backup time
     */    
    public int getBackupTime() { return backupTime; }

    /**
     * Return the backup format
     */    
    public String getBackupFormat() { return backupFormat; }

    /**
     * Set the backup directory
     */    
    public void setBackupDir(String dir) { backupDir = dir; }

    /**
     * Set the backup count
     */    
    public void setBackupCount(int count) { backupCount = count; }

    /**
     * Set the backup days
     */    
    public void setBackupDays(int days) { backupDays = days; }

    /**
     * Set the backup last day
     */    
    public void setBackupLastDay(int day) { backupLastDay = day; }

    /**
     * Set the backup time
     */    
    public void setBackupTime(int time) { backupTime = time; }

    /**
     * Set the backup format
     */    
    public void setBackupFormat(String fmt) { backupFormat = fmt; }

    /**
     * Set the backup directory
     */    
    public void setNextTransId(long id) { nextTransId = id; }

    /**
     * Read me from a stream
     */
    public void readExternal(ObjectInput in)
        throws IOException, ClassNotFoundException
    {
        buildNumber = in.readInt();
        tableIndexNode = in.readLong();
        indexIndexNode = in.readLong();
        forwardDepsNode = in.readLong();
        reverseDepsNode = in.readLong();
        blobRefCountRoot = in.readLong();
        nextTransId = in.readLong();
        dbFileName = (String)in.readObject();
        unused2 = (String)in.readObject();
        unused1 = (String)in.readObject();
        backupDir = (String)in.readObject();
        backupCount = in.readInt();
        backupDays = in.readInt();
        backupLastDay = in.readInt();
        backupTime = in.readInt();
        backupFormat = (String)in.readObject();
    }

    /**
     * Write me to a stream
     */
    public void writeExternal(ObjectOutput out) throws IOException {
        out.writeInt(buildNumber);
        out.writeLong(tableIndexNode);
        out.writeLong(indexIndexNode);
        out.writeLong(forwardDepsNode);
        out.writeLong(reverseDepsNode);
        out.writeLong(blobRefCountRoot);
        out.writeLong(nextTransId);
        out.writeObject(dbFileName);
        out.writeObject(unused2);
        out.writeObject(unused1);
        out.writeObject(backupDir);
        out.writeInt(backupCount);
        out.writeInt(backupDays);
        out.writeInt(backupLastDay);
        out.writeInt(backupTime);
        out.writeObject(backupFormat);
    }
}