com.healthmarketscience.jackcess

Interface TableDefinition

All Known Subinterfaces:

Table

All Known Implementing Classes:

TableDefinitionImpl, TableImpl

public interface TableDefinition

The definition of a single database table. A TableDefinition instance is retrieved from a TableMetaData instance. The TableDefinition instance only provides access to the table metadata, but no table data.

A TableDefinition instance is not thread-safe (see Database for more thread-safety details).

Author:

James Ahlborn

Usage:

Intermediate: This class requires moderate API knowledge.

Method Summary

Modifier and Type	Method and Description
Column	getColumn(String name)
int	getColumnCount()
List<? extends Column>	getColumns()
LocalDateTime	getCreatedDate()
Database	getDatabase()
Index	getForeignKeyIndex(Table otherTable)
Index	getIndex(String name)
List<? extends Index>	getIndexes()
String	getName()
Index	getPrimaryKeyIndex()
PropertyMap	getProperties()
LocalDateTime	getUpdatedDate() Note: jackcess does not automatically update the modified date of a Table.
boolean	isHidden() Whether or not this table has been marked as hidden.
boolean	isSystem() Whether or not this table is a system (internal) table.

Method Detail

getName

String getName()

Returns:

The name of the table

Usage:

General: This method is general use.

isHidden

boolean isHidden()

Whether or not this table has been marked as hidden.

Usage:

General: This method is general use.

isSystem

boolean isSystem()

Whether or not this table is a system (internal) table.

Usage:

General: This method is general use.

getColumnCount

int getColumnCount()

Usage:

General: This method is general use.

getDatabase

Database getDatabase()

Usage:

General: This method is general use.

getColumns

List<? extends Column> getColumns()

Returns:

All of the columns in this table (unmodifiable List)

Usage:

General: This method is general use.

getColumn

Column getColumn(String name)

Returns:

the column with the given name

Usage:

General: This method is general use.

getProperties

PropertyMap getProperties()
                   throws IOException

Returns:

the properties for this table

Throws:

IOException

Usage:

General: This method is general use.

getCreatedDate

LocalDateTime getCreatedDate()
                      throws IOException

Returns:

the created date for this table if available

Throws:

IOException

Usage:

General: This method is general use.

getUpdatedDate

LocalDateTime getUpdatedDate()
                      throws IOException

Note: jackcess does not automatically update the modified date of a Table.

Returns:

the last updated date for this table if available

Throws:

IOException

Usage:

General: This method is general use.

getIndexes

List<? extends Index> getIndexes()

Returns:

All of the Indexes on this table (unmodifiable List)

Usage:

Intermediate: This method requires moderate API knowledge.

getIndex

Index getIndex(String name)

Returns:

the index with the given name

Throws:

IllegalArgumentException - if there is no index with the given name

Usage:

Intermediate: This method requires moderate API knowledge.

getPrimaryKeyIndex

Index getPrimaryKeyIndex()

Returns:

the primary key index for this table

Throws:

IllegalArgumentException - if there is no primary key index on this table

Usage:

Intermediate: This method requires moderate API knowledge.

getForeignKeyIndex

Index getForeignKeyIndex(Table otherTable)

Returns:

the foreign key index joining this table to the given other table

Throws:

IllegalArgumentException - if there is no relationship between this table and the given table

Usage:

Intermediate: This method requires moderate API knowledge.