uk.org.ogsadai.activity
Interface Activity

All Known Subinterfaces:

ConfigurableActivity, ResourceActivity

All Known Implementing Classes:

ActivityBase, ActivityInputListenerActivity, ActivityUserErrorProducerActivity, AddDocumentsActivity, ApplyActivity, AttributeStatisticsActivity, BlockCountActivity, ByteArraysResizeActivity, ByteArraysToTupleActivity, CalculateMeanActivity, CharArraysResizeActivity, CharArraysToDOMActivity, CloneableObjectProducerActivity, ControlledRepeatActivity, CounterActivity, CreateAnalyzerActivity, CreateDataSinkActivity, CreateDataSourceActivity, CreateDQPResourceActivity, CreateFileIndexActivity, CreateMapperActivity, CreateRelationalResourceActivity, CreateResourceActivityBase, CreateResourceGroupActivity, CreateSubCollectionActivity, CSVToTupleActivity, DeliverToDataSinkActivity, DeliverToFTPActivity, DeliverToFTPActivityWithNesting, DeliverToNullActivity, DeliverToRequestStatusActivity, DeliverToSessionActivity, DeliverToSMTPActivity, DOMToCharArraysActivity, DQPPatternActivity, EchoActivity, EndIfActivity, EPRQueryActivity, EventfulActivity, ExtendedCreateRelationalResourceActivity, ExtractPhysicalSchemaToXMLActivity, ExtractTableSchemaActivity, ExtractTableSchemaActivity, ExtractTableSchemaActivity, FilteredSQLQueryActivity, GenerateTupleMetadataActivity, GenericActivity, GenericTupleJoinActivity, GenericTupleTransformActivity, GetAvailableTablesActivity, GetAvailableTablesActivity, GetDataSinkResourceActivity, GetDataSourceResourceActivity, GetDocumentsActivity, GroupByActivity, HashCodeActivity, HeadActivity, IfEmptyListActivity, InsertMetadataActivity, IterativeActivity, ListConcatenateActivity, ListControlledRepeatActivity, ListDirectoryActivity, ListMultiplyActivity, ListRandomSplitActivity, ListRemoveActivity, ListSplitActivity, LookupIndexFileActivity, MatchedIterativeActivity, MatchedIterativeMultipleInputActivity, MatchedNestedIterativeActivity, MetadataRenameActivity, NumberToStringActivity, ObtainFromDataSourceActivity, ObtainFromFTPActivity, ObtainFromHTTPActivity, ObtainFromSessionActivity, OneTupleOnlyActivity, PipelinedTupleJoinActivity, RandomSplitActivity, RandomTableScanActivity, RDFDBQueryActivity, ReadFromDataSinkActivity, ReadFromFileActivity, ReadStringActivity, RemoteAsynchSQLQueryActivity, RemoveDocumentsActivity, RemoveSubCollectionActivity, ReplaceWithValueActivity, SleepActivity, SortedTupleListDifferenceActivity, SplitActivity, SQLApplyBindingsActivity, SQLBagActivity, SQLBulkLoadTupleActivity, SQLNestedInClauseJoinActivity, SQLNestedInClauseQueryActivity, SQLParameterisedQueryActivity, SQLParameterisedUpdateActivity, SQLQueryActivity, SQLQueryActivity, SQLResilientActivity, SQLStatementActivity, SQLUpdateActivity, SQLViewQueryActivity, StringConcatenateActivity, StringReplaceActivity, StringTokenizeActivity, SummaryTupleToKMLPlacemarksActivity, TableMetadataToXMLCharArraysListActivity, TeeActivity, TimestampActivity, ToSingleListActivity, ToSingleListActivity, TupleAntiJoinActivity, TupleArithmeticProjectActivity, TupleArithmeticSampleActivity, TupleJoinActivity, TupleMergeJoinActivity, TupleProductActivity, TupleProjectByIDSActivity, TupleProjectionActivity, TupleSelectActivity, TupleSemiJoinActivity, TupleSimpleMergeActivity, TupleSortActivity, TupleSplitActivity, TupleToByteArraysActivity, TupleToCSVActivity, TupleToKMLPlacemarksActivity, TupleToWebRowSetCharArraysActivity, TupleUnionAllActivity, WebRowSetCharacterDataToTupleActivity, WriteToDataSourceActivity, XMLListCollectionsActivity, XMLListResourcesActivity, XPathQueryActivity, XQueryActivity, XSLTransformActivity, XUpdateActivity

public interface Activity

An activity encapsulates an operation of some kind that typically involves consumption or production of data. For example, an activity may query a data source and produce a stream of result tuples.

Author:

The OGSA-DAI Project Team.

Method Summary

void	addInput(java.lang.String inputName, BlockReader input) Adds an input to the activity.
void	addOutput(java.lang.String outputName, BlockWriter output) Adds an output to the activity.
java.util.Set	getActivityContracts() Gets the set of the contracts satisfied by the activity.
ActivityDescriptor	getActivityDescriptor() Gets a description of the activity instance.
void	process() Processes the activity to completion.
void	setActivityDescriptor(ActivityDescriptor descriptor) Sets the activity descriptor for the activity instance.

Method Detail

getActivityContracts

java.util.Set getActivityContracts()

Gets the set of the contracts satisfied by the activity. An activity contract associates an activity with some well-defined semantics. There are Client Toolkit activity classes that understand particular contracts, so these can be used to operate any activity satisfying the correct contract.

Returns:

set of contract name strings or an empty set if the activity does not satisfy any particular contracts.

getActivityDescriptor

ActivityDescriptor getActivityDescriptor()

Gets a description of the activity instance.

Returns:

activity descriptor

process

void process()
             throws ActivityUserException,
                    ActivityProcessingException,
                    ActivityTerminatedException

Processes the activity to completion. This method blocks until the processing is complete.

Throws:

ActivityUserException - If the settings specified by the user prevent processing from completing.

ActivityProcessingException - If an internal error prevents processing from completing.

ActivityTerminatedException - If activity processing is terminated at an intermediate stage. This occurs when the thread processing the activity is interrupted.

setActivityDescriptor

void setActivityDescriptor(ActivityDescriptor descriptor)

Sets the activity descriptor for the activity instance.

Parameters:

descriptor - Description of the activity instance.

addInput

void addInput(java.lang.String inputName,
              BlockReader input)

Adds an input to the activity.

Parameters:

inputName - Name of the activity input.

input - Block reader for reading the input data from.

addOutput

void addOutput(java.lang.String outputName,
               BlockWriter output)

Adds an output to the activity.

Parameters:

outputName - Name of the activity output.

output - Block writer for writing the output data to.