Class Reflection

java.lang.Object
org.apache.sis.internal.metadata.sql.Reflection

public final class Reflection extends Object
Column names used in database reflection API. Reflection provides information about schemas, tables, columns, constraints, etc. in the form of database tables. The main JDBC methods for those reflections are: This class enumerates all the constants used by Apache SIS, and only those constants (this give a way to have an overview of which database metadata are needed by SIS). Unless specified otherwise, the columns with those names contain only String values. The main exceptions are DATA_TYPE, COLUMN_SIZE and DELETE_RULE, which contain integers.
Since:
1.0
Version:
1.0
  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final String
    Number of rows in the table, or number of unique values in the index.
    static final String
    The "COLUMN_NAME" key for getting a column name.
    static final String
    The "COLUMN_SIZE" key for the size for of a column.
    static final String
    The "DATA_TYPE" key for getting the data type as one of Types constants.
    static final String
    The "DELETE_RULE" key for what happens to the foreign key when primary is deleted.
    static final String
    The "FK_NAME" key for foreign key name.
    static final String
    The "FKCOLUMN_NAME" key for the foreign key column name.
    static final String
    The "FKTABLE_CAT" key for the foreigner key table catalog.
    static final String
    The "FKTABLE_NAME" key for the foreign key table name.
    static final String
    The "FKTABLE_SCHEM" key for the foreign key table schema.
    static final String
    The "INDEX_NAME" key for the name of the index.
    static final String
    The "IS_AUTOINCREMENT" key for indicating whether this column is auto incremented.
    static final String
    The "IS_NULLABLE" key for the nullability of a column.
    static final String
    The "PK_NAME" key for primary key name.
    static final String
    The "PKCOLUMN_NAME" key for the primary key column name being imported.
    static final String
    The "PKTABLE_CAT" key for the primary key table catalog being imported.
    static final String
    The "PKTABLE_NAME" key for the primary key table name being imported.
    static final String
    The "PKTABLE_SCHEM" key for the primary key table schema being imported.
    static final String
    The "REMARKS" key for comment describing columns.
    static final String
    The "TABLE_CAT" key for getting a catalog name.
    static final String
    The "TABLE_NAME" key for getting a table name.
    static final String
    The "TABLE_SCHEM" key for getting a schema name.
    static final String
    The "TABLE_TYPE" key for getting a table type.
    static final String
    Index type: statistics, clustered, hashed or other.
    static final String
    Data source dependent type name.
    static final String
    Whether an integer type is unsigned.
  • Constructor Summary

    Constructors
    Modifier
    Constructor
    Description
    private
    Do not allow instantiation of this class.
  • Method Summary

    Methods inherited from class java.lang.Object

    clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
  • Field Details

    • TABLE_CAT

      public static final String TABLE_CAT
      The "TABLE_CAT" key for getting a catalog name. This column appears in all reflection operations (listing schemas, tables, columns, constraints, etc.) used by SIS. The value in that column may be null.
      See Also:
    • TABLE_SCHEM

      public static final String TABLE_SCHEM
      The "TABLE_SCHEM" key for getting a schema name. This column appears in all reflection operations (listing schemas, tables, columns, constraints, etc.) used by SIS. The value in that column may be null.
      See Also:
    • TABLE_NAME

      public static final String TABLE_NAME
      The "TABLE_NAME" key for getting a table name. This column appears in most reflection operations (listing tables, columns, constraints, etc.) used by SIS.
      See Also:
    • TABLE_TYPE

      public static final String TABLE_TYPE
      The "TABLE_TYPE" key for getting a table type. The values that may appear in this column are listed by DatabaseMetaData.getTableTypes(). Typical values are "TABLE", "VIEW", "SYSTEM TABLE", "GLOBAL TEMPORARY", "LOCAL TEMPORARY", "ALIAS", "SYNONYM".
      See Also:
    • COLUMN_NAME

      public static final String COLUMN_NAME
      The "COLUMN_NAME" key for getting a column name.
      See Also:
    • DATA_TYPE

      public static final String DATA_TYPE
      The "DATA_TYPE" key for getting the data type as one of Types constants.

      Values in this column are integers (int) rather than String.

      See Also:
    • TYPE_NAME

      public static final String TYPE_NAME
      Data source dependent type name. For a UDT the type name is fully qualified.
      See Also:
    • COLUMN_SIZE

      public static final String COLUMN_SIZE
      The "COLUMN_SIZE" key for the size for of a column. For numeric data, this is the maximum precision. For character data, this is the length in characters.

      Values in this column are integers (int) rather than String.

      See Also:
    • UNSIGNED_ATTRIBUTE

      public static final String UNSIGNED_ATTRIBUTE
      Whether an integer type is unsigned. Values in this column are integers (boolean) rather than String.
      See Also:
    • IS_NULLABLE

      public static final String IS_NULLABLE
      The "IS_NULLABLE" key for the nullability of a column. Possible values are "YES" if the parameter can include NULLs, "NO" if the parameter cannot include NULLs, and empty string if the nullability for the parameter is unknown.
      See Also:
    • IS_AUTOINCREMENT

      public static final String IS_AUTOINCREMENT
      The "IS_AUTOINCREMENT" key for indicating whether this column is auto incremented. Possible values are "YES" if the column is auto incremented, "NO" if the column is not auto incremented, or empty string if whether the column is auto incremented is unknown.
      See Also:
    • REMARKS

      public static final String REMARKS
      The "REMARKS" key for comment describing columns. Values in this column may be null.
      See Also:
    • PK_NAME

      public static final String PK_NAME
      The "PK_NAME" key for primary key name. Values in this column may be null.
      See Also:
    • PKTABLE_CAT

      public static final String PKTABLE_CAT
      The "PKTABLE_CAT" key for the primary key table catalog being imported. Values in this column may be null.
      See Also:
    • PKTABLE_SCHEM

      public static final String PKTABLE_SCHEM
      The "PKTABLE_SCHEM" key for the primary key table schema being imported. Values in this column may be null.
      See Also:
    • PKTABLE_NAME

      public static final String PKTABLE_NAME
      The "PKTABLE_NAME" key for the primary key table name being imported.
      See Also:
    • PKCOLUMN_NAME

      public static final String PKCOLUMN_NAME
      The "PKCOLUMN_NAME" key for the primary key column name being imported.
      See Also:
    • FK_NAME

      public static final String FK_NAME
      The "FK_NAME" key for foreign key name. Values in this column may be null.
      See Also:
    • FKTABLE_CAT

      public static final String FKTABLE_CAT
      The "FKTABLE_CAT" key for the foreigner key table catalog. Values in this column may be null.
      See Also:
    • FKTABLE_SCHEM

      public static final String FKTABLE_SCHEM
      The "FKTABLE_SCHEM" key for the foreign key table schema. Values in this column may be null.
      See Also:
    • FKTABLE_NAME

      public static final String FKTABLE_NAME
      The "FKTABLE_NAME" key for the foreign key table name.
      See Also:
    • FKCOLUMN_NAME

      public static final String FKCOLUMN_NAME
      The "FKCOLUMN_NAME" key for the foreign key column name.
      See Also:
    • DELETE_RULE

      public static final String DELETE_RULE
      The "DELETE_RULE" key for what happens to the foreign key when primary is deleted. Possible values are:
      • importedKeyNoAction — do not allow delete of primary key if it has been imported.
      • importedKeyCascade — delete rows that import a deleted key.
      • importedKeySetNull — change imported key to NULL if its primary key has been deleted.
      • importedKeySetDefault — change imported key to default if its primary key has been deleted.

      Values in this column are short integers (short) rather than String.

      See Also:
    • INDEX_NAME

      public static final String INDEX_NAME
      The "INDEX_NAME" key for the name of the index. Values in this column may be null.
      See Also:
    • TYPE

      public static final String TYPE
      Index type: statistics, clustered, hashed or other.

      Values in this column are short integers (short) rather than String.

      See Also:
    • CARDINALITY

      public static final String CARDINALITY
      Number of rows in the table, or number of unique values in the index.

      Values in this column are long integers (long) rather than String.

      See Also:
  • Constructor Details

    • Reflection

      private Reflection()
      Do not allow instantiation of this class.