tap.metadata

Class TAPSchema

java.lang.Object

tap.metadata.TAPSchema

All Implemented Interfaces:

java.lang.Iterable<TAPTable>

public class TAPSchema
extends java.lang.Object
implements java.lang.Iterable<TAPTable>

Represent a schema 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.schemas. 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...

Note: On the contrary to TAPColumn and TAPTable, a TAPSchema object MAY have no DB name. But by default, at the creation the DB name is the simplified ADQL name (i.e. as it is returned by getADQLName()). Once created, it is possible to set the DB name with setDBName(String). This DB name MAY be qualified, BUT MUST BE without double quotes.

Version:

2.1 (07/2016)

Author:

Grégory Mantelet (CDS;ARI)

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.Object	otherData Let add some information in addition of the ones of the TAP protocol.
protected java.util.Map<java.lang.String,TAPTable>	tables List all tables contained inside this schema.

Constructor Summary

Constructors

Constructor and Description
TAPSchema(java.lang.String schemaName) Build a TAPSchema instance with the given ADQL name.
TAPSchema(java.lang.String schemaName, java.lang.String description) Build a TAPSchema instance with the given ADQL name and description.
TAPSchema(java.lang.String schemaName, java.lang.String description, java.lang.String utype) Build a TAPSchema instance with the given ADQL name, description and UType.

Method Summary

Modifier and Type	Method and Description
TAPTable	addTable(java.lang.String tableName) Build a TAPTable object whose the ADQL and DB name will the given one.
TAPTable	addTable(java.lang.String tableName, TAPTable.TableType tableType, java.lang.String description, java.lang.String utype) Build a TAPTable object whose the ADQL and DB name will the given one.
void	addTable(TAPTable newTable) Add the given table inside this schema.
java.lang.String	getADQLName() Get the name of this schema.
java.lang.String	getDBName() Get the name this schema MUST have in the database.
java.lang.String	getDescription() Get the description of this schema.
int	getIndex() Get the ordering index of this schema inside its whole schema set.
java.lang.String	getName() Deprecated. Does not do anything special: just call getADQLName().
int	getNbTables() Get the number of all tables contained inside this schema.
java.lang.Object	getOtherData() Get the other (piece of) information associated with this schema.
java.lang.String	getRawName() Get the full ADQL name of this schema, as it has been provided at initialization.
TAPTable	getTable(java.lang.String tableName) Search for a table having the given ADQL name.
java.lang.String	getTitle() Get the title of this schema.
java.lang.String	getUtype() Get the UType associating this schema with a data-model.
boolean	hasTable(java.lang.String tableName) Tell whether this schema contains a table having the given ADQL name.
boolean	isEmpty() Tell whether this schema contains no table.
java.util.Iterator<TAPTable>	iterator()
void	removeAllTables() Remove all the tables contained inside this schema.
TAPTable	removeTable(java.lang.String tableName) Remove the table having the given ADQL name.
void	setDBName(java.lang.String name) Set the name this schema MUST have in the database.
void	setDescription(java.lang.String description) Set the description of this schema.
void	setIndex(int schemaIndex) Set the ordering index of this schema inside its whole schema set.
void	setOtherData(java.lang.Object data) Set the other (piece of) information associated with this schema.
void	setTitle(java.lang.String title) Set the title of this schema.
void	setUtype(java.lang.String utype) Set the UType associating this schema 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

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.

tables

protected final java.util.Map<java.lang.String,TAPTable> tables

List all tables contained inside this schema.

Constructor Detail

TAPSchema

public TAPSchema(java.lang.String schemaName)
          throws java.lang.NullPointerException

Build a TAPSchema instance with the given ADQL name.

Note: The DB name is set by default to the ADQL name (as returned by getADQLName()). To set the DB name, you MUST call then setDBName(String).

Important notes on the given ADQL name:

• Any leading or trailing space is immediately deleted.
• No catalog prefix is supported. For instance: myCatalog.mySchema will be considered as the schema name instead of mySchema.
• Double quotes may surround the ADQL name. They will be removed by getADQLName() but will still appear in the result of getRawName().

Parameters:

schemaName - Name that this schema 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).

TAPSchema

public TAPSchema(java.lang.String schemaName,
                 java.lang.String description)
          throws java.lang.NullPointerException

Build a TAPSchema instance with the given ADQL name and description.

Note: The DB name is set by default to the ADQL name (as returned by getADQLName()). To set the DB name, you MUST call then setDBName(String).

Important notes on the given ADQL name:

• Any leading or trailing space is immediately deleted.
• No catalog prefix is supported. For instance: myCatalog.mySchema will be considered as the schema name instead of mySchema.
• Double quotes may surround the ADQL name. They will be removed by getADQLName() but will still appear in the result of getRawName().

Parameters:

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

description - Description of this schema. 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).

TAPSchema

public TAPSchema(java.lang.String schemaName,
                 java.lang.String description,
                 java.lang.String utype)
          throws java.lang.NullPointerException

Build a TAPSchema instance with the given ADQL name, description and UType.

Note: The DB name is set by default to the ADQL name (as returned by getADQLName()). To set the DB name, you MUST call then setDBName(String).

Important notes on the given ADQL name:

• Any leading or trailing space is immediately deleted.
• No catalog prefix is supported. For instance: myCatalog.mySchema will be considered as the schema name instead of mySchema.
• Double quotes may surround the ADQL name. They will be removed by getADQLName() but will still appear in the result of getRawName().

Parameters:

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

description - Description of this schema. MAY be NULL

utype - UType associating this schema 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).

Method Detail

getName

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

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

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

Returns:

Its ADQL name.

See Also:

getADQLName()

getADQLName

public final java.lang.String getADQLName()

Get the name of this schema.

Note: If a simplification is needed, the double quotes surrounding the ADQL name, will be removed.

Returns:

Its ADQL name. CAN'T be NULL

getRawName

public final java.lang.String getRawName()

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

Returns:

Get the original ADQL name.

Since:

2.1

getDBName

public final java.lang.String getDBName()

Get the name this schema MUST have in the database.

Returns:

Its DB name. MAY be NULL

setDBName

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

Set the name this schema MUST have in the database.

Notes:

• The given name may be NULL. In such case getDBName() will then return NULL.
• It may be prefixed by a catalog name.
• It MUST be NON delimited/double-quoted. Otherwise an SQL error will be raised when querying any item of this schema because the library double-quotes systematically the DB name of schemas, tables and columns.

Parameters:

name - Its new DB name. MAY be NULL

getTitle

public final java.lang.String getTitle()

Get the title of this schema.

Returns:

Its title. MAY be NULL

Since:

2.0

setTitle

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

Set the title of this schema.

Parameters:

title - Its new title. MAY be NULL

Since:

2.0

getDescription

public final java.lang.String getDescription()

Get the description of this schema.

Returns:

Its description. MAY be NULL

setDescription

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

Set the description of this schema.

Parameters:

description - Its new description. MAY be NULL

getUtype

public final java.lang.String getUtype()

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

Returns:

Its UType. MAY be NULL

setUtype

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

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

Parameters:

utype - Its new UType. MAY be NULL

getIndex

public final int getIndex()

Get the ordering index of this schema inside its whole schema set.

Returns:

Its ordering index.

Since:

2.1

setIndex

public final void setIndex(int schemaIndex)

Set the ordering index of this schema inside its whole schema set.

Parameters:

schemaIndex - Its new ordering index.

Since:

2.1

getOtherData

public java.lang.Object getOtherData()

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

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 schema.

Parameters:

data - Another information about this schema. MAY be NULL

addTable

public final void addTable(TAPTable newTable)

Add the given table inside this schema.

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

Important note: By adding the given table inside this schema, it will be linked with this schema using TAPTable.setSchema(TAPSchema). In this function, if the table was already linked with another TAPSchema, the former link is removed using removeTable(String).

Parameters:

newTable - Table to add inside this schema.

addTable

public TAPTable addTable(java.lang.String tableName)

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

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

Parameters:

tableName - ADQL name (and indirectly also the DB name) of the table to create and add.

Returns:

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

See Also:

TAPTable.TAPTable(String), addTable(TAPTable)

addTable

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

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

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

Parameters:

tableName - ADQL name (and indirectly also the DB name) of the table to create and add.

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

description - Description of the new table. MAY be NULL

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

Returns:

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

See Also:

TAPTable.TAPTable(String, TableType, String, String), addTable(TAPTable)

hasTable

public final boolean hasTable(java.lang.String tableName)

Tell whether this schema contains a table having the given ADQL name.

Important note: This function is case sensitive!

Parameters:

tableName - Name of the table whose the existence in this schema must be checked.

Returns:

true if a table with the given ADQL name exists, false otherwise.

getTable

public final TAPTable getTable(java.lang.String tableName)

Search for a table having the given ADQL name.

Important note: This function is case sensitive!

Parameters:

tableName - ADQL name of the table to search.

Returns:

The table having the given ADQL name, or NULL if no such table can be found.

getNbTables

public final int getNbTables()

Get the number of all tables contained inside this schema.

Returns:

Number of its tables.

isEmpty

public final boolean isEmpty()

Tell whether this schema contains no table.

Returns:

true if this schema contains no table, false if it has at least one table.

removeTable

public final TAPTable removeTable(java.lang.String tableName)

Remove the table having the given ADQL name.

Important note: This function is case sensitive!

Note: If the specified table is removed, its schema link is also deleted.

WARNING: If the goal of this function's call is to delete definitely the specified table from the metadata, you SHOULD also call TAPTable.removeAllForeignKeys(). Indeed, foreign keys of the table would still link the removed table with other tables AND columns of the whole metadata set.

Parameters:

tableName - ADQL name of the table to remove from this schema.

Returns:

The removed table, or NULL if no table with the given ADQL name can be found.

removeAllTables

public final void removeAllTables()

Remove all the tables contained inside this schema.

Note: When a table is removed, its schema link is also deleted.

CAUTION: If the goal of this function's call is to delete definitely all the tables of this schema from the metadata, you SHOULD also call TAPTable.removeAllForeignKeys() on all tables before calling this function. Indeed, foreign keys of the tables would still link the removed tables with other tables AND columns of the whole metadata set.

iterator

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

Specified by:

iterator in interface java.lang.Iterable<TAPTable>

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object