uk.org.ogsadai.client.toolkit.activity.relational
Class ExtractDatabaseSchema

java.lang.Object
  |
  +--uk.org.ogsadai.client.toolkit.activity.RequestComponent
        |
        +--uk.org.ogsadai.client.toolkit.activity.Activity
              |
              +--uk.org.ogsadai.client.toolkit.activity.relational.ExtractDatabaseSchema

public class ExtractDatabaseSchema

extends Activity

This activity supports the extraction of database schema-related information from a relational data service resource. This can be either a list of the names of the relational tables or the tables plus associated metadata.

The default is that full metadata about all the tables is returned.

The activity has no inputs and one output - the requested information.

Author:

The OGSA-DAI Project Team

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
private java.lang.String	mCatalogName Catalog name
private java.lang.String	mSchemaName Schema name
private java.lang.String	mTableName Table name
private boolean	mTableNamesOnly Indicates whether table names or full table descriptions are to be retrieved - default false.

Fields inherited from class uk.org.ogsadai.client.toolkit.activity.Activity

Fields inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent

Constructor Summary

ExtractDatabaseSchema()
Constructor.

Method Summary

protected java.lang.String	generateXML() Generates the XML representing the activity.
ActivityOutput	getOutput() Gets the activity's only output - the requested database schema information.
void	getTableNamesOnly(boolean namesOnly) Specify whether to retrieve only table names or the complete table descriptions.
void	setCatalogName(java.lang.String catalog) Set the catalog name where the tables of interest reside.
void	setSchemaName(java.lang.String schemaName) Set the schema name where the tables of interest reside.
void	setTableName(java.lang.String tableName) Set the table name of a specific table for which to retrieve the logical schema.

Methods inherited from class uk.org.ogsadai.client.toolkit.activity.Activity

addInput, addOutput, addOutputs, getDataResourceID, getInputParameters, getOutputParameters, getOutputs, replaceSpecialCharacters, setDataResourceID, setInput

Methods inherited from class uk.org.ogsadai.client.toolkit.activity.RequestComponent

getDataService, getName, getSession, setDataService, setSession

Methods inherited from class java.lang.Object

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

Field Detail

COPYRIGHT_NOTICE

private static final java.lang.String COPYRIGHT_NOTICE

Copyright statement

See Also:

Constant Field Values

mTableName

private java.lang.String mTableName

Table name

mSchemaName

private java.lang.String mSchemaName

Schema name

mCatalogName

private java.lang.String mCatalogName

Catalog name

mTableNamesOnly

private boolean mTableNamesOnly

Indicates whether table names or full table descriptions are to be retrieved - default false.

Constructor Detail

ExtractDatabaseSchema

public ExtractDatabaseSchema()

Constructor.

Method Detail

setTableName

public void setTableName(java.lang.String tableName)

Set the table name of a specific table for which to retrieve the logical schema.

Parameters:

tableName - Name of the table. If null then the schema for all the tables will be returned.

setSchemaName

public void setSchemaName(java.lang.String schemaName)

Set the schema name where the tables of interest reside.

Parameters:

schemaName - Name of the schema

setCatalogName

public void setCatalogName(java.lang.String catalog)

Set the catalog name where the tables of interest reside.

Parameters:

catalog - Name of the catalog

getTableNamesOnly

public void getTableNamesOnly(boolean namesOnly)

Specify whether to retrieve only table names or the complete table descriptions.

Parameters:

namesOnly - true if table names only are to be retrieved else, false

getOutput

public ActivityOutput getOutput()

Gets the activity's only output - the requested database schema information.

Returns:

the activity output.

generateXML

protected java.lang.String generateXML()

Description copied from class: RequestComponent

Generates the XML representing the activity. This XML can then be inserted into a perform document that is sent to a data service.

Specified by:

generateXML in class Activity

Returns:

the XML for the activity