trace.java

一个用java写的开源的数据库系统

/* Copyrights and Licenses
 *
 * This product includes Hypersonic SQL.
 * Originally developed by Thomas Mueller and the Hypersonic SQL Group. 
 *
 * Copyright (c) 1995-2000 by the Hypersonic SQL Group. All rights reserved. 
 * Redistribution and use in source and binary forms, with or without modification, are permitted
 * provided that the following conditions are met: 
 *     -  Redistributions of source code must retain the above copyright notice, this list of conditions
 *         and the following disclaimer. 
 *     -  Redistributions in binary form must reproduce the above copyright notice, this list of
 *         conditions and the following disclaimer in the documentation and/or other materials
 *         provided with the distribution. 
 *     -  All advertising materials mentioning features or use of this software must display the
 *        following acknowledgment: "This product includes Hypersonic SQL." 
 *     -  Products derived from this software may not be called "Hypersonic SQL" nor may
 *        "Hypersonic SQL" appear in their names without prior written permission of the
 *         Hypersonic SQL Group. 
 *     -  Redistributions of any form whatsoever must retain the following acknowledgment: "This
 *          product includes Hypersonic SQL." 
 * This software is provided "as is" and any expressed or implied warranties, including, but
 * not limited to, the implied warranties of merchantability and fitness for a particular purpose are
 * disclaimed. In no event shall the Hypersonic SQL Group or its contributors be liable for any
 * direct, indirect, incidental, special, exemplary, or consequential damages (including, but
 * not limited to, procurement of substitute goods or services; loss of use, data, or profits;
 * or business interruption). However caused any on any theory of liability, whether in contract,
 * strict liability, or tort (including negligence or otherwise) arising in any way out of the use of this
 * software, even if advised of the possibility of such damage. 
 * This software consists of voluntary contributions made by many individuals on behalf of the
 * Hypersonic SQL Group.
 *
 *
 * For work added by the HSQL Development Group:
 *
 * Copyright (c) 2001-2002, The HSQL Development Group
 * All rights reserved.
 *
 * Redistribution and use in source and binary forms, with or without
 * modification, are permitted provided that the following conditions are met:
 *
 * Redistributions of source code must retain the above copyright notice, this
 * list of conditions and the following disclaimer, including earlier
 * license statements (above) and comply with all above license conditions.
 *
 * Redistributions in binary form must reproduce the above copyright notice,
 * this list of conditions and the following disclaimer in the documentation
 * and/or other materials provided with the distribution, including earlier
 * license statements (above) and comply with all above license conditions.
 *
 * Neither the name of the HSQL Development Group nor the names of its
 * contributors may be used to endorse or promote products derived from this
 * software without specific prior written permission.
 *
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
 * AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
 * ARE DISCLAIMED. IN NO EVENT SHALL HSQL DEVELOPMENT GROUP, HSQLDB.ORG, 
 * OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, 
 * EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, 
 * PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
 * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
 * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
 * SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
 */


package org.hsqldb;

import java.sql.DriverManager;
import java.sql.SQLException;
import java.io.File;
import java.io.PrintWriter;

/**
 * handles creation and reporting of error messages and throwing SQLException
 *
 * @version 1.7.0
 */

// fredt@users 20020130 - patch 476694 by velichko@users - savepoints
// additions in different parts to support savepoint transactions
// fredt@users 20020221 - patch 513005 by sqlbob@users (RMP) - error reporting
// fredt@users 20020221 - patch 513005 by sqlbob@users (RMP) - setting trace
// the system property hsqldb.trace == true is now used for setting tracing on
// the system property hsqldb.tracesystemout == true is now used for printing
// trace message to System.out
// fredt@users 20020305 - patch 1.7.0 - various new messages added
// tony_lai@users 20020820 - patch 595073 by tlai@users Duplicated exception msg
public class Trace extends PrintWriter {

    public static boolean       TRACE          = false;
    public static boolean       TRACESYSTEMOUT = false;
    public static final boolean STOP           = false;
    public static final boolean DOASSERT       = false;
    private static Trace        tTracer        = new Trace();
    private static String       sTrace;
    private static int          iStop                          = 0;
    public static final int     DATABASE_ALREADY_IN_USE        = 1,
                                CONNECTION_IS_CLOSED           = 2,
                                CONNECTION_IS_BROKEN           = 3,
                                DATABASE_IS_SHUTDOWN           = 4,
                                COLUMN_COUNT_DOES_NOT_MATCH    = 5,
                                DIVISION_BY_ZERO               = 6,
                                INVALID_ESCAPE                 = 7,
                                INTEGRITY_CONSTRAINT_VIOLATION = 8,
                                VIOLATION_OF_UNIQUE_INDEX      = 9,
                                TRY_TO_INSERT_NULL             = 10,
                                UNEXPECTED_TOKEN               = 11,
                                UNEXPECTED_END_OF_COMMAND      = 12,
                                UNKNOWN_FUNCTION               = 13,
                                NEED_AGGREGATE                 = 14,
                                SUM_OF_NON_NUMERIC             = 15,
                                WRONG_DATA_TYPE                = 16,
                                SINGLE_VALUE_EXPECTED          = 17,
                                SERIALIZATION_FAILURE          = 18,
                                TRANSFER_CORRUPTED             = 19,
                                FUNCTION_NOT_SUPPORTED         = 20,
                                TABLE_ALREADY_EXISTS           = 21,
                                TABLE_NOT_FOUND                = 22,
                                INDEX_ALREADY_EXISTS           = 23,
                                SECOND_PRIMARY_KEY             = 24,
                                DROP_PRIMARY_KEY               = 25,
                                INDEX_NOT_FOUND                = 26,
                                COLUMN_ALREADY_EXISTS          = 27,
                                COLUMN_NOT_FOUND               = 28,
                                FILE_IO_ERROR                  = 29,
                                WRONG_DATABASE_FILE_VERSION    = 30,
                                DATABASE_IS_READONLY           = 31,
                                DATA_IS_READONLY               = 32,
                                ACCESS_IS_DENIED               = 33,
                                INPUTSTREAM_ERROR              = 34,
                                NO_DATA_IS_AVAILABLE           = 35,
                                USER_ALREADY_EXISTS            = 36,
                                USER_NOT_FOUND                 = 37,
                                ASSERT_FAILED                  = 38,
                                EXTERNAL_STOP                  = 39,
                                GENERAL_ERROR                  = 40,
                                WRONG_OUT_PARAMETER            = 41,
                                ERROR_IN_FUNCTION              = 42,
                                TRIGGER_NOT_FOUND              = 43,
                                SAVEPOINT_NOT_FOUND            = 44,
                                LABEL_REQUIRED                 = 45,
                                WRONG_DEFAULT_CLAUSE           = 46,
                                FOREIGN_KEY_NOT_ALLOWED        = 47,
                                UNKNOWN_DATA_SOURCE            = 48,
                                BAD_INDEX_CONSTRAINT_NAME      = 49,
                                DROP_FK_INDEX                  = 50,
                                RESULTSET_FORWARD_ONLY         = 51,
                                VIEW_ALREADY_EXISTS            = 52,
                                VIEW_NOT_FOUND                 = 53,
                                NOT_A_VIEW                     = 54,
                                NOT_A_TABLE                    = 55,
                                SYSTEM_INDEX                   = 56,
                                COLUMN_TYPE_MISMATCH           = 57,
                                BAD_ADD_COLUMN_DEFINITION      = 58,
                                DROP_SYSTEM_CONSTRAINT         = 59,
                                CONSTRAINT_ALREADY_EXISTS      = 60,
                                CONSTRAINT_NOT_FOUND           = 61,
                                INVALID_JDBC_ARGUMENT          = 62,
                                DATABASE_IS_MEMORY_ONLY        = 63,
                                OUTER_JOIN_CONDITION           = 64,
                                NUMERIC_VALUE_OUT_OF_RANGE     = 65;
    private static String[]     sDescription                   = {
        "NOT USED", "08001 The database is already in use by another process",
        "08003 Connection is closed", "08003 Connection is broken",
        "08003 The database is shutdown", "21000 Column count does not match",
        "22012 Division by zero", "22019 Invalid escape character",
        "23000 Integrity constraint violation",
        "23000 Violation of unique index",
        "23000 Try to insert null into a non-nullable column",
        "37000 Unexpected token", "37000 Unexpected end of command",
        "37000 Unknown function", "37000 Need aggregate function or group by",
        "37000 Sum on non-numeric data not allowed", "37000 Wrong data type",
        "37000 Single value expected", "40001 Serialization failure",
        "40001 Transfer corrupted", "IM001 This function is not supported",
        "S0001 Table already exists", "S0002 Table not found",
        "S0011 Index already exists",
        "S0011 Attempt to define a second primary key",
        "S0011 Attempt to drop the primary key", "S0012 Index not found",
        "S0021 Column already exists", "S0022 Column not found",
        "S1000 File input/output error", "S1000 Wrong database file version",
        "S1000 The database is in read only mode",
        "S1000 The table data is read only", "S1000 Access is denied",
        "S1000 InputStream error", "S1000 No data is available",
        "S1000 User already exists", "S1000 User not found",
        "S1000 Assert failed", "S1000 External stop request",
        "S1000 General error", "S1009 Wrong OUT parameter",
        "S1010 Error in function", "S0002 Trigger not found",
        "S1011 Savepoint not found", "37000 Label required for value list",
        "37000 Wrong data type or data too long in DEFAULT clause",
        "S0011 Foreign key not allowed",
        "S1000 The table's data source for this connection is not known",
        "S0000 User-defined index or constraint name cannot begin with SYS_",
        "S0011 Attempt to drop a foreign key index",
        "S1000 ResultSet was set to forward only",
        "S0003 View already exists", "S0004 View not found",
        "S0005 Not A View", "S0005 Not A Table",
        "S0011 Attempt to drop or rename a system index",
        "S0021 Column types do not match",
        "s0021 Column constraints are not acceptable",
        "S0011 Attempt to drop a system constraint",
        "S0011 Constraint already exists", "S0011 Constraint not found",
        "SOO10 Invalid argument in JDBC call",
        "S1000 Database is memory only",
        "37000 only one join condition on table columns allowed",
        "22003 Numeric value out of range"
    };

    static {
        try {
            TRACE          = Boolean.getBoolean("hsqldb.trace");
            TRACESYSTEMOUT = Boolean.getBoolean("hsqldb.tracesystemout");
        } catch (Exception e) {}
    }

    /**
     * Method declaration
     *
     *
     * @param code
     * @param add
     *
     * @return
     */
    static SQLException getError(int code, Object add) {

// fredt@users 20020221 - patch 513005 by sqlbob@users (RMP)
        code = Math.abs(code);

        String s = getMessage(code);

        if (add != null) {
            s += ": " + add.toString();
        }

// fredt@users 20020221 - patch 513005 by sqlbob@users (RMP)
        return new SQLException(s.substring(6), s.substring(0, 5), -code);

        //return getError(s);
    }

    /**
     * Creates a SQLException useing given message and code.  The status is
     * filled based on the code.
     * <p>
     * Note use the given msg as error message, not as "add" argument.
     *
     *
     * @param msg
     * @param code
     *
     * @return a SQLException created from the given message and code.
     */

// tony_lai@users 20020820 - patch 595073
    static SQLException getError(String msg, int code) {

        code = Math.abs(code);

        String s = getMessage(code);

        return new SQLException(msg, s.substring(0, 5), -code);
    }

    /**
     * Method declaration
     *
     *
     * @param code
     *
     * @return
     */
    static String getMessage(int code) {
        return sDescription[code];
    }

    /**
     * Method declaration
     *
     *
     * @param e
     *
     * @return
     */
    static String getMessage(SQLException e) {
        return e.getSQLState() + " " + e.getMessage();
    }

    /**
     * Method declaration
     *
     *
     * @param msg
     *
     * @return
     */
    static SQLException getError(String msg) {
        return new SQLException(msg.substring(6), msg.substring(0, 5),
                                -GENERAL_ERROR);