Module org.tentackle.sql

Package org.tentackle.sql.metadata

Class DatabaseMetaDataTableHeader

java.lang.Object

org.tentackle.sql.metadata.DatabaseMetaDataTableHeader

public class DatabaseMetaDataTableHeader
extends Object

Describes the table name and some major properties for an existing database table.

Constructor Summary

Constructors

Constructor	Description
DatabaseMetaDataTableHeader(DatabaseMetaData metaData, String catalog, String schema, String name, String type, String comment)	Creates a table header.

Method Summary

Modifier and Type	Method	Description
String	getCatalog()	The optional catalog.
String	getComment()	The optional comment.
DatabaseMetaData	getMetaData()	Gets the metadata root object this table header was retrieved from.
String	getName()
String	getSchema()	The optional schema.
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.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

DatabaseMetaDataTableHeader

public DatabaseMetaDataTableHeader(DatabaseMetaData metaData,
 String catalog,
 String schema,
 String name,
 String type,
 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 Details

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 DatabaseMetaData getMetaData()

Gets the metadata root object this table header was retrieved from.

Returns:

the metadata, never null

getCatalog

public String getCatalog()

The optional catalog.

Returns:

the catalog, may be null

getSchema

public String getSchema()

The optional schema.

Returns:

the schema, may be null

getName

public String getName()

getType

public String getType()

The table's name.

Returns:

the tablename, never null

getComment

public String getComment()

The optional comment.

Returns:

the comment, may be null

toString

public String toString()

Overrides:

toString in class Object