TAPMetadata

java.lang.Object
- tap.metadata.TAPMetadata

All Implemented Interfaces:

java.lang.Iterable<TAPSchema>, TAPResource, VOSIResource
```
public class TAPMetadata
extends java.lang.Object
implements java.lang.Iterable<TAPSchema>, VOSIResource, TAPResource
```
Let listing all schemas, tables and columns available in a TAP service. This list also corresponds to the TAP resource "/tables".

Only schemas are stored in this object. So that's why only schemas can be added and removed from this class. However, TAPSchema objects are listing tables, whose the object representation is listing columns. So to add tables, you must first embed them in a schema.

All metadata have two names: one to use in ADQL queries and the other to use when really querying the database. This is very useful to hide the real complexity of the database and propose a simpler view of the query-able data. It is particularly useful if a schema does not exist in the database but has been added in the TAP schema for more logical separation on the user point of view. In a such case, the schema would have an ADQL name but no DB name (NULL value ; which is possible only with TAPSchema objects).

This class lets also detect the ObsCore and RegTAP data models, thanks to the functions getObsCoreTable() and getRegTAPSchema() which return resp. the ObsCore table and the RegTAP schema if matching the IVOA specification.

Version:

2.1 (11/2017)

Author:

Grégory Mantelet (CDS;ARI)

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`TAPMetadata.STDSchema` Enumeration of all schemas defined in the TAP standard.
`static class`	`TAPMetadata.STDTable` Enumeration of all tables of TAP_SCHEMA.
`protected static class`	`TAPMetadata.TAPTableIterator` Let iterating over the list of all tables contained in a given `TAPMetadata` object.

Field Summary

Fields
Modifier and Type	Field and Description
`protected java.lang.String`	`accessURL` Part of the TAP URI which identify this TAP resource.
`protected java.util.Map<java.lang.String,TAPCoosys>`	`coordinateSystems` List of all coordinate systems used by columns published in the TAP_SCHEMA.
`static java.lang.String`	`RESOURCE_NAME` Resource name of the TAP metadata.
`protected java.util.Map<java.lang.String,TAPSchema>`	`schemas` List of all schemas available through the TAP service.
`protected java.lang.String`	`xsltPath` The path of the XSLT style-sheet to apply.

Constructor Summary

Constructors
Constructor and Description

TAPMetadata()
Build an empty list of metadata.

Constructors
Constructor and Description
`TAPMetadata()` Build an empty list of metadata.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`TAPCoosys`	`addCoosys(TAPCoosys newCoosys)` Add the given coordinate system definition.
`TAPSchema`	`addSchema(java.lang.String schemaName)` Build a new `TAPSchema` object with the given ADQL name.
`TAPSchema`	`addSchema(java.lang.String schemaName, java.lang.String description, java.lang.String utype)` Build a new `TAPSchema` object with the given ADQL name.
`void`	`addSchema(TAPSchema s)` Add the given schema inside this TAP metadata set.
`void`	`destroy()` Let free properly all system/file/DB resources kept opened by this TAP resource.
`boolean`	`executeResource(javax.servlet.http.HttpServletRequest request, javax.servlet.http.HttpServletResponse response)` Interpret the given request, execute the appropriate action and finally return a result or display information to the user.
`java.lang.String`	`getAccessURL()` Get the URL which lets access this resource.
`java.lang.String`	`getCapability()` Get the capabilities of this resource.
`TAPCoosys`	`getCoosys(java.lang.String coosysId)` Get the coordinate system definition associated with the given ID.
`static TAPTable`	`getCoosysTable()` Get the minimum definition of the table TAP_SCHEMA.coosys as expected by the library (see `JDBCConnection.getTAPSchema()`.
`java.lang.String`	`getName()` Get the name of this TAP resource.
`int`	`getNbSchemas()` Get the number of schemas contained in this TAP metadata set.
`int`	`getNbTables()` Get the number of all tables contained in this TAP metadata set.
`TAPTable`	`getObsCoreTable()` Get the description of the ObsCore table, if it is defined.
`TAPSchema`	`getRegTAPSchema()` Get the description of the RegTAP schema, if it is defined.
`TAPSchema`	`getSchema(java.lang.String schemaName)` Search for a schema having the given ADQL name.
`java.lang.String`	`getStandardID()` Get the standardID of this endpoint of the VOSI interface.
`static TAPSchema`	`getStdSchema(boolean isSchemaSupported)` Get the definition of the whole standard TAP_SCHEMA.
`static TAPTable`	`getStdTable(TAPMetadata.STDTable tableId)` Get the definition of the specified standard TAP table.
`java.util.List<DBTable>`	`getTable(java.lang.String tableName)` Search in this TAP metadata set for all tables whose the ADQL name matches the given one, whatever is their schema.
`TAPTable`	`getTable(java.lang.String schemaName, java.lang.String tableName)` Search for the specified table in this TAP metadata set.
`java.util.Iterator<TAPTable>`	`getTables()` Get the list of all tables available in this TAP metadata set.
`java.lang.String`	`getXSLTPath()` Gets the path/URL of the XSLT style-sheet to use.
`boolean`	`hasSchema(java.lang.String schemaName)` Tell whether there is a schema with the given ADQL name.
`boolean`	`hasTable(java.lang.String tableName)` Tell whether this TAP metadata set contains a table with the given ADQL name, whatever is its schema.
`boolean`	`hasTable(java.lang.String schemaName, java.lang.String tableName)` Tell whether this TAP metadata set contains the specified table.
`void`	`init(javax.servlet.ServletConfig config)` Let initialize this TAP resource.
`boolean`	`isEmpty()` Tell whether this TAP metadata set contains no schema.
`java.util.Iterator<TAPSchema>`	`iterator()`
`void`	`removeAllSchemas()` Remove all schemas of this metadata set.
`TAPCoosys`	`removeCoosys(java.lang.String coosysId)` Remove the coordinate system declared with the given ID.
`TAPSchema`	`removeSchema(java.lang.String schemaName)` Remove the schema having the given ADQL name.
`static TAPMetadata.STDTable`	`resolveStdTable(java.lang.String tableName)` Tell whether the given table name is a standard TAP table.
`void`	`setTAPBaseURL(java.lang.String baseURL)` Let diffuse the base URL of the TAP service to all its TAP resources.
`void`	`setXSLTPath(java.lang.String path)` Sets the path/URL of the XSLT style-sheet to use.
`void`	`write(java.io.PrintWriter writer)` Format in XML this whole metadata set and write it in the given writer.
`protected void`	`writeAtt(java.lang.String prefix, java.lang.String attributeName, java.lang.String attributeValue, boolean isOptionalAttr, java.io.PrintWriter writer)` Write the specified metadata attribute as a simple XML node.
`protected void`	`writeColumn(TAPColumn c, java.io.PrintWriter writer)` Format in XML the given column and then write it in the given writer.
`protected void`	`writeForeignKey(TAPForeignKey fk, java.io.PrintWriter writer)` Format in XML the given foreign key and then write it in the given writer.
`protected void`	`writeSchema(TAPSchema s, java.io.PrintWriter writer)` Format in XML the given schema and then write it in the given writer.
`protected int`	`writeTable(TAPTable t, java.io.PrintWriter writer)` Format in XML the given table and then write it in the given writer.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Field Detail
  - RESOURCE_NAME
```
public static final java.lang.String RESOURCE_NAME
```
    Resource name of the TAP metadata. This name is also used - in this class - in the TAP URL to identify this resource. Here it corresponds to the following URI: ".../tables".
    
    See Also:
    
    Constant Field Values
  - schemas
```
protected final java.util.Map<java.lang.String,TAPSchema> schemas
```
    List of all schemas available through the TAP service.
  - coordinateSystems
```
protected final java.util.Map<java.lang.String,TAPCoosys> coordinateSystems
```
    List of all coordinate systems used by columns published in the TAP_SCHEMA.
    
    Since:
    
    2.1
  - accessURL
```
protected java.lang.String accessURL
```
    Part of the TAP URI which identify this TAP resource. By default, it is the resource name ; so here, the corresponding TAP URI would be: "/tables".
  - xsltPath
```
protected java.lang.String xsltPath
```
    The path of the XSLT style-sheet to apply.
    
    Since:
    
    2.1
- Constructor Detail
  - TAPMetadata
```
public TAPMetadata()
```
    Build an empty list of metadata.
    
    Note: By default, a TAP service must have at least a TAP_SCHEMA schema which contains a set of 5 tables (schemas, tables, columns, keys and key_columns). This schema is not created here by default because it can be customized by the service implementor. Besides, the DB name may be different. However, you can easily get this schema thanks to the function getStdSchema(boolean) which returns the standard definition of this schema (including all tables and columns described by the standard). For a standard definition of this schema, you can then write the following:
```
 TAPMetadata meta = new TAPMetadata();
 meta.addSchema(TAPMetadata.getStdSchema());
 
```
    Of course, this schema (and its tables and their columns) can be customized after if needed. Otherwise, if you want customize just some part of this schema, you can also use the function getStdTable(STDTable) to get just the standard definition of some of its tables, either to customize them or to merely get them and keep them like they are.
- Method Detail
  - getXSLTPath
```
public final java.lang.String getXSLTPath()
```
    Gets the path/URL of the XSLT style-sheet to use.
    
    Returns:
    
    XSLT path/url.
    
    Since:
    
    2.1
  - setXSLTPath
```
public final void setXSLTPath(java.lang.String path)
```
    Sets the path/URL of the XSLT style-sheet to use.
    
    Parameters:
    
    path - The new XSLT path/URL.
    
    Since:
    
    2.1
  - addSchema
```
public final void addSchema(TAPSchema s)
```
    Add the given schema inside this TAP metadata set.
    
    Note: If the given schema is NULL, nothing will be done.
    
    Parameters:
    
    s - The schema to add.
  - addSchema
```
public TAPSchema addSchema(java.lang.String schemaName)
```
    Build a new TAPSchema object with the given ADQL name. Then, add it inside this TAP metadata set.
    
    Note: The built TAPSchema object is returned, so that being modified afterwards if needed.
    
    Parameters:
    
    schemaName - ADQL name of the schema to create and add inside this TAP metadata set.
    
    Returns:
    
    The created and added schema, or NULL if the given schema is NULL or an empty string.
    
    See Also:
    
    TAPSchema.TAPSchema(String), addSchema(TAPSchema)
  - addSchema
```
public TAPSchema addSchema(java.lang.String schemaName,
                           java.lang.String description,
                           java.lang.String utype)
```
    Build a new TAPSchema object with the given ADQL name. Then, add it inside this TAP metadata set.
    
    Note: The built TAPSchema object is returned, so that being modified afterwards if needed.
    
    Parameters:
    
    schemaName - ADQL name of the schema to create and add inside this TAP metadata set.
    
    description - Description of the new schema. MAY be NULL
    
    utype - UType associating the new schema with a data-model. MAY be NULL
    
    Returns:
    
    The created and added schema, or NULL if the given schema is NULL or an empty string.
    
    See Also:
    
    TAPSchema.TAPSchema(String, String, String), addSchema(TAPSchema)
  - hasSchema
```
public final boolean hasSchema(java.lang.String schemaName)
```
    Tell whether there is a schema with the given ADQL name.
    
    Important note: This function is case sensitive!
    
    Parameters:
    
    schemaName - ADQL name of the schema whose the existence must be checked.
    
    Returns:
    
    true if a schema with the given ADQL name exists, false otherwise.
  - getSchema
```
public final TAPSchema getSchema(java.lang.String schemaName)
```
    Search for a schema having the given ADQL name.
    
    Important note: This function is case sensitive!
    
    Parameters:
    
    schemaName - ADQL name of the schema to search.
    
    Returns:
    
    The schema having the given ADQL name, or NULL if no such schema can be found.
  - getNbSchemas
```
public final int getNbSchemas()
```
    Get the number of schemas contained in this TAP metadata set.
    
    Returns:
    
    Number of all schemas.
  - isEmpty
```
public final boolean isEmpty()
```
    Tell whether this TAP metadata set contains no schema.
    
    Returns:
    
    true if this TAP metadata set has no schema, false if it contains at least one schema.
  - removeSchema
```
public final TAPSchema removeSchema(java.lang.String schemaName)
```
    Remove the schema having the given ADQL name.
    
    Important note: This function is case sensitive!
    
    WARNING: If the goal of this function's call is to delete definitely the specified schema from the metadata, you SHOULD also call TAPTable.removeAllForeignKeys() on the removed table. Indeed, foreign keys of this table would still link the removed table with other tables AND columns of the whole metadata set.
    
    Parameters:
    
    schemaName - ADQL name of the schema to remove from this TAP metadata set.
    
    Returns:
    
    The removed schema, or NULL if no such schema can be found.
  - removeAllSchemas
```
public final void removeAllSchemas()
```
    Remove all schemas of this metadata set.
  - iterator
```
public final java.util.Iterator<TAPSchema> iterator()
```
    Specified by:
    
    iterator in interface java.lang.Iterable<TAPSchema>
  - getTables
```
public java.util.Iterator<TAPTable> getTables()
```
    Get the list of all tables available in this TAP metadata set.
    
    Returns:
    
    An iterator over the list of all tables contained in this TAP metadata set.
  - hasTable
```
public boolean hasTable(java.lang.String schemaName,
                        java.lang.String tableName)
```
    Tell whether this TAP metadata set contains the specified table.
    
    Note: This function is case sensitive!
    
    Parameters:
    
    schemaName - ADQL name of the schema owning the table to search.
    
    tableName - ADQL name of the table to search.
    
    Returns:
    
    true if the specified table exists, false otherwise.
  - hasTable
```
public boolean hasTable(java.lang.String tableName)
```
    Tell whether this TAP metadata set contains a table with the given ADQL name, whatever is its schema.
    
    Note: This function is case sensitive!
    
    Parameters:
    
    tableName - ADQL name of the table to search.
    
    Returns:
    
    true if the specified table exists, false otherwise.
  - getTable
```
public TAPTable getTable(java.lang.String schemaName,
                         java.lang.String tableName)
```
    Search for the specified table in this TAP metadata set.
    
    Note: This function is case sensitive!
    
    Parameters:
    
    schemaName - ADQL name of the schema owning the table to search.
    
    tableName - ADQL name of the table to search.
    
    Returns:
    
    The table which has the given ADQL name and which is inside the specified schema, or NULL if no such table can be found.
  - getTable
```
public java.util.List<DBTable> getTable(java.lang.String tableName)
```
    Search in this TAP metadata set for all tables whose the ADQL name matches the given one, whatever is their schema.
    
    Note: This function is case sensitive!
    
    Parameters:
    
    tableName - ADQL name of the tables to search.
    
    Returns:
    
    A list of all the tables which have the given ADQL name, or an empty list if no such table can be found.
  - getObsCoreTable
```
public TAPTable getObsCoreTable()
```
    Get the description of the ObsCore table, if it is defined.
    This function is case sensitive only on the schema name (i.e. ivoa) which must be defined in full lower case. The table name (i.e. ObsCore) will be found whatever the case it is written in and whether it is prefixed or not.
    
    Returns:
    
    Description of the ObsCore table, or NULL if this table is not provided by this TAP service.
    
    Since:
    
    2.1
  - getRegTAPSchema
```
public TAPSchema getRegTAPSchema()
```
    Get the description of the RegTAP schema, if it is defined.
    This function is case sensitive only on the schema name (i.e. rr) which must be defined in full lower case. The tables name (e.g. capability) will be searched case sensitively as well. However, it does not matter if the table name is prefixed or not.
    
    Returns:
    
    Description of the RegTAP schema, or NULL if RegTAP is not supported in this TAP service.
    
    Since:
    
    2.1
  - getNbTables
```
public int getNbTables()
```
    Get the number of all tables contained in this TAP metadata set.
    
    Returns:
    
    Number of all its tables.
  - getCoosys
```
public TAPCoosys getCoosys(java.lang.String coosysId)
```
    Get the coordinate system definition associated with the given ID.
    
    Parameters:
    
    coosysId - ID of the coordinate system to get. (case sensitive)
    
    Returns:
    
    The corresponding coordinate system definition, or NULL if no match for the given ID.
    
    Since:
    
    2.1
  - addCoosys
```
public TAPCoosys addCoosys(TAPCoosys newCoosys)
```
    Add the given coordinate system definition.
    Important: If a coordinate system with the same ID (case sensitive) is already declared in this TAPMetadata, it will be replaced by the given one. The replaced coordinate system is returned by this function.
    
    Parameters:
    
    newCoosys - The coordinate system definition to add.
    
    Returns:
    
    The coordinate system definition previously declared with the same ID in this TAPMetadata, or NULL if no coord. sys. was declared with this ID.
    
    Since:
    
    2.1
  - removeCoosys
```
public TAPCoosys removeCoosys(java.lang.String coosysId)
```
    Remove the coordinate system declared with the given ID.
    
    Parameters:
    
    coosysId - The ID of the coordinate system definition to remove.
    
    Returns:
    
    The removed coordinate system definition, or NULL if none is declared with the given ID.
    
    Since:
    
    2.1
  - getName
```
public java.lang.String getName()
```
    Description copied from interface: TAPResource
    
    Get the name of this TAP resource.
    
    Important note: This name MUST NOT be NULL and SHOULD NEVER change.
    
    Specified by:
    
    getName in interface TAPResource
    
    Returns:
    
    Name of this TAP resource.
  - setTAPBaseURL
```
public void setTAPBaseURL(java.lang.String baseURL)
```
    Description copied from interface: TAPResource
    
    Let diffuse the base URL of the TAP service to all its TAP resources.
    
    Important note: This function should be called just once: either at the creation of the service or when the first request is sent to the TAP service (in this case, the request is also used to finish the initialization of the TAP service, and of all its resources).
    
    Specified by:
    
    setTAPBaseURL in interface TAPResource
    
    Parameters:
    
    baseURL - Common URL/URI used in all requests sent by any user to the TAP service.
  - getAccessURL
```
public java.lang.String getAccessURL()
```
    Description copied from interface: VOSIResource
    
    Get the URL which lets access this resource.
    
    Specified by:
    
    getAccessURL in interface VOSIResource
    
    Returns:
    
    Access URL.
  - getCapability
```
public java.lang.String getCapability()
```
    Description copied from interface: VOSIResource
    
    Get the capabilities of this resource.
    
    Specified by:
    
    getCapability in interface VOSIResource
    
    Returns:
    
    Resource capabilities.
  - getStandardID
```
public java.lang.String getStandardID()
```
    Description copied from interface: VOSIResource
    Get the standardID of this endpoint of the VOSI interface.
    
    The standard IDs of the VOSI endpoints are the following:
    - Capabilities: ivo://ivoa.net/std/VOSI#capabilities
    - Availability: ivo://ivoa.net/std/VOSI#availability
    - Tables: ivo://ivoa.net/std/VOSI#tables
    Specified by:
    
    getStandardID in interface VOSIResource
    
    Returns:
    
    Standard ID of this VOSI endpoint.
  - init
```
public void init(javax.servlet.ServletConfig config)
          throws javax.servlet.ServletException
```
    Description copied from interface: TAPResource
    
    Let initialize this TAP resource.
    
    Specified by:
    
    init in interface TAPResource
    
    Parameters:
    
    config - Servlet configuration. (may be useful for the configuration of this resource)
    
    Throws:
    
    javax.servlet.ServletException - If any error prevent the initialization of this TAP resource. In case a such exception is thrown, the service should stop immediately.
  - destroy
```
public void destroy()
```
    Description copied from interface: TAPResource
    
    Let free properly all system/file/DB resources kept opened by this TAP resource.
    
    Specified by:
    
    destroy in interface TAPResource
  - executeResource
```
public boolean executeResource(javax.servlet.http.HttpServletRequest request,
                               javax.servlet.http.HttpServletResponse response)
                        throws java.io.IOException
```
    Description copied from interface: TAPResource
    
    Interpret the given request, execute the appropriate action and finally return a result or display information to the user.
    
    IMPORTANT: "TAP resources can not take the law in their own hands!" :-) Errors that could occur inside this function should not be written directly in the given HttpServletResponse. They should be thrown to the resources executor: an instance of TAP, which will fill the HttpServletResponse with the error in the format described by the IVOA standard - VOTable. Besides, TAP may also add more information and may log the error (in function of this type).
    
    Specified by:
    
    executeResource in interface TAPResource
    
    Parameters:
    
    request - Request sent by the user and which should be interpreted/executed here.
    
    response - Response in which the result of the request must be written.
    
    Returns:
    
    true if the request has been successfully executed, false otherwise (but generally an exception will be sent if the request can't be executed).
    
    Throws:
    
    java.io.IOException - If any error occurs while writing the result of the given request.
  - write
```
public void write(java.io.PrintWriter writer)
           throws java.io.IOException
```
    Format in XML this whole metadata set and write it in the given writer.
    
    Parameters:
    
    writer - Stream in which the XML representation of this metadata must be written.
    
    Throws:
    
    java.io.IOException - If there is any error while writing the XML in the given writer.
    
    Since:
    
    2.0
  - writeSchema
```
protected void writeSchema(TAPSchema s,
                           java.io.PrintWriter writer)
                    throws java.io.IOException
```
    Format in XML the given schema and then write it in the given writer.
    
    Written lines:
```
 <schema>
        <name>...</name>
        <title>...</title>
        <description>...</description>
        <utype>...</utype>
                // call #writeTable(TAPTable, PrintWriter) for each table
 </schema>
 
```
    Note: When NULL an attribute or a field is not written. Here this rule concerns: description and utype.
    Parameters:
    
    s - The schema to format and to write in XML.
    
    writer - Output in which the XML serialization of the given schema must be written.
    
    Throws:
    
    java.io.IOException - If the connection with the HTTP client has been either canceled or closed for another reason.
    
    See Also:
    
    writeTable(TAPTable, PrintWriter)
  - writeTable
```
protected int writeTable(TAPTable t,
                         java.io.PrintWriter writer)
```
    Format in XML the given table and then write it in the given writer.
    
    Written lines:
```
 <table type="...">
        <name>...</name>
        <title>...</title>
        <description>...</description>
        <utype>...</utype>
                // call #writeColumn(TAPColumn, PrintWriter) for each column
                // call #writeForeignKey(TAPForeignKey, PrintWriter) for each foreign key
 </table>
 
```
    Note 1: When NULL an attribute or a field is not written. Here this rule concerns: description and utype.
    
    Note 2: The PrintWriter buffer is flushed all the 10 columns. At that moment the writer is checked for errors. If the error flag is set, a ClientAbortException is thrown in order to stop the metadata writing. This is particularly useful if the metadata data is pretty large.
    Parameters:
    
    t - The table to format and to write in XML.
    
    writer - Output in which the XML serialization of the given table must be written.
    
    Returns:
    
    The total number of written columns.
  - writeColumn
```
protected void writeColumn(TAPColumn c,
                           java.io.PrintWriter writer)
```
    Format in XML the given column and then write it in the given writer.
    
    Written lines:
```
 <column std="true|false"> // the value of this field is TAPColumn#isStd()
        <name>...</name>
        <description>...</description>
        <unit>...</unit>
        <utype>...</utype>
        <ucd>...</ucd>
        <dataType xsi:type="vod:TAPType" size="...">...</dataType>
        <flag>indexed</flag> // if TAPColumn#isIndexed()
        <flag>primary</flag> // if TAPColumn#isPrincipal()
 </column>
 
```
    Note: When NULL an attribute or a field is not written. Here this rule concerns: description, unit, utype, ucd and flags.
    Parameters:
    
    c - The column to format and to write in XML.
    
    writer - Output in which the XML serialization of the given column must be written.
  - writeForeignKey
```
protected void writeForeignKey(TAPForeignKey fk,
                               java.io.PrintWriter writer)
```
    Format in XML the given foreign key and then write it in the given writer.
    
    Written lines:
```
 <foreignKey>
        <targetTable>...</targetTable>
        <fkColumn>
                <fromColumn>...</fromColumn>
                <targetColumn>...</targetColumn>
        </fkColumn>
        ...
        <description>...</description>
        <utype>...</utype>
 </foreignKey>
 
```
    Note: When NULL an attribute or a field is not written. Here this rule concerns: description and utype.
    Parameters:
    
    fk - The foreign key to format and to write in XML.
    
    writer - Output in which the XML serialization of the given foreign key must be written.
  - writeAtt
```
protected final void writeAtt(java.lang.String prefix,
                              java.lang.String attributeName,
                              java.lang.String attributeValue,
                              boolean isOptionalAttr,
                              java.io.PrintWriter writer)
```
    Write the specified metadata attribute as a simple XML node.
    
    Parameters:
    
    prefix - Prefix of the XML node. (generally, space characters)
    
    attributeName - Name of the metadata attribute to write (= Name of the XML node).
    
    attributeValue - Value of the metadata attribute (= Value of the XML node).
    
    isOptionalAttr - true if the attribute to write is optional (in this case, if the value is NULL or an empty string, the whole attribute item won't be written), false otherwise (here, if the value is NULL or an empty string, the XML item will be written with an empty string as value).
    
    writer - Output in which the XML node must be written.
  - getStdSchema
```
public static final TAPSchema getStdSchema(boolean isSchemaSupported)
```
    Get the definition of the whole standard TAP_SCHEMA. Thus, all standard TAP_SCHEMA tables (with all their columns) are also included in this object.
    
    Note: This function create the TAPSchema and all its TAPTables objects on the fly.
    
    Parameters:
    
    isSchemaSupported - false if the DB name must be prefixed by "TAP_SCHEMA_", true otherwise.
    
    Returns:
    
    The whole TAP_SCHEMA definition.
    
    Since:
    
    2.0
    
    See Also:
    
    TAPMetadata.STDSchema.TAPSCHEMA, TAPMetadata.STDTable, getStdTable(STDTable)
  getCoosysTable
  
  public static final TAPTable getCoosysTable()
  
  Get the minimum definition of the table TAP_SCHEMA.coosys as expected by the library (see JDBCConnection.getTAPSchema().
  
  Returns:
  
  The created definition of TAP_SCHEMA.coosys.
  
  Since:
  
  2.1
  
  getStdTable
  
  public static final TAPTable getStdTable(TAPMetadata.STDTable tableId)
  
  Get the definition of the specified standard TAP table.
  
  Important note: The returned table is not linked at all with a schema, on the contrary of getStdSchema(boolean) which returns tables linked with the returned schema. So, you may have to linked this table to schema (by using TAPSchema.addTable(TAPTable)) whose the ADQL name is TAP_SCHEMA after calling this function.
  
  Note: This function create the TAPTable object on the fly.
  
  Parameters:
  
  tableId - ID of the TAP table to return.
  
  Returns:
  
  The corresponding table definition (with no schema).
  
  Since:
  
  2.0
  
  resolveStdTable
  
  public static final TAPMetadata.STDTable resolveStdTable(java.lang.String tableName)
  
  Tell whether the given table name is a standard TAP table.
  
  Note: This function is case sensitive. Indeed TAP_SCHEMA tables are defined by the TAP standard by a given case. Thus, this case is expected here.
  
  Parameters:
  
  tableName - Unqualified table name.
  
  Returns:
  
  The corresponding TAPMetadata.STDTable or NULL if the given table is not part of the TAP standard.
  
  Since:
  
  2.0

Class TAPMetadata

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Field Detail

RESOURCE_NAME

schemas

coordinateSystems

accessURL

xsltPath

Constructor Detail

TAPMetadata

Method Detail

getXSLTPath

setXSLTPath

addSchema

addSchema

addSchema

hasSchema

getSchema

getNbSchemas

isEmpty

removeSchema

removeAllSchemas

iterator

getTables

hasTable

hasTable

getTable

getTable

getObsCoreTable

getRegTAPSchema

getNbTables

getCoosys

addCoosys

removeCoosys

getName

setTAPBaseURL

getAccessURL

getCapability

getStandardID

init

destroy

executeResource

write

writeSchema

writeTable

writeColumn

writeForeignKey

writeAtt

getStdSchema

getCoosysTable

getStdTable

resolveStdTable