org.embl.ebi.escience.scuflworkers.java
Interface LocalWorker

All Known Subinterfaces:
LocalWorkerWithPorts
All Known Implementing Classes:
AbstractEFetchWorker, AbstractNCBIWorker, AskWorker, BlastParserWorker, ByteArrayToString, ChooseWorker, ConcatenateFileListWorker, CreateMobyCollection, CreateMobyData, CreateMobyData, CreateMobySimple, DataRangeColumnTask, DataRangeTask, DecodeBase64, DelimitedFileReader, EchoList, EFetchWorker, EMBLParserWorker, EmitLotsOfStrings, EncodeBase64, EntrezGeneWorker, EntrezProteinWorker, EnvVariableWorker, ExcelFileReader, ExtractImageLinks, ExtractMobyData, ExtractMobyData, FailIfFalse, FailIfTrue, FastaWorker, FileFormatIDWorker, FileListByExtTask, FileListByRegexTask, FilterStringList, FlattenList, GenBankParserWorker, GetLSID, HomoloGeneWorker, ImageReader, ImageWriter, INSDSeqXMLWorker, JTidyWorker, LocalCommand, LocusLinkWorker, NucleotideFastaWorker, NucleotideGBSeqWorker, NucleotideINSDSeqXMLWorker, NucleotideTinySeqXMLWorker, NucleotideXMLWorker, OMIMWorker, PadNumber, PostWorker, ProteinFastaWorker, ProteinGBSeqWorker, ProteinINSDSeqXMLWorker, ProteinTinySeqXMLWorker, PubMedEFetchWorker, PubMedESearchWorker, PubMedSearchWorker, ReadFilesFromDirectory, RegexFileWorker, RegularExpressionStringList, ReverseCompWorker, RotateImageWorker, ScaleImageWorker, SelectFileWorker, SelectWorker, SendEmail, SliceList, SNPWorker, SplitByRegex, SQLQueryWorker, SQLUpdateWorker, StringConcat, StringListMerge, StringSetDifference, StringSetIntersection, StringSetUnion, StringStripDuplicates, SwissProtParserWorker, TellWorker, TestAlwaysFailingProcessor, TestSometimesFails, TextFileReader, TextFileWriter, TranscribeWorker, TranslateWorker, VelocityFileWriter, WarnWorker, WebImageFetcher, WebPageFetcher, XMLInputSplitter, XMLOutputSplitter, XPathTextWorker, XPathWorker, XQueryWorker, XSLTWorker

public interface LocalWorker

Implemented by classes acting as local services and which don't require the full invocation infrastructure.

Author:
Tom Oinn

Field Summary
static java.lang.String BINARY
          Type string for arbitrary binary data
static java.lang.String BINARY_ARRAY
          Type string for an array of arbitrary binary data blocks
static java.lang.String HTML
          Type string for a document in HTML format
static java.lang.String HTML_ARRAY
          Type string for an array of documents in HTML format
static java.lang.String PNG_IMAGE
          Type string for a PNG image
static java.lang.String PNG_IMAGE_ARRAY
          Type string for an array of PNG images
static java.lang.String STRING
          Type string for a string object
static java.lang.String STRING_ARRAY
          Type string for an array of string objects
static java.lang.String UNTYPED
          Type string for a single item of unknown type
static java.lang.String UNTYPED_ARRAY
          Type string for an array of items of unknown type
 
Method Summary
 java.util.Map execute(java.util.Map inputMap)
          Given a Map of DataThing objects as input, invoke the underlying logic of the task and return a map of DataThing objects as outputs, with the port names acting as keys in the map in both cases.
 java.lang.String[] inputNames()
          Get an array of the names of input ports for this processor
 java.lang.String[] inputTypes()
          Get an array of the string types for the inputs defined by the inputNames() method, these should probably use the constants defined in this interface but may use any valid Baclava data type specifier.
 java.lang.String[] outputNames()
          Names of the output ports
 java.lang.String[] outputTypes()
          Types of the output ports
 

Field Detail

STRING

static final java.lang.String STRING
Type string for a string object

See Also:
Constant Field Values

STRING_ARRAY

static final java.lang.String STRING_ARRAY
Type string for an array of string objects

See Also:
Constant Field Values

PNG_IMAGE

static final java.lang.String PNG_IMAGE
Type string for a PNG image

See Also:
Constant Field Values

PNG_IMAGE_ARRAY

static final java.lang.String PNG_IMAGE_ARRAY
Type string for an array of PNG images

See Also:
Constant Field Values

HTML

static final java.lang.String HTML
Type string for a document in HTML format

See Also:
Constant Field Values

HTML_ARRAY

static final java.lang.String HTML_ARRAY
Type string for an array of documents in HTML format

See Also:
Constant Field Values

BINARY

static final java.lang.String BINARY
Type string for arbitrary binary data

See Also:
Constant Field Values

BINARY_ARRAY

static final java.lang.String BINARY_ARRAY
Type string for an array of arbitrary binary data blocks

See Also:
Constant Field Values

UNTYPED

static final java.lang.String UNTYPED
Type string for a single item of unknown type

See Also:
Constant Field Values

UNTYPED_ARRAY

static final java.lang.String UNTYPED_ARRAY
Type string for an array of items of unknown type

See Also:
Constant Field Values
Method Detail

execute

java.util.Map execute(java.util.Map inputMap)
                      throws TaskExecutionException
Given a Map of DataThing objects as input, invoke the underlying logic of the task and return a map of DataThing objects as outputs, with the port names acting as keys in the map in both cases.

Throws:
TaskExecutionException - thrown if there is an error during invocation of the task.

inputNames

java.lang.String[] inputNames()
Get an array of the names of input ports for this processor


inputTypes

java.lang.String[] inputTypes()
Get an array of the string types for the inputs defined by the inputNames() method, these should probably use the constants defined in this interface but may use any valid Baclava data type specifier.


outputNames

java.lang.String[] outputNames()
Names of the output ports


outputTypes

java.lang.String[] outputTypes()
Types of the output ports