APIdia Launch Partner
Top Description Methods
io.github.spannm.jackcess

public Interface TableDefinition

Known Direct Subinterfaces
io.github.spannm.jackcess.Table
Imports
java.io.IOException, java.time.LocalDateTime, java.util.List
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).

Method Summary

Modifier and TypeMethod and Description
public Column

Returns:

the column with the given name
getColumn(String name)

Returns the column with the given name.

public int

Returns:

the number of columns in this table
getColumnCount()

Returns the number of columns in this table.

public List<? extends Column>

Returns:

All of the columns in this table (unmodifiable List)
getColumns()

Returns all of the columns in this table (unmodifiable List).

public LocalDateTime

Returns:

the created date for this table if available
getCreatedDate()

Returns the created date for this table if available.

public Database

Returns:

the database to which this table belongs
getDatabase()

Returns the database to which this table belongs.

public Index

Returns:

the foreign key index joining this table to the given other table
getForeignKeyIndex(Table otherTable)

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

public Index

Returns:

the index with the given name
getIndex(String name)

Returns the index with the given name.

public List<? extends Index>

Returns:

All of the Indexes on this table (unmodifiable List)
getIndexes()

Returns all of the Indexes on this table (unmodifiable List).

public String

Returns:

The name of the table
getName()

Returns the name of the table.

public Index

Returns:

the primary key index for this table
getPrimaryKeyIndex()

Returns the primary key index for this table.

public PropertyMap

Returns:

the properties for this table
getProperties()

Returns the properties for this table.

public LocalDateTime

Returns:

the last updated date for this table if available
getUpdatedDate()

Note

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

public boolean
isHidden()

Whether or not this table has been marked as hidden.

public boolean
isSystem()

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

Method Detail

getColumnback to summary
public Column getColumn(String name)

Returns the column with the given name.

Returns:Column

the column with the given name

getColumnCountback to summary
public int getColumnCount()

Returns the number of columns in this table.

Returns:int

the number of columns in this table

getColumnsback to summary
public List<? extends Column> getColumns()

Returns all of the columns in this table (unmodifiable List).

Returns:List<? extends Column>

All of the columns in this table (unmodifiable List)

getCreatedDateback to summary
public LocalDateTime getCreatedDate() throws IOException

Returns the created date for this table if available.

Returns:LocalDateTime

the created date for this table if available

getDatabaseback to summary
public Database getDatabase()

Returns the database to which this table belongs.

Returns:Database

the database to which this table belongs

getForeignKeyIndexback to summary
public Index getForeignKeyIndex(Table otherTable)

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

Returns:Index

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

Exceptions
IllegalArgumentException:
if there is no relationship between this table and the given table
getIndexback to summary
public Index getIndex(String name)

Returns the index with the given name.

Returns:Index

the index with the given name

Exceptions
IllegalArgumentException:
if there is no index with the given name
getIndexesback to summary
public List<? extends Index> getIndexes()

Returns all of the Indexes on this table (unmodifiable List).

Returns:List<? extends Index>

All of the Indexes on this table (unmodifiable List)

getNameback to summary
public String getName()

Returns the name of the table.

Returns:String

The name of the table

getPrimaryKeyIndexback to summary
public Index getPrimaryKeyIndex()

Returns the primary key index for this table.

Returns:Index

the primary key index for this table

Exceptions
IllegalArgumentException:
if there is no primary key index on this table
getPropertiesback to summary
public PropertyMap getProperties() throws IOException

Returns the properties for this table.

Returns:PropertyMap

the properties for this table

getUpdatedDateback to summary
public LocalDateTime getUpdatedDate() throws IOException

Note

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

Returns:LocalDateTime

the last updated date for this table if available

isHiddenback to summary
public boolean isHidden()

Whether or not this table has been marked as hidden.

isSystemback to summary
public boolean isSystem()

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