uk.org.ogsadai.client.toolkit.activity
Class BaseResourceActivity

java.lang.Object
  uk.org.ogsadai.client.toolkit.activity.BaseActivity
      uk.org.ogsadai.client.toolkit.activity.BaseResourceActivity

All Implemented Interfaces:

Activity, RequestAndStatusHandler

Direct Known Subclasses:

AddDocuments, CreateFileIndex, CreateSubCollection, ExtractPhysicalSchemaToXML, ExtractTableSchema, GetAvailableTables, GetDocuments, ListDirectory, LookupIndexFile, QueryEPR, QueryRDFDB, ReadFromDataSink, ReadFromFile, ReadString, RemoveDocuments, RemoveSubCollection, SQLBag, SQLBulkLoadTuple, SQLNestedInClauseJoin, SQLNestedInClauseQuery, SQLParameterisedQuery, SQLParameterisedUpdate, SQLQuery, SQLResilient, SQLStatement, SQLUpdate, WriteToDataSource, XMLListCollections, XMLListResources, XPathQuery, XQuery, XUpdate

public abstract class BaseResourceActivity
extends BaseActivity

Abstract class that can be used for client toolkit resource-targeted activity implementations.

Author:

The OGSA-DAI project team

Constructor Summary

BaseResourceActivity(ActivityName activityName)
Constructor.

Method Summary

void	buildRequest(RequestBuilder builder) Builds a request by writing details to the given request builder.
ResourceID	getResourceID() Gets the ID of the resource the activity is targeted at.
void	setResourceID(ResourceID resourceID) Sets the ID of the resource the activity is targeted at.
void	setResourceID(java.lang.String resourceID) Sets the ID of the resource the activity is targeted at.
java.lang.String	toString()
protected void	validateState() Validates the state of the activity to ensure it has a complete and consistent set of inputs and outputs.

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

getActivityName, getConnectedOutputs, getErrorMessages, getInputDescriptors, getInputs, getInstanceName, getOutputs, getRequestAndStatusHandler, getServer, getStatus, getWarnings, hasErrorMessages, hasWarnings, processRequestStatus, setActivityName, setServer, validateIOState, writeToString

Methods inherited from class java.lang.Object

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

Constructor Detail

BaseResourceActivity

public BaseResourceActivity(ActivityName activityName)

Constructor.

Parameters:

activityName - the default activity name.

Method Detail

setResourceID

public void setResourceID(java.lang.String resourceID)

Sets the ID of the resource the activity is targeted at.

Parameters:

resourceID - resource ID.

setResourceID

public void setResourceID(ResourceID resourceID)

Sets the ID of the resource the activity is targeted at.

Parameters:

resourceID - resource ID.

getResourceID

public ResourceID getResourceID()

Gets the ID of the resource the activity is targeted at.

Returns:

resource name.

buildRequest

public void buildRequest(RequestBuilder builder)
                  throws ActivityIllegalStateException

Description copied from interface: RequestAndStatusHandler

Builds a request by writing details to the given request builder.

Specified by:

buildRequest in interface RequestAndStatusHandler

Overrides:

buildRequest in class BaseActivity

Parameters:

builder - request builder user to build the request.

Throws:

ActivityIllegalStateException - if the request cannot be built because an activity is in an illegal state.

toString

public java.lang.String toString()

Overrides:

toString in class BaseActivity

validateState

protected void validateState()
                      throws ActivityIllegalStateException

Description copied from class: BaseActivity

Validates the state of the activity to ensure it has a complete and consistent set of inputs and outputs.

Overrides:

validateState in class BaseActivity

Throws:

ActivityIllegalStateException - if the activity is not in a valid state.