uk.org.ogsadai.activity.sql
Class SQLResultsToXMLActivity

java.lang.Object
  |
  +--uk.org.ogsadai.activity.Activity
        |
        +--uk.org.ogsadai.activity.sql.SQLResultsToXMLActivity

public class SQLResultsToXMLActivity

extends Activity

Implementation of SQL java.sql.ResultSet to WebRowSet conversion activity (sqlResultstoXML).

For information on this activity see the OGSA-DAI user doc: OGSA-DAI/doc/interaction/activities/relational/sqlResultsToXML.html

Author:

The OGSA-DAI Project Team.

Field Summary

private static java.lang.String	COPYRIGHT_NOTICE Copyright statement
static java.lang.String	FROM_ATTRIBUTE
private BlockReader	mInput Activity input - java.sql.ResultSet
private java.lang.String	mInputName Activity input name
private BlockWriter	mOutput Activity output - WebRowSet XML as java.lang.Strings
private java.lang.String	mOutputName Activity output name
private ResultSetConverter	mWebRowSetConvertor java.sql.ResultSet to WebRowSet converter
static java.lang.String	NAME_ATTRIBUTE
static java.lang.String	NULL_DATA_TAG
static java.lang.String	RESULT_SET_ELEMENT Constants for parsing activity XML
static java.lang.String	WEBROWSET_ELEMENT

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

mContext, mExternalInputs, mExternalOutputs, mInternalInputs, mInternalOutputs

Constructor Summary

SQLResultsToXMLActivity(org.w3c.dom.Element element)
Constructs an activity using the specified element.

Method Summary

private java.lang.String	getAsString(java.lang.Object obj) Gets an object as a string.
private java.lang.String	getOutParametersAsXML(java.util.Map params) Given a mapping from java.lang.Integer to java.lang.Object return an XML representation of the mapping.
void	initialise() This method should be overridden by subclasses to perform any initialisation they require before the process method invocations begin.
protected void	processBlock() Performs an iteration of the processing of an activity.
protected java.lang.String	replaceSpecialCharacters(java.lang.String input) Replaces the special characters in the given input with the equivalent predefined entities.

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

cleanUp, connectsTo, createOutputPipe, getActivityConfiguration, getActivityName, getCause, getName, getObservableStatus, getProperties, getSession, getStatus, hasActivityConfiguration, hasProperties, process, processFirst, setActivityName, setCompleted, setError

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

RESULT_SET_ELEMENT

public static final java.lang.String RESULT_SET_ELEMENT

Constants for parsing activity XML

See Also:

Constant Field Values

WEBROWSET_ELEMENT

public static final java.lang.String WEBROWSET_ELEMENT

See Also:

Constant Field Values

FROM_ATTRIBUTE

public static final java.lang.String FROM_ATTRIBUTE

See Also:

Constant Field Values

NAME_ATTRIBUTE

public static final java.lang.String NAME_ATTRIBUTE

See Also:

Constant Field Values

NULL_DATA_TAG

public static final java.lang.String NULL_DATA_TAG

See Also:

Constant Field Values

mInputName

private java.lang.String mInputName

Activity input name

mInput

private BlockReader mInput

Activity input - java.sql.ResultSet

mOutputName

private java.lang.String mOutputName

Activity output name

mOutput

private BlockWriter mOutput

Activity output - WebRowSet XML as java.lang.Strings

mWebRowSetConvertor

private ResultSetConverter mWebRowSetConvertor

java.sql.ResultSet to WebRowSet converter

Constructor Detail

SQLResultsToXMLActivity

public SQLResultsToXMLActivity(org.w3c.dom.Element element)
                        throws ActivitySpecificationException,
                               ActivityCreationException

Constructs an activity using the specified element.

Parameters:

element - Element to configure the activity with - from a perform document.

Throws:

ActivityCreationException - If there is a problem constructing the activity.

ActivitySpecificationException - If there is a problem constructing the activity due to an invalid setting in element.

See Also:

uk.org.ogsadai.activity

Method Detail

initialise

public void initialise()
                throws ActivitySpecificationException,
                       ActivityExecutionException

Description copied from class: Activity

This method should be overridden by subclasses to perform any initialisation they require before the process method invocations begin. This might be used for setting up convenient fields to reference objects contained in the context. It shouldn't be used for opening resources. That should be done in processFirst.

Overrides:

initialise in class Activity

Throws:

ActivityExecutionException - If some system problem prevents the activity from initialising.

ActivitySpecificationException - If a problem with settings provided by a client prevents the activity from initialising.

processBlock

protected void processBlock()

Description copied from class: Activity

Performs an iteration of the processing of an activity. This may involve reading a block of input data and writing a block of output data, or may involve some other kind of processing. When an activity is processed by the OGSA-DAI engine, this method will be invoked repeatedly until the activity either completes or stops due to an error or termination call. An implementation of this method should invoke the setCompleted method to indicate that processing is complete, or the setError method if an error occurs that will prevent the processing from completing.

Specified by:

processBlock in class Activity

getOutParametersAsXML

private java.lang.String getOutParametersAsXML(java.util.Map params)
                                        throws java.sql.SQLException,
                                               java.io.IOException

Given a mapping from java.lang.Integer to java.lang.Object return an XML representation of the mapping.

Parameters:

params - The mapping to convert.

Returns:

output parameters as XML

Throws:

java.sql.SQLException - If problems arise when converting java.sql objects.

java.io.IOException - If problems arise converting java.sql.Blob or java.sql.Clob objects.

See Also:

getAsString(java.lang.Object)

getAsString

private java.lang.String getAsString(java.lang.Object obj)
                              throws java.sql.SQLException,
                                     java.io.IOException

Gets an object as a string. The method handles null, java.sql.Blob and java.sql.Clob, java.sql.Date and java.sql.Time as special cases.

Parameters:

obj - Object to convert.

Returns:

string representation

Throws:

java.sql.SQLException - If problems arise when converting java.sql objects.

java.io.IOException - If problems arise converting java.sql.Blob or java.sql.Clob objects.

See Also:

replaceSpecialCharacters(java.lang.String)

replaceSpecialCharacters

protected java.lang.String replaceSpecialCharacters(java.lang.String input)

Replaces the special characters in the given input with the equivalent predefined entities.

Parameters:

input - String to process

Returns:

the input string, with special characters replaced by the equivalent predefined entities.