org.openjump.core.process

Class Process

java.lang.Object

org.openjump.core.process.Process

All Implemented Interfaces:

IOProcess

Direct Known Subclasses:

BufferFeatureCollection, BufferProcess, HelloWorldProcess, PrintObjectProcess, SystemPropertyProcess, UpperCaseProcess

public abstract class Process
extends java.lang.Object
implements IOProcess

Created by Michaël on 23/08/14.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	DEFAULT_OUTPUT
protected java.util.Map<java.lang.String,IParameter>	inputs
protected java.util.Map<java.lang.String,java.lang.Object>	outputs

Constructor Summary

Constructors

Constructor and Description
Process()
Process(java.util.Map<java.lang.String,Specification> inputSpecification)
Process(java.util.Map<java.lang.String,Specification> inputSpecification, java.util.Map<java.lang.String,Specification> outputSpecification)

Method Summary

Methods

Modifier and Type	Method and Description
Process	addInputSpecification(java.lang.String name, Specification specification) Add or replace an input specification as a parameter name and type.
Process	addOutputSpecification(java.lang.String name, Specification specification) Add or replace an input specification as a parameter name and type.
java.util.Map<java.lang.String,java.lang.Object>	checkInputs() Helper to check that parameters are valid in the process method
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.Object	getInputValue(java.lang.String name)
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.Class	getType()
java.lang.Object	getValue()
abstract java.lang.Object	process() Processes input parameters and return an object of type getType().
Process	setInput(java.lang.String name, IParameter value) Set an input parameter fo this process.
Process	setInput(java.lang.String name, java.lang.Object value) Helper method wrapping any object in a constant implementing IParameter.
void	setInputs(java.util.Map<java.lang.String,IParameter> parameters) Set input values as a Map
void	setName(java.lang.String name)
java.lang.String	toXml()

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_OUTPUT

public static java.lang.String DEFAULT_OUTPUT

inputs

protected java.util.Map<java.lang.String,IParameter> inputs

outputs

protected java.util.Map<java.lang.String,java.lang.Object> outputs

Constructor Detail

Process

public Process()

Process

public Process(java.util.Map<java.lang.String,Specification> inputSpecification)

Process

public Process(java.util.Map<java.lang.String,Specification> inputSpecification,
       java.util.Map<java.lang.String,Specification> outputSpecification)

Method Detail

getName

public java.lang.String getName()

Returns:

the name of this process

setName

public void setName(java.lang.String name)

addInputSpecification

public Process addInputSpecification(java.lang.String name,
                            Specification specification)

Add or replace an input specification as a parameter name and type.

Parameters:

name - name of the new parameter

specification - specification of the new parameter

addOutputSpecification

public Process addOutputSpecification(java.lang.String name,
                             Specification specification)

Add or replace an input specification as a parameter name and type.

Parameters:

name - name of the new parameter

specification - specification of the new parameter

getInputSpecification

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

Specification of input parameters.

Specified by:

getInputSpecification in interface IOProcess

Returns:

a map specifying input parameter specification.

getOutputSpecification

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

Specification of output parameters.

Specified by:

getOutputSpecification in interface IOProcess

Returns:

a map specifying input parameter specification.

setInput

public Process setInput(java.lang.String name,
               java.lang.Object value)
                 throws ProcessInputException

Helper method wrapping any object in a constant implementing IParameter.

Parameters:

name - of the parameter to set

value -

Returns:

this Process

Throws:

ProcessInputException - if name is not a valid parameter of this process

setInput

public Process setInput(java.lang.String name,
               IParameter value)
                 throws ProcessInputException

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.

Specified by:

setInput in interface IOProcess

Parameters:

name - name of the parameter

value - value of the parameter

Returns:

this Process

Throws:

ProcessInputException

getInput

public IParameter getInput(java.lang.String name)

Get a parameter by name.

Specified by:

getInput in interface IOProcess

Parameters:

name - of the parameter to retrieve

Returns:

a IParameter or null if name has not been set

getInputValue

public java.lang.Object getInputValue(java.lang.String name)
                               throws ProcessInputException

Throws:

ProcessInputException

getInputs

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

Returns:

parameter values as a Map

setInputs

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

Set input values as a Map

checkInputs

public java.util.Map<java.lang.String,java.lang.Object> checkInputs()
                                                             throws ProcessInputException

Helper to check that parameters are valid in the process method

Throws:

ProcessInputException

process

public abstract java.lang.Object process()
                                  throws ProcessException

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

Throws:

ProcessException

getType

public java.lang.Class getType()

Returns:

the type (Class) of the object returned by getValue.

getOutput

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

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

Specified by:

getOutput in interface IOProcess

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

getValue

public java.lang.Object getValue()

Returns:

the actual value of this object if this is a constant or returned value of this object if this is a IProcess.

getExceptions

public java.util.List<ProcessException> getExceptions()

Get exceptions thrown during process.

Specified by:

getExceptions in interface IOProcess

Returns:

a list of ProcessException

toXml

public java.lang.String toXml()
                       throws XmlMappingException

Throws:

XmlMappingException