org.openjump.core.process

Interface IOProcess

All Known Implementing Classes:

BufferFeatureCollection, BufferProcess, HelloWorldProcess, PrintObjectProcess, Process, SystemPropertyProcess, UpperCaseProcess

public interface IOProcess

IProcess where input and output values type is specifies.

Method Summary

Methods

Modifier and Type	Method and Description
java.util.List<ProcessException>	getExceptions() Get exceptions thrown during process.
IParameter	getInput(java.lang.String name) Get a parameter by name.
java.util.Map<java.lang.String,IParameter>	getInputs()
java.util.Map<java.lang.String,Specification>	getInputSpecification() Specification of input parameters.
java.lang.String	getName()
java.lang.Object	getOutput(java.lang.String name) Get an output parameter or thows an exception if this parameter does not exists.
java.util.Map<java.lang.String,Specification>	getOutputSpecification() Specification of output parameters.
java.lang.Object	process() Processes input parameters and return an object of type getType().
IOProcess	setInput(java.lang.String name, IParameter param) Set an input parameter fo this process.
void	setInputs(java.util.Map<java.lang.String,IParameter> inputs) Set input values as a Map

Methods inherited from interface org.openjump.core.process.IParameter

getType, getValue

Method Detail

getInputSpecification

java.util.Map<java.lang.String,Specification> getInputSpecification()

Specification of input parameters.

Returns:

a map specifying input parameter specification.

getOutputSpecification

java.util.Map<java.lang.String,Specification> getOutputSpecification()

Specification of output parameters.

Returns:

a map specifying input parameter specification.

setInput

IOProcess setInput(java.lang.String name,
                 IParameter param)
                   throws java.lang.Exception

Set an input parameter fo this process. Input parameter type must be consistant with this process input specifications. Input parameter nullity is not checked by setParameter as the parameter may be a process, and its value evaluation is deferred to the execution of process method.

Parameters:

name - name of the parameter

param - value of the parameter

Returns:

this Process

Throws:

java.lang.Exception

getInput

IParameter getInput(java.lang.String name)

Get a parameter by name.

Parameters:

name - of the parameter to retrieve

Returns:

a IParameter or null if name has not been set

getOutput

java.lang.Object getOutput(java.lang.String name)
                           throws ProcessOutputException

Get an output parameter or thows an exception if this parameter does not exists.

Parameters:

name - the name of the parameter to retrieve

Returns:

output value for this parameter

Throws:

ProcessOutputException - if name is not defined for this Process

getExceptions

java.util.List<ProcessException> getExceptions()

Get exceptions thrown during process.

Returns:

a list of ProcessException

getName

java.lang.String getName()

Returns:

the name of this process

getInputs

java.util.Map<java.lang.String,IParameter> getInputs()

Returns:

parameter values as a Map

setInputs

void setInputs(java.util.Map<java.lang.String,IParameter> inputs)

Set input values as a Map

process

java.lang.Object process()
                         throws ProcessException

Processes input parameters and return an object of type getType().

Throws:

ProcessException