Module org.tentackle.sql
Package org.tentackle.sql.metadata

Class DatabaseMetaDataTableHeader

  • public class DatabaseMetaDataTableHeader
extends java.lang.Object
    Describes the table name and some major properties for am existing database table.

    • Constructor Summary

      Constructors 
      Constructor Description
      DatabaseMetaDataTableHeader​(java.sql.DatabaseMetaData metaData, java.lang.String catalog, java.lang.String schema, java.lang.String name, java.lang.String type, java.lang.String comment)
      Creates a table header.

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getCatalog()
      The optional catalog.
      java.lang.String getComment()
      The optional comment.
      java.sql.DatabaseMetaData getMetaData()
      Gets the metadata root object this table header was retrieved from.
      java.lang.String getName()  
      java.lang.String getSchema()
      The optional schema.
      java.lang.String getType()
      The table's name.
      boolean isReserved()
      Returns whether this is a reserved table.
      boolean isUserTable()
      Returns whether this is a user-defined table.
      java.lang.String toString()  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

    • Constructor Detail

      • DatabaseMetaDataTableHeader

        public DatabaseMetaDataTableHeader​(java.sql.DatabaseMetaData metaData,
                                   java.lang.String catalog,
                                   java.lang.String schema,
                                   java.lang.String name,
                                   java.lang.String type,
                                   java.lang.String comment)
        Creates a table header.
        Parameters:
        metaData - the database metadata root object
        catalog - the catalog name
        schema - the schema name
        name - the table name
        type - the table type
        comment - the table remarks

    • Method Detail

      • isUserTable

        public boolean isUserTable()
        Returns whether this is a user-defined table.
        Returns:
        true if standard table

      • isReserved

        public boolean isReserved()
        Returns whether this is a reserved table.
        Returns:
        true if reserved table

      • getMetaData

        public java.sql.DatabaseMetaData getMetaData()
        Gets the metadata root object this table header was retrieved from.
        Returns:
        the metadata, never null

      • getCatalog

        public java.lang.String getCatalog()
        The optional catalog.
        Returns:
        the catalog, may be null

      • getSchema

        public java.lang.String getSchema()
        The optional schema.
        Returns:
        the schema, may be null

      • getName

        public java.lang.String getName()

      • getType

        public java.lang.String getType()
        The table's name.
        Returns:
        the tablename, never null

      • getComment

        public java.lang.String getComment()
        The optional comment.
        Returns:
        the comment, may be null

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class java.lang.Object