FqlType.java

/*
** Module   : FqlType.java
** Abstract : Enumeration of data types for various SQL constructs
**
** Copyright (c) 2004-2020, Golden Code Development Corporation.
**
** -#- -I- --Date-- --JPRM-- -----------------------------Description-----------------------------
** 001 ECF 20080310  @37500  Created initial version. Enumeration of data types for various HQL
**                           constructs.
** 002 ECF 20080805  @39311  Added rowid support. Added LONG type.
** 003 SVL 20120331          Added DATETIME and DATETIMETZ types.
** 004 OM  20200402          Renamed class to FqlType and move to persist package.
** 005 IAS 20201123          Added ARRAY type
*/

/*
** This program is free software: you can redistribute it and/or modify
** it under the terms of the GNU Affero General Public License as
** published by the Free Software Foundation, either version 3 of the
** License, or (at your option) any later version.
**
** This program is distributed in the hope that it will be useful,
** but WITHOUT ANY WARRANTY; without even the implied warranty of
** MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
** GNU Affero General Public License for more details.
**
** You may find a copy of the GNU Affero GPL version 3 at the following
** location: https://www.gnu.org/licenses/agpl-3.0.en.html
** 
** Additional terms under GNU Affero GPL version 3 section 7:
** 
**   Under Section 7 of the GNU Affero GPL version 3, the following additional
**   terms apply to the works covered under the License.  These additional terms
**   are non-permissive additional terms allowed under Section 7 of the GNU
**   Affero GPL version 3 and may not be removed by you.
** 
**   0. Attribution Requirement.
** 
**     You must preserve all legal notices or author attributions in the covered
**     work or Appropriate Legal Notices displayed by works containing the covered
**     work.  You may not remove from the covered work any author or developer
**     credit already included within the covered work.
** 
**   1. No License To Use Trademarks.
** 
**     This license does not grant any license or rights to use the trademarks
**     Golden Code, FWD, any Golden Code or FWD logo, or any other trademarks
**     of Golden Code Development Corporation. You are not authorized to use the
**     name Golden Code, FWD, or the names of any author or contributor, for
**     publicity purposes without written authorization.
** 
**   2. No Misrepresentation of Affiliation.
** 
**     You may not represent yourself as Golden Code Development Corporation or FWD.
** 
**     You may not represent yourself for publicity purposes as associated with
**     Golden Code Development Corporation, FWD, or any author or contributor to
**     the covered work, without written authorization.
** 
**   3. No Misrepresentation of Source or Origin.
** 
**     You may not represent the covered work as solely your work.  All modified
**     versions of the covered work must be marked in a reasonable way to make it
**     clear that the modified work is not originating from Golden Code Development
**     Corporation or FWD.  All modified versions must contain the notices of
**     attribution required in this license.
*/

package com.goldencode.p2j.persist;

import java.sql.*;

/**
 * Enumeration of data types for various FQL constructs. This common form is used to rationalize
 * all the various type constructs (token types, Java class types, SQL types) into a common
 * vocabulary.
 */
public enum FqlType
{
   /** Boolean data type */
   BOOLEAN(Types.BIT),
   
   /** 32-bit integer data type */
   INTEGER(Types.INTEGER),
   
   /** 64-bit integer data type */
   LONG(Types.BIGINT),
   
   /** Decimal data type */
   DECIMAL(Types.NUMERIC),
   
   /** Double data type */
   DOUBLE(Types.NUMERIC),
   
   /** Text/string data type */
   TEXT(Types.VARCHAR),
   
   /** Date data type */
   DATE(Types.DATE),
   
   /** Binary (byte array) data type */
   RAW(Types.VARBINARY),
   
   /** Date/time data type */
   DATETIME(Types.TIMESTAMP),
   
   /** Date/time with time zone data type */
   DATETIMETZ(Types.TIMESTAMP_WITH_TIMEZONE),
 
   /** ARRAY type */
   ARRAY(Types.ARRAY),
   
   /** Unknown data type */
   UNKNOWN(-1);
   
/*
      types.put(blob.class     , Types.BLOB);
      types.put(clob.class     , Types.CLOB);
      types.put(comhandle.class, Types.VARCHAR);
      types.put(handle.class   , Types.VARCHAR);
      types.put(object.class   , Types.VARCHAR);
      types.put(recid.class    , Types.INTEGER);
      types.put(rowid.class    , Types.BIGINT);
*/
   
   // TODO: add missing types
   
   /** The associated SQL type. */
   private final int sqlType;
   
   /**
    * Map this enum to its SQL type.
    * 
    * @param    sqlType
    *           The {@link Types SQL type}.
    */
   FqlType(int sqlType)
   {
      this.sqlType = sqlType;
   }
   
   /**
    * Get the SQL Type.
    * 
    * @return   The {@link #sqlType}.
    */
   public int getSqlType()
   {
      return sqlType;
   }
}