de.grammarcraft.xtend.flow.unitlib

Class MapIt<InputType,OutputType>

java.lang.Object

de.grammarcraft.xtend.flow.unitlib.MapIt<InputType,OutputType>

All Implemented Interfaces:

FunctionUnitWithOnlyOneInputPort<InputType>, FunctionUnitWithOnlyOneOutputPort<OutputType>, IFunctionUnit

public class MapIt<InputType,OutputType>
extends java.lang.Object
implements IFunctionUnit, FunctionUnitWithOnlyOneInputPort<InputType>, FunctionUnitWithOnlyOneOutputPort<OutputType>

Constructor Summary

Constructors

Constructor and Description
MapIt(org.eclipse.xtext.xbase.lib.Functions.Function1<? super InputType,? extends OutputType> operation) Creates an operation unit in the sense of Flow Design which performs a mapping of input message to an output message by applying the given operation which must be a function.
MapIt(java.lang.String unitName, org.eclipse.xtext.xbase.lib.Functions.Function1<? super InputType,? extends OutputType> operation) Creates an operation unit in the sense of Flow Design which performs a mapping of input message to an output message by applying the given operation which must be a function.

Method Summary

Methods

Modifier and Type	Method and Description
void	forwardIntegrationError(java.lang.Exception ex) Method for forwarding an Exception in case an functional output port of that function unit has not been connected to an input port or a side effect closure
InputPort<InputType>	in()
OutputPort<java.lang.Exception>	integrationError()
void	operator_lessEqualsThan(org.eclipse.xtext.xbase.lib.Functions.Function0<? extends InputType> msgClosure) Flow DSL operator "<=" for forwarding a message value to the one and only input port for being processed. example:
void	operator_lessEqualsThan(InputType msg) Flow DSL operator "<=" for forwarding a message value to the one and only input port for being processed. example:
void	operator_mappedTo(FunctionUnitWithOnlyOneInputPort<OutputType> rightSideFunctionUnit) Flow DSL operator "->" for connecting two function units.
void	operator_mappedTo(InputPort<OutputType> foreignInputPort) Flow DSL operator "->" for connecting two function units.
void	operator_mappedTo(OutputPort<OutputType> rightSideFunctionUnitOutputPort) Flow DSL operator "->" for connecting two function units.
void	operator_mappedTo(org.eclipse.xtext.xbase.lib.Procedures.Procedure1<? super OutputType> closure) Flow DSL operator "->" for specifying an function units output message to be processed by a particular closure.
OutputPort<OutputType>	out()
InputPort<InputType>	theOneAndOnlyInputPort()
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

MapIt

public MapIt(org.eclipse.xtext.xbase.lib.Functions.Function1<? super InputType,? extends OutputType> operation)

Creates an operation unit in the sense of Flow Design which performs a mapping of input message to an output message by applying the given operation which must be a function.

Parameters:

operation - the function to be applied for mapping

MapIt

public MapIt(java.lang.String unitName,
     org.eclipse.xtext.xbase.lib.Functions.Function1<? super InputType,? extends OutputType> operation)

Creates an operation unit in the sense of Flow Design which performs a mapping of input message to an output message by applying the given operation which must be a function.

Parameters:

name - the function unit name to be used for this instance

operation - the function to be applied for mapping

Method Detail

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

in

public InputPort<InputType> in()

out

public OutputPort<OutputType> out()

theOneAndOnlyInputPort

public InputPort<InputType> theOneAndOnlyInputPort()

Specified by:

theOneAndOnlyInputPort in interface FunctionUnitWithOnlyOneInputPort<InputType>

Returns:

the one and only InputPort

integrationError

public OutputPort<java.lang.Exception> integrationError()

Specified by:

integrationError in interface IFunctionUnit

Returns:

the integration error port for forwarding Exceptions to in case an functional output port of that function unit has not been connected to an input port or a side effect closure

forwardIntegrationError

public void forwardIntegrationError(java.lang.Exception ex)

Description copied from interface: IFunctionUnit

Method for forwarding an Exception in case an functional output port of that function unit has not been connected to an input port or a side effect closure

Specified by:

forwardIntegrationError in interface IFunctionUnit

operator_lessEqualsThan

public void operator_lessEqualsThan(InputType msg)

Description copied from interface: FunctionUnitWithOnlyOneInputPort

Flow DSL operator "<=" for forwarding a message value to the one and only input port for being processed.
example:

   input <= "some string"
 

Specified by:

operator_lessEqualsThan in interface FunctionUnitWithOnlyOneInputPort<InputType>

Parameters:

msg - the message to be forwarded

operator_lessEqualsThan

public void operator_lessEqualsThan(org.eclipse.xtext.xbase.lib.Functions.Function0<? extends InputType> msgClosure)

Description copied from interface: FunctionUnitWithOnlyOneInputPort

Flow DSL operator "<=" for forwarding a message value to the one and only input port for being processed.
example:

   input <= [ if (state>0) "some string" else "some other string"
 

Specified by:

operator_lessEqualsThan in interface FunctionUnitWithOnlyOneInputPort<InputType>

Parameters:

msgClosure - the closure to be applied to compute the message to be forwarded

operator_mappedTo

public void operator_mappedTo(org.eclipse.xtext.xbase.lib.Procedures.Procedure1<? super OutputType> closure)

Description copied from interface: FunctionUnitWithOnlyOneOutputPort

Flow DSL operator "->" for specifying an function units output message to be processed by a particular closure. Typically this is used to process the message for a side effect like printing on standard out. example:

   fu -> [msg|println("message received: " + msg")]
 

Specified by:

operator_mappedTo in interface FunctionUnitWithOnlyOneOutputPort<OutputType>

Parameters:

closure - the message processing closure

operator_mappedTo

public void operator_mappedTo(InputPort<OutputType> foreignInputPort)

Description copied from interface: FunctionUnitWithOnlyOneOutputPort

Flow DSL operator "->" for connecting two function units. The left one with only one output port, the right one with named input port.
example:

   fu -> fu'.input
 

Specified by:

operator_mappedTo in interface FunctionUnitWithOnlyOneOutputPort<OutputType>

Parameters:

foreignInputPort - the right side function unit's named input port

operator_mappedTo

public void operator_mappedTo(FunctionUnitWithOnlyOneInputPort<OutputType> rightSideFunctionUnit)

Description copied from interface: FunctionUnitWithOnlyOneOutputPort

Flow DSL operator "->" for connecting two function units. The left one with only one output port, right one with only one input port.
example:

   fu -> fu'
 

Specified by:

operator_mappedTo in interface FunctionUnitWithOnlyOneOutputPort<OutputType>

Parameters:

rightSideFunctionUnit - the right side function unit with only one input port

operator_mappedTo

public void operator_mappedTo(OutputPort<OutputType> rightSideFunctionUnitOutputPort)

Description copied from interface: FunctionUnitWithOnlyOneOutputPort

Flow DSL operator "->" for connecting two function units. The left one with only one output port, the right one with named output port.
This is normally only used in integrating function units for connecting an integrated function unit with an output port of the integrating function unit. example:

   fu -> .output
 

Specified by:

operator_mappedTo in interface FunctionUnitWithOnlyOneOutputPort<OutputType>

Parameters:

rightSideFunctionUnitOutputPort - the right side function unit's named output port