APIdia Launch Partner

Top Description Inners Methods

io.github.spannm.jackcess

public Interface TableMetaData

Known Direct Implementers: io.github.spannm.jackcess.impl.DatabaseImpl.TableInfo
Imports: java.io.IOException

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.

Nested and Inner Type Summary

Modifier and Type	Class and Description
public static enum	TableMetaData.Type

Method Summary

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

Method Detail

getConnectionName	back to summary
public String getConnectionName() The connection of this the linked database if this is a linked ODBC table, `null` otherwise.

getLinkedDbName	back to summary
public String getLinkedDbName() The name of this the linked database if this is a linked table, `null` otherwise.

getLinkedTableName	back to summary
public String getLinkedTableName() The name of this linked table in the linked database if this is a linked table, `null` otherwise.

getName	back to summary
public String getName() The name of the table (as it is stored in the database)

getTableDefinition	back to summary
public TableDefinition getTableDefinition(Database db) throws IOException Gets the local table definition from the given Database instance if available. Only useful for linked ODBC tables.

getType	back to summary
public TableMetaData.Type getType() The type of table

isLinked	back to summary
public boolean isLinked() `true` if this is a linked table, `false` otherwise.

isSystem	back to summary
public boolean isSystem() `true` if this is a system table, `false` otherwise.

open	back to summary
public Table open(Database db) throws IOException Opens this table from the given Database instance.

io.github.spannm.jackcess back to summary

public final Enum TableMetaData.Type

Class Inheritance

extends Enum<TableMetaData.Type>

java.lang.Object
java.lang.Enum
io.github.spannm.jackcess.TableMetaData.Type

Field Summary

Modifier and Type	Field and Description
public static final TableMetaData.Type	LINKED
public static final TableMetaData.Type	LINKED_ODBC
public static final TableMetaData.Type	LOCAL

Constructor Summary

Access	Constructor and Description
private	Type()

Method Summary

Modifier and Type	Method and Description
public static TableMetaData.Type	valueOf(String name)
public static TableMetaData.Type[]	values()

Inherited from java.lang.Enum:: clone compareTo describeConstable equals finalize getDeclaringClass hashCode name ordinal toString valueOf

Field Detail

LINKED	back to summary
public static final TableMetaData.Type LINKED

LINKED_ODBC	back to summary
public static final TableMetaData.Type LINKED_ODBC

LOCAL	back to summary
public static final TableMetaData.Type LOCAL

Constructor Detail

Type	back to summary
private Type()

Method Detail

valueOf	back to summary
public static TableMetaData.Type valueOf(String name)

values	back to summary
public static TableMetaData.Type[] values()