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

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

public class ExtractPhysicalSchema

extends Activity

This activity supports the extraction of physical database schema-related information from a relational data service resource. This can either be for all tables or for a specific table only. The default is for all tables.

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

Author:

The OGSA-DAI Project Team

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 - default null

ExtractPhysicalSchema

public ExtractPhysicalSchema()

Constructor.

setTableName

public void setTableName(java.lang.String tableName)

Set the table name for which to retrieve the physical schema.

Parameters:

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

getOutput

public ActivityOutput getOutput()

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

Returns:

the activity output.

getAsDocument

public org.w3c.dom.Document getAsDocument()
                                   throws NoActivityOutputException,
                                          DataFormatException

Gets the sum of the values written to the input stream.

Returns:

sum of values written to input stream.

Throws:

NoActivityOutputException - if there is no output data or the data has not yet been processed to this output or the activity that generates this output has not yet been executed.

DataFormatException - if the output from the activity cannot be parsed into an XML document format.

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