com.healthmarketscience.jackcess

Interface TableMetaData

public interface TableMetaData

Basic metadata about a single database Table. This is the top-level information stored in a (local) database which can be retrieved without attempting to load the Table itself.

Author:

James Ahlborn

Usage:

Intermediate: This class requires moderate API knowledge.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	TableMetaData.Type

Method Summary

Modifier and Type	Method and Description
String	getConnectionName() The connection of this the linked database if this is a linked ODBC table, null otherwise.
String	getLinkedDbName() The name of this the linked database if this is a linked table, null otherwise.
String	getLinkedTableName() The name of this linked table in the linked database if this is a linked table, null otherwise.
String	getName() The name of the table (as it is stored in the database)
TableDefinition	getTableDefinition(Database db) Gets the local table definition from the given Database instance if available.
TableMetaData.Type	getType() The type of table
boolean	isLinked() true if this is a linked table, false otherwise.
boolean	isSystem() true if this is a system table, false otherwise.
Table	open(Database db) Opens this table from the given Database instance.

Method Detail

getType

TableMetaData.Type getType()

The type of table

getName

String getName()

The name of the table (as it is stored in the database)

isLinked

boolean isLinked()

true if this is a linked table, false otherwise.

isSystem

boolean isSystem()

true if this is a system table, false otherwise.

getLinkedTableName

String getLinkedTableName()

The name of this linked table in the linked database if this is a linked table, null otherwise.

getLinkedDbName

String getLinkedDbName()

The name of this the linked database if this is a linked table, null otherwise.

getConnectionName

String getConnectionName()

The connection of this the linked database if this is a linked ODBC table, null otherwise.

open

Table open(Database db)
    throws IOException

Opens this table from the given Database instance.

Throws:

IOException

getTableDefinition

TableDefinition getTableDefinition(Database db)
                            throws IOException

Gets the local table definition from the given Database instance if available. Only useful for linked ODBC tables.

Throws:

IOException