tap.metadata

Class TAPTable

java.lang.Object

tap.metadata.TAPTable

All Implemented Interfaces:

DBTable, java.lang.Iterable<DBColumn>

public class TAPTable
extends java.lang.Object
implements DBTable

Represent a table as described by the IVOA standard in the TAP protocol definition.

This object representation has exactly the same fields as the column of the table TAP_SCHEMA.tables. But it also provides a way to add other data. For instance, if information not listed in the standard may be stored here, they can be using the function setOtherData(Object). This object can be a single value (integer, string, ...), but also a Map, List, etc...

Important note: A TAPTable object MUST always have a DB name. That's why, getDBName() returns what getADQLName() returns when no DB name is set. After creation, it is possible to set the DB name with setDBName(String).
This DB name MUST be UNqualified and without double quotes. If a NULL or empty value is provided, getDBName() returns what getADQLName() returns.

Version:

2.1 (07/2016)

Author:

Grégory Mantelet (CDS;ARI)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TAPTable.TableType Different types of table according to the TAP protocol.

Field Summary

Fields

Modifier and Type	Field and Description
protected java.util.Map<java.lang.String,TAPColumn>	columns List of columns composing this table.
protected java.util.ArrayList<TAPForeignKey>	foreignKeys List of all foreign keys linking this table to others.
protected java.lang.Object	otherData Let add some information in addition of the ones of the TAP protocol.

Constructor Summary

Constructors

Constructor and Description
TAPTable(java.lang.String tableName) Build a TAPTable instance with the given ADQL name.
TAPTable(java.lang.String tableName, TAPTable.TableType tableType) Build a TAPTable instance with the given ADQL name and table type.
TAPTable(java.lang.String tableName, TAPTable.TableType tableType, java.lang.String description, java.lang.String utype) Build a TAPTable instance with the given ADQL name, table type, description and UType.

Method Summary

Modifier and Type	Method and Description
TAPColumn	addColumn(java.lang.String columnName) Build a TAPColumn object whose the ADQL and DB name will the given one.
TAPColumn	addColumn(java.lang.String columnName, DBType datatype, java.lang.String description, java.lang.String unit, java.lang.String ucd, java.lang.String utype) Build a TAPColumn object whose the ADQL and DB name will the given one.
TAPColumn	addColumn(java.lang.String columnName, DBType datatype, java.lang.String description, java.lang.String unit, java.lang.String ucd, java.lang.String utype, boolean principal, boolean indexed, boolean std) Build a TAPColumn object whose the ADQL and DB name will the given one.
void	addColumn(TAPColumn newColumn) Add a column to this table.
TAPForeignKey	addForeignKey(java.lang.String keyId, TAPTable targetTable, java.util.Map<java.lang.String,java.lang.String> columns) Build a foreign key using the ID, the target table and the given list of columns.
TAPForeignKey	addForeignKey(java.lang.String keyId, TAPTable targetTable, java.util.Map<java.lang.String,java.lang.String> columns, java.lang.String description, java.lang.String utype) Build a foreign key using the ID, the target table, the given list of columns, the given description and the given UType.
void	addForeignKey(TAPForeignKey key) Add the given foreign key to this table.
DBTable	copy(java.lang.String dbName, java.lang.String adqlName) Makes a copy of this instance of DBTable, with the possibility to change the DB and ADQL names.
protected void	deleteColumnRelations(TAPColumn col) Delete all foreign keys having the given column in the sources or the targets list.
protected void	deleteRelations(TAPForeignKey key) Delete the link between all columns of the given foreign key and this foreign key.
java.lang.String	getADQLCatalogName() Gets the ADQL name of the catalog which contains this table.
java.lang.String	getADQLName() Gets the name of this table (without any prefix and double-quotes).
java.lang.String	getADQLSchemaName() Gets the ADQL name of the schema which contains this table.
TAPColumn	getColumn(java.lang.String columnName) Search a column inside this table having the given ADQL name.
DBColumn	getColumn(java.lang.String colName, boolean byAdqlName) Gets the definition of the specified column if it exists in this table.
java.util.Iterator<TAPColumn>	getColumns() Get the list of all columns contained in this table.
java.lang.String	getDBCatalogName() Gets the DB name of the catalog which contains this table.
java.lang.String	getDBName() Gets the name of this table in the "database".
java.lang.String	getDBSchemaName() Gets the DB name of the schema which contains this table.
java.lang.String	getDescription() Get the description of this table.
java.util.Iterator<TAPForeignKey>	getForeignKeys() Get the list of all foreign keys associated whose the source is this table.
java.lang.String	getFullName() Get the qualified name of this table.
int	getIndex() Get the ordering index of this table inside its schema.
java.lang.String	getName() Deprecated. Does not do anything special: just call getADQLName().
int	getNbColumns() Get the number of columns composing this table.
int	getNbForeignKeys() Get the number of all foreign keys whose the source is this table
java.lang.Object	getOtherData() Get the other (piece of) information associated with this table.
java.lang.String	getRawName() Get the full ADQL name of this table, as it has been provided at initialization.
TAPSchema	getSchema() Get the schema that owns this table.
java.lang.String	getTitle() Get the title of this table.
TAPTable.TableType	getType() Get the type of this table.
java.lang.String	getUtype() Get the UType associating this table with a data-model.
boolean	hasColumn(java.lang.String columnName) Tell whether this table contains a column with the given ADQL name.
boolean	hasColumn(java.lang.String colName, boolean byAdqlName) Tell whether this table contains a column with the given ADQL or DB name.
boolean	isEmpty() Tell whether this table contains no column.
boolean	isInitiallyQualified() Deprecated. To get name of the table as it should be used: getRawName(). To get just the table name (with no prefix and surrounding double quotes): getADQLName().
java.util.Iterator<DBColumn>	iterator()
void	removeAllColumns() Remove all columns composing this table.
void	removeAllForeignKeys() Remove all the foreign keys whose the source is this table.
TAPColumn	removeColumn(java.lang.String columnName) Remove the specified column.
boolean	removeForeignKey(TAPForeignKey keyToRemove) Remove the given foreign key from this table.
void	setDBName(java.lang.String name) Change the name that this table MUST have in the database (i.e.
void	setDescription(java.lang.String description) Set the description of this table.
void	setIndex(int tableIndex) Set the ordering index of this table inside its schema.
void	setInitiallyQualifed(boolean mustBeQualified) Deprecated. To get name of the table as it should be used: getRawName(). To get just the table name (with no prefix and surrounding double quotes): getADQLName().
void	setOtherData(java.lang.Object data) Set the other (piece of) information associated with this table.
protected void	setSchema(TAPSchema schema) Set the schema in which this schema is.
void	setTitle(java.lang.String title) Set the title of this table.
void	setType(TAPTable.TableType type) Set the type of this table.
void	setUtype(java.lang.String utype) Set the UType associating this table with a data-model.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

columns

protected final java.util.Map<java.lang.String,TAPColumn> columns

List of columns composing this table. Note: all columns of this list are linked to this table from the moment they are added inside it.

foreignKeys

protected final java.util.ArrayList<TAPForeignKey> foreignKeys

List of all foreign keys linking this table to others.

otherData

protected java.lang.Object otherData

Let add some information in addition of the ones of the TAP protocol. Note: This object can be anything: an Integer, a String, a Map, a List, ... Its content is totally free and never used or checked.

Constructor Detail

TAPTable

public TAPTable(java.lang.String tableName)
         throws java.lang.NullPointerException

Build a TAPTable instance with the given ADQL name.

Note 1: The DB name is set by default to NULL so that getDBName() returns exactly what getADQLName() returns. To set a specific DB name, you MUST call setDBName(String).

Note 2: The table type is set by default to "table".

Important notes on the given ADQL name:

• Any leading or trailing space is immediately deleted.
• If the table name is prefixed by its schema name, this prefix is removed by getADQLName() but will be still here when using getRawName(). To work, the schema name must be exactly the same as what the function TAPSchema.getRawName() of the set schema returns.
• Double quotes may surround the single table name. They will be removed by getADQLName() but will still appear in the result of getRawName().

Parameters:

tableName - Name that this table MUST have in ADQL queries. CAN'T be NULL ; this name can never be changed after initialization.

Throws:

java.lang.NullPointerException - If the given name is null, or if the given string is empty after simplification (i.e. without the surrounding double quotes).

TAPTable

public TAPTable(java.lang.String tableName,
                TAPTable.TableType tableType)
         throws java.lang.NullPointerException

Build a TAPTable instance with the given ADQL name and table type.

Note 1: The DB name is set by default to NULL so that getDBName() returns exactly what getADQLName() returns. To set a specific DB name, you MUST call setDBName(String).

Note 2: The table type is set by default to "table".

Important notes on the given ADQL name:

• Any leading or trailing space is immediately deleted.
• If the table name is prefixed by its schema name, this prefix is removed by getADQLName() but will be still here when using getRawName(). To work, the schema name must be exactly the same as what the function TAPSchema.getRawName() of the set schema returns.
• Double quotes may surround the single table name. They will be removed by getADQLName() but will still appear in the result of getRawName().

Parameters:

tableName - Name that this table MUST have in ADQL queries. CAN'T be NULL ; this name can never be changed after initialization.

tableType - Type of this table. If NULL, "table" will be the type of this table.

Throws:

java.lang.NullPointerException - If the given name is null, or if the given string is empty after simplification (i.e. without the surrounding double quotes).

See Also:

setType(TableType)

TAPTable

public TAPTable(java.lang.String tableName,
                TAPTable.TableType tableType,
                java.lang.String description,
                java.lang.String utype)
         throws java.lang.NullPointerException

Build a TAPTable instance with the given ADQL name, table type, description and UType.

Note 1: The DB name is set by default to NULL so that getDBName() returns exactly what getADQLName() returns. To set a specific DB name, you MUST call setDBName(String).

Note 2: The table type is set by default to "table".

Important notes on the given ADQL name:

• Any leading or trailing space is immediately deleted.
• If the table name is prefixed by its schema name, this prefix is removed by getADQLName() but will be still here when using getRawName(). To work, the schema name must be exactly the same as what the function TAPSchema.getRawName() of the set schema returns.
• Double quotes may surround the single table name. They will be removed by getADQLName() but will still appear in the result of getRawName().

Parameters:

tableName - Name that this table MUST have in ADQL queries. CAN'T be NULL ; this name can never be changed after initialization.

tableType - Type of this table. If NULL, "table" will be the type of this table.

description - Description of this table. MAY be NULL.

utype - UType associating this table with a data-model. MAY be NULL

Throws:

java.lang.NullPointerException - If the given name is null, or if the given string is empty after simplification (i.e. without the surrounding double quotes).

See Also:

setType(TableType)

Method Detail

getFullName

public final java.lang.String getFullName()

Get the qualified name of this table.

Warning: The part of the returned full name won't be double quoted!

Note: If this table is not attached to a schema, this function will just return the ADQL name of this table.

Returns:

Qualified ADQL name of this table.

getName

@Deprecated
public final java.lang.String getName()

Deprecated. Does not do anything special: just call getADQLName().

Get the ADQL name (the name this table MUST have in ADQL queries).

Returns:

Its ADQL name.

See Also:

getADQLName()

getADQLName

public final java.lang.String getADQLName()

Description copied from interface: DBTable

Gets the name of this table (without any prefix and double-quotes).

Specified by:

getADQLName in interface DBTable

Returns:

Its ADQL name.

getRawName

public final java.lang.String getRawName()

Get the full ADQL name of this table, as it has been provided at initialization.

Returns:

Get the original ADQL name.

Since:

2.1

isInitiallyQualified

@Deprecated
public final boolean isInitiallyQualified()

Deprecated. To get name of the table as it should be used: getRawName(). To get just the table name (with no prefix and surrounding double quotes): getADQLName().

Tells whether the ADQL name of this table must be qualified in the "table_name" column of TAP_SCHEMA.tables and in the /schema/table/name field of the resource /tables.

Note: this value is set automatically by the constructor: "true" if the table name was qualified, "false" otherwise. It can be changed with the function setInitiallyQualifed(boolean), BUT by doing so you may generate a mismatch between the table name of TAP_SCHEMA.tables and the one of /tables.

Returns:

true if the table name must be qualified in TAP_SCHEMA.tables and in /tables, false otherwise.

Since:

2.0

setInitiallyQualifed

@Deprecated
public final void setInitiallyQualifed(boolean mustBeQualified)

Deprecated. To get name of the table as it should be used: getRawName(). To get just the table name (with no prefix and surrounding double quotes): getADQLName().

Let specifying whether the table name must be qualified in TAP_SCHEMA.tables and in the resource /tables.

WARNING: Calling this function may generate a mismatch between the table name of TAP_SCHEMA.tables and the one of the resource /tables. So, be sure to change this flag before setting the content of TAP_SCHEMA.tables using JDBCConnection.setTAPSchema(TAPMetadata).

Parameters:

mustBeQualified - true if the table name in TAP_SCHEMA.tables and in the resource /tables must be qualified by the schema name, false otherwise.

Since:

2.0

getDBName

public final java.lang.String getDBName()

Description copied from interface: DBTable

Gets the name of this table in the "database".

Specified by:

getDBName in interface DBTable

Returns:

Its DB name.

setDBName

public final void setDBName(java.lang.String name)

Change the name that this table MUST have in the database (i.e. in SQL queries).

Note: If the given value is NULL or an empty string, getDBName() will return exactly what getADQLName() returns.

Parameters:

name - The new database name of this table.

getADQLCatalogName

public java.lang.String getADQLCatalogName()

Description copied from interface: DBTable

Gets the ADQL name of the catalog which contains this table.

Specified by:

getADQLCatalogName in interface DBTable

Returns:

ADQL name of its catalog.

getDBCatalogName

public java.lang.String getDBCatalogName()

Description copied from interface: DBTable

Gets the DB name of the catalog which contains this table.

Specified by:

getDBCatalogName in interface DBTable

Returns:

DB name of its catalog.

getADQLSchemaName

public final java.lang.String getADQLSchemaName()

Description copied from interface: DBTable

Gets the ADQL name of the schema which contains this table.

Specified by:

getADQLSchemaName in interface DBTable

Returns:

ADQL name of its schema.

getDBSchemaName

public final java.lang.String getDBSchemaName()

Description copied from interface: DBTable

Gets the DB name of the schema which contains this table.

Specified by:

getDBSchemaName in interface DBTable

Returns:

DB name of its schema.

getSchema

public final TAPSchema getSchema()

Get the schema that owns this table.

Returns:

Its schema. MAY be NULL

setSchema

protected final void setSchema(TAPSchema schema)

Set the schema in which this schema is.

Warning: For consistency reasons, this function SHOULD be called only by the TAPSchema that owns this table.

Important note: If this table was already linked with another TAPSchema object, the previous link is removed here, but also in the schema (by calling TAPSchema.removeTable(String)).

Parameters:

schema - The schema that owns this table.

getType

public final TAPTable.TableType getType()

Get the type of this table.

Returns:

Its type.

setType

public final void setType(TAPTable.TableType type)

Set the type of this table.

Note: If the given type is NULL, nothing will be done ; the type of this table won't be changed.

Parameters:

type - Its new type.

getTitle

public final java.lang.String getTitle()

Get the title of this table.

Returns:

Its title. MAY be NULL

Since:

2.0

setTitle

public final void setTitle(java.lang.String title)

Set the title of this table.

Parameters:

title - Its new title. MAY be NULL

Since:

2.0

getDescription

public final java.lang.String getDescription()

Get the description of this table.

Returns:

Its description. MAY be NULL

setDescription

public final void setDescription(java.lang.String description)

Set the description of this table.

Parameters:

description - Its new description. MAY be NULL

getUtype

public final java.lang.String getUtype()

Get the UType associating this table with a data-model.

Returns:

Its UType. MAY be NULL

setUtype

public final void setUtype(java.lang.String utype)

Set the UType associating this table with a data-model.

Parameters:

utype - Its new UType. MAY be NULL

getIndex

public final int getIndex()

Get the ordering index of this table inside its schema.

Returns:

Its ordering index.

Since:

2.1

setIndex

public final void setIndex(int tableIndex)

Set the ordering index of this table inside its schema.

Parameters:

tableIndex - Its new ordering index.

Since:

2.1

getOtherData

public java.lang.Object getOtherData()

Get the other (piece of) information associated with this table.

Note: By default, NULL is returned, but it may be any kind of value (Integer, String, Map, List, ...).

Returns:

The other (piece of) information. MAY be NULL

setOtherData

public void setOtherData(java.lang.Object data)

Set the other (piece of) information associated with this table.

Parameters:

data - Another information about this table. MAY be NULL

addColumn

public final void addColumn(TAPColumn newColumn)

Add a column to this table.

Note: If the given column is NULL, nothing will be done.

Important note: By adding the given column inside this table, it will be linked with this table using TAPColumn.setTable(DBTable). In this function, if the column was already linked with another TAPTable, the former link is removed using removeColumn(String).

Parameters:

newColumn - Column to add inside this table.

addColumn

public final TAPColumn addColumn(java.lang.String columnName)

Build a TAPColumn object whose the ADQL and DB name will the given one. Then, add this column inside this table.

Note: The built TAPColumn object is returned, so that being modified afterwards if needed.

Parameters:

columnName - ADQL name (and indirectly also the DB name) of the column to create and add.

Returns:

The created and added TAPColumn object, or NULL if the given name is NULL or an empty string.

See Also:

TAPColumn.TAPColumn(String), addColumn(TAPColumn)

addColumn

public TAPColumn addColumn(java.lang.String columnName,
                           DBType datatype,
                           java.lang.String description,
                           java.lang.String unit,
                           java.lang.String ucd,
                           java.lang.String utype)

Build a TAPColumn object whose the ADQL and DB name will the given one. Then, add this column inside this table.

Note: The built TAPColumn object is returned, so that being modified afterwards if needed.

Parameters:

columnName - ADQL name (and indirectly also the DB name) of the column to create and add.

datatype - Type of the new column's values. If NULL, VARCHAR will be the type of the created column.

description - Description of the new column. MAY be NULL

unit - Unit of the new column's values. MAY be NULL

ucd - UCD describing the scientific content of the new column. MAY be NULL

utype - UType associating the new column with a data-model. MAY be NULL

Returns:

The created and added TAPColumn object, or NULL if the given name is NULL or an empty string.

See Also:

TAPColumn.TAPColumn(String, DBType, String, String, String, String), addColumn(TAPColumn)

addColumn

public TAPColumn addColumn(java.lang.String columnName,
                           DBType datatype,
                           java.lang.String description,
                           java.lang.String unit,
                           java.lang.String ucd,
                           java.lang.String utype,
                           boolean principal,
                           boolean indexed,
                           boolean std)

Build a TAPColumn object whose the ADQL and DB name will the given one. Then, add this column inside this table.

Note: The built TAPColumn object is returned, so that being modified afterwards if needed.

Parameters:

columnName - ADQL name (and indirectly also the DB name) of the column to create and add.

datatype - Type of the new column's values. If NULL, VARCHAR will be the type of the created column.

description - Description of the new column. MAY be NULL

unit - Unit of the new column's values. MAY be NULL

ucd - UCD describing the scientific content of the new column. MAY be NULL

utype - UType associating the new column with a data-model. MAY be NULL

principal - true if the new column should be returned by default, false otherwise.

indexed - true if the new column is indexed, false otherwise.

std - true if the new column is defined by a standard, false otherwise.

Returns:

The created and added TAPColumn object, or NULL if the given name is NULL or an empty string.

See Also:

TAPColumn.TAPColumn(String, DBType, String, String, String, String), TAPColumn.setPrincipal(boolean), TAPColumn.setIndexed(boolean), TAPColumn.setStd(boolean), addColumn(TAPColumn)

hasColumn

public final boolean hasColumn(java.lang.String columnName)

Tell whether this table contains a column with the given ADQL name.

Important note: This function is case sensitive.

Parameters:

columnName - ADQL name (case sensitive) of the column whose the existence must be checked.

Returns:

true if a column having the given ADQL name exists in this table, false otherwise.

getColumns

public java.util.Iterator<TAPColumn> getColumns()

Get the list of all columns contained in this table.

Returns:

An iterator over the list of this table's columns.

getColumn

public DBColumn getColumn(java.lang.String colName,
                          boolean byAdqlName)

Description copied from interface: DBTable

Gets the definition of the specified column if it exists in this table.

Specified by:

getColumn in interface DBTable

Parameters:

colName - Name of the column (may be the ADQL or DB name depending of the second parameter).

byAdqlName - true means the given name is the ADQL name of the column and that the research must be done on the ADQL name of columns, false means the same thing but with the DB name.

Returns:

The corresponding column, or null if the specified column had not been found.

getColumn

public final TAPColumn getColumn(java.lang.String columnName)

Search a column inside this table having the given ADQL name.

Important note: This function is case sensitive.

Parameters:

columnName - ADQL name of the column to search.

Returns:

The matching column, or NULL if no column with this ADQL name has been found.

hasColumn

public boolean hasColumn(java.lang.String colName,
                         boolean byAdqlName)

Tell whether this table contains a column with the given ADQL or DB name.

Note: This functions is just calling getColumn(String, boolean) and compare its result with NULL in order to check the existence of the specified column.

Parameters:

colName - ADQL or DB name that the column to search must have.

byAdqlName - true to search the column by ADQL name, false to search by DB name.

Returns:

true if a column has been found inside this table with the given ADQL or DB name, false otherwise.

See Also:

getColumn(String, boolean)

getNbColumns

public final int getNbColumns()

Get the number of columns composing this table.

Returns:

Number of its columns.

isEmpty

public final boolean isEmpty()

Tell whether this table contains no column.

Returns:

true if this table is empty (no column), false if it contains at least one column.

removeColumn

public final TAPColumn removeColumn(java.lang.String columnName)

Remove the specified column.

Important note: This function is case sensitive!

Note: If some foreign keys were associating the column to remove, they will be also deleted.

Parameters:

columnName - ADQL name of the column to remove.

Returns:

The removed column, or NULL if no column with the given ADQL name has been found.

See Also:

deleteColumnRelations(TAPColumn)

deleteColumnRelations

protected final void deleteColumnRelations(TAPColumn col)

Delete all foreign keys having the given column in the sources or the targets list.

Parameters:

col - A column.

removeAllColumns

public final void removeAllColumns()

Remove all columns composing this table. Foreign keys will also be deleted.

addForeignKey

public final void addForeignKey(TAPForeignKey key)
                         throws TAPException

Add the given foreign key to this table.

Note: This function will do nothing if the given foreign key is NULL.

WARNING: The source table (TAPForeignKey.getFromTable()) of the given foreign key MUST be this table and the foreign key MUST be completely defined. If not, an exception will be thrown and the key won't be added.

Note: If the given foreign key is added to this table, all the columns of this key will be linked to the foreign key using either TAPColumn.addSource(TAPForeignKey) or TAPColumn.addTarget(TAPForeignKey).

Parameters:

key - Foreign key (whose the FROM table is this table) to add inside this table.

Throws:

TAPException - If the source table of the given foreign key is not this table or if the given key is not completely defined.

addForeignKey

public TAPForeignKey addForeignKey(java.lang.String keyId,
                                   TAPTable targetTable,
                                   java.util.Map<java.lang.String,java.lang.String> columns)
                            throws TAPException

Build a foreign key using the ID, the target table and the given list of columns. Then, add the created foreign key to this table.

Note: The source table of the created foreign key (TAPForeignKey.getFromTable()) will be this table.

Note: If the given foreign key is added to this table, all the columns of this key will be linked to the foreign key using either TAPColumn.addSource(TAPForeignKey) or TAPColumn.addTarget(TAPForeignKey).

Returns:

The created and added foreign key.

Throws:

TAPException - If the specified key is not completely or correctly defined.

See Also:

TAPForeignKey.TAPForeignKey(String, TAPTable, TAPTable, Map)

addForeignKey

public TAPForeignKey addForeignKey(java.lang.String keyId,
                                   TAPTable targetTable,
                                   java.util.Map<java.lang.String,java.lang.String> columns,
                                   java.lang.String description,
                                   java.lang.String utype)
                            throws TAPException

Build a foreign key using the ID, the target table, the given list of columns, the given description and the given UType. Then, add the created foreign key to this table.

Note: The source table of the created foreign key (TAPForeignKey.getFromTable()) will be this table.

Note: If the given foreign key is added to this table, all the columns of this key will be linked to the foreign key using either TAPColumn.addSource(TAPForeignKey) or TAPColumn.addTarget(TAPForeignKey).

Returns:

The created and added foreign key.

Throws:

TAPException - If the specified key is not completely or correctly defined.

See Also:

TAPForeignKey.TAPForeignKey(String, TAPTable, TAPTable, Map, String, String)

getForeignKeys

public final java.util.Iterator<TAPForeignKey> getForeignKeys()

Get the list of all foreign keys associated whose the source is this table.

Returns:

An iterator over all its foreign keys.

getNbForeignKeys

public final int getNbForeignKeys()

Get the number of all foreign keys whose the source is this table

Returns:

Number of all its foreign keys.

removeForeignKey

public final boolean removeForeignKey(TAPForeignKey keyToRemove)

Remove the given foreign key from this table.

Note: This function will also delete the link between the columns of the foreign key and the foreign key, using deleteRelations(TAPForeignKey).

Parameters:

keyToRemove - Foreign key to removed from this table.

Returns:

true if the key has been successfully removed, false otherwise.

removeAllForeignKeys

public final void removeAllForeignKeys()

Remove all the foreign keys whose the source is this table.

Note: This function will also delete the link between the columns of all the removed foreign keys and the foreign keys, using deleteRelations(TAPForeignKey).

deleteRelations

protected final void deleteRelations(TAPForeignKey key)

Delete the link between all columns of the given foreign key and this foreign key. Thus, these columns won't be anymore source or target of this foreign key.

Parameters:

key - A foreign key whose links with its columns must be deleted.

iterator

public java.util.Iterator<DBColumn> iterator()

Specified by:

iterator in interface java.lang.Iterable<DBColumn>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

copy

public DBTable copy(java.lang.String dbName,
                    java.lang.String adqlName)

Description copied from interface: DBTable

Makes a copy of this instance of DBTable, with the possibility to change the DB and ADQL names.

IMPORTANT: The given DB and ADQL name may be NULL. If NULL, the copy will contain exactly the same full name (DB and/or ADQL).
And they may be qualified (that's to say: prefixed by the schema name or by the catalog and schema name). It means that it is possible to change the catalog, schema and table name in the copy.
For instance:

• .copy(null, "foo") => a copy with the same full DB name, but with no ADQL catalog and schema name and with an ADQL table name equals to "foo"
• .copy("schema.table", ) => a copy with the same full ADQL name, but with no DB catalog name, with a DB schema name equals to "schema" and with a DB table name equals to "table"

Specified by:

copy in interface DBTable

Parameters:

dbName - Its new DB name. It may be qualified. It may also be NULL ; if so, the full DB name won't be different in the copy.

adqlName - Its new ADQL name. It may be qualified. It may also be NULL ; if so, the full DB name won't be different in the copy.

Returns:

A modified copy of this DBTable.