uk.ac.ncl.cs.instantsoap.stringprocessor
Class Map2StringProcessor

java.lang.Object
  uk.ac.ncl.cs.instantsoap.stringprocessor.Map2StringProcessor

All Implemented Interfaces:

MapProcessor

public class Map2StringProcessor
extends Object
implements MapProcessor

A MapProcessor that delegates on to a StringProcessor.

Author:

Cheng-Yang(Louis) Tang, Matthew Pocock

Constructor Summary

Map2StringProcessor(StringProcessor stringProcessor)
Create a new map processor that wraps the provided string processor.

Method Summary

MetaData	describeApplication(String appName) Describe an application.
Set<MetaData>	getInputs(String application) Get the inputs assocaited with an application.
Set<MetaData>	getOutputs(String appName) Get the outputs assocaited with an application.
StringProcessor	getStringProcessor() Get the string processor that this delegates all calls on to.
boolean	handlesApplication(String application) Indicates if this processor can handle applications with a particuar name.
List<String>	listApplications() List all of the applications handled, by name.
Map<String,String>	process(String application, Map<String,String> contents) Handle a request.
void	validate(String application, Map<String,String> contents) Validate the inputs for the application.

Methods inherited from class java.lang.Object

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

Constructor Detail

Map2StringProcessor

public Map2StringProcessor(StringProcessor stringProcessor)

Create a new map processor that wraps the provided string processor.

Parameters:

stringProcessor - the StringProcessor to wrap

Method Detail

getStringProcessor

public StringProcessor getStringProcessor()

Get the string processor that this delegates all calls on to.

Returns:

the StringProcessor delegate

handlesApplication

public boolean handlesApplication(String application)

Description copied from interface: MapProcessor

Indicates if this processor can handle applications with a particuar name.

This must return true for exactly those application names listed in listApplicaionts.

Specified by:

handlesApplication in interface MapProcessor

Parameters:

application - the name of the application to be checked

Returns:

true if the application can be handled, false otherwise

listApplications

public List<String> listApplications()

Description copied from interface: MapProcessor

List all of the applications handled, by name.

Specified by:

listApplications in interface MapProcessor

Returns:

the List of handled applications

describeApplication

public MetaData describeApplication(String appName)
                             throws UnknownApplicationException

Description copied from interface: MapProcessor

Describe an application.

Specified by:

describeApplication in interface MapProcessor

Parameters:

appName - the name of the application

Returns:

the MetaData with the name matching application providing the description and semantic annotation for this application

Throws:

UnknownApplicationException

process

public Map<String,String> process(String application,
                                  Map<String,String> contents)
                           throws JobExecutionException

Description copied from interface: MapProcessor

Handle a request.

Specified by:

process in interface MapProcessor

Parameters:

application - the name of the application

contents - the input Map

Returns:

the result of processing the request

Throws:

JobExecutionException

validate

public void validate(String application,
                     Map<String,String> contents)
              throws InvalidJobSpecificationException,
                     UnknownApplicationException

Description copied from interface: MapProcessor

Validate the inputs for the application.

Specified by:

validate in interface MapProcessor

Parameters:

application - the name of the application

contents - the Map of input values

Throws:

InvalidJobSpecificationException

UnknownApplicationException

getInputs

public Set<MetaData> getInputs(String application)
                        throws UnknownApplicationException

Description copied from interface: MapProcessor

Get the inputs assocaited with an application.

Specified by:

getInputs in interface MapProcessor

Parameters:

application - the name of the application

Returns:

the application inputs as a Set of MetaData instances

Throws:

UnknownApplicationException

getOutputs

public Set<MetaData> getOutputs(String appName)
                         throws UnknownApplicationException

Description copied from interface: MapProcessor

Get the outputs assocaited with an application.

Specified by:

getOutputs in interface MapProcessor

Parameters:

appName - the name of the application

Returns:

the application outputs as a Set of MetaData instances

Throws:

UnknownApplicationException