com.asakusafw.vocabulary.flow.builder

Class FlowElementBuilder

java.lang.Object

com.asakusafw.vocabulary.flow.builder.FlowElementBuilder

Direct Known Subclasses:

FlowNodeBuilder, OperatorNodeBuilder

public abstract class FlowElementBuilder
extends Object

Builds operator graphs.

Since:

0.9.0

Version:

0.9.1

Constructor Summary

Constructors

Constructor and Description
FlowElementBuilder()

Method Summary

Modifier and Type	Method and Description
protected abstract FlowElementDescription	build(List<PortInfo> inputPorts, List<PortInfo> outputPorts, List<DataInfo> arguments, List<AttributeInfo> attributes) Builds a flow from operator input/output/arguments.
static FlowElementBuilder	createFlow(Class<? extends FlowDescription> flowDescriptionClass, Class<?>... constructorParameterTypes) Creates a new instance for flow description class.
static FlowElementBuilder	createOperator(Class<? extends Annotation> annotationType, Class<?> operatorClass, Class<?> implementationClass, String methodName, Class<?>... methodParameterTypes) Creates a new instance for operator method.
static FlowElementBuilder	createOperator(Class<? extends Annotation> annotationType, Class<?> operatorClass, String methodName, Class<?>... methodParameterTypes) Creates a new instance for operator method.
void	defineAttribute(Object attribute) Defines an attribute.
DataInfo	defineData(String name, Data data) Defines a new data for operator.
DataInfo	defineData(String name, Type type, Object value) Defines a new argument for operator.
PortInfo	defineInput(String name, Source<?> upstream) Defines a new input for operator.
PortInfo	defineInput(String name, Source<?> upstream, FlowElementAttribute... attributes) Defines a new input for operator.
PortInfo	defineOutput(String name, Source<?> typeRef) Defines a new output for operator.
PortInfo	defineOutput(String name, Source<?> typeRef, FlowElementAttribute... attributes) Defines a new output for operator.
PortInfo	defineOutput(String name, Type type) Defines a new output for operator.
PortInfo	defineOutput(String name, Type type, FlowElementAttribute... attributes) Defines a new output for operator.
FlowElementEditor	resolve() Resolves current operator input/output/arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowElementBuilder

public FlowElementBuilder()

Method Detail

createOperator

public static FlowElementBuilder createOperator(Class<? extends Annotation> annotationType,
                                                Class<?> operatorClass,
                                                String methodName,
                                                Class<?>... methodParameterTypes)

Creates a new instance for operator method.

Parameters:

annotationType - operator annotation type.

operatorClass - operator class

methodName - operator method name

methodParameterTypes - the operator method parameter types

Returns:

created builder

Throws:

IllegalArgumentException - if some parameters were null

createOperator

public static FlowElementBuilder createOperator(Class<? extends Annotation> annotationType,
                                                Class<?> operatorClass,
                                                Class<?> implementationClass,
                                                String methodName,
                                                Class<?>... methodParameterTypes)

Creates a new instance for operator method.

Parameters:

annotationType - operator annotation type.

operatorClass - operator class

implementationClass - operator implementation class

methodName - operator method name

methodParameterTypes - the operator method parameter types

Returns:

created builder

Throws:

IllegalArgumentException - if some parameters were null

createFlow

public static FlowElementBuilder createFlow(Class<? extends FlowDescription> flowDescriptionClass,
                                            Class<?>... constructorParameterTypes)

Creates a new instance for flow description class.

Parameters:

flowDescriptionClass - flow description class

constructorParameterTypes - constructor parameter types

Returns:

created builder

Throws:

IllegalArgumentException - if some parameters were null

defineInput

public PortInfo defineInput(String name,
                            Source<?> upstream)

Defines a new input for operator.

Parameters:

name - input name

upstream - upstream dataset

Returns:

defined port information

Throws:

IllegalArgumentException - if some parameters were null

defineInput

public PortInfo defineInput(String name,
                            Source<?> upstream,
                            FlowElementAttribute... attributes)

Defines a new input for operator.

Parameters:

name - input name

upstream - upstream dataset

attributes - the port attributes

Returns:

defined port information

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.9.1

defineOutput

public PortInfo defineOutput(String name,
                             Type type)

Defines a new output for operator.

Parameters:

name - output name

type - output type

Returns:

defined port information

Throws:

IllegalArgumentException - if some parameters were null

defineOutput

public PortInfo defineOutput(String name,
                             Source<?> typeRef)

Defines a new output for operator.

Parameters:

name - output name

typeRef - output type reference

Returns:

defined port information

Throws:

IllegalArgumentException - if some parameters were null

defineOutput

public PortInfo defineOutput(String name,
                             Type type,
                             FlowElementAttribute... attributes)

Defines a new output for operator.

Parameters:

name - output name

type - output type

attributes - the port attributes

Returns:

defined port information

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.9.1

defineOutput

public PortInfo defineOutput(String name,
                             Source<?> typeRef,
                             FlowElementAttribute... attributes)

Defines a new output for operator.

Parameters:

name - output name

typeRef - output type reference

attributes - the port attributes

Returns:

defined port information

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.9.1

defineData

public DataInfo defineData(String name,
                           Data data)

Defines a new data for operator.

Parameters:

name - the argument name

data - data representation

Returns:

defined data information

Throws:

IllegalArgumentException - if some parameters were null

defineData

public DataInfo defineData(String name,
                           Type type,
                           Object value)

Defines a new argument for operator.

Parameters:

name - the argument name

type - the value type

value - the constant value

Returns:

defined data information

Throws:

IllegalArgumentException - if some parameters were null

defineAttribute

public void defineAttribute(Object attribute)

Defines an attribute.

Parameters:

attribute - the attribute

Throws:

IllegalArgumentException - if some parameters were null

resolve

public FlowElementEditor resolve()

Resolves current operator input/output/arguments.

Returns:

the resolved information

Throws:

IllegalStateException - if failed to resolve the operator

build

protected abstract FlowElementDescription build(List<PortInfo> inputPorts,
                                                List<PortInfo> outputPorts,
                                                List<DataInfo> arguments,
                                                List<AttributeInfo> attributes)

Builds a flow from operator input/output/arguments.

Parameters:

inputPorts - list of operator input

outputPorts - list of operator output

arguments - list of operator argument

attributes - list of operator attribute

Returns:

the resolved information

Throws:

IllegalStateException - if failed to resolve the operator