com.asakusafw.vocabulary.flow.graph

Class OperatorDescription.Builder

java.lang.Object

com.asakusafw.vocabulary.flow.graph.OperatorDescription.Builder

Enclosing class:

OperatorDescription

public static class OperatorDescription.Builder
extends Object

A builder for building OperatorDescription.

Since:

0.1.0

Version:

0.5.1

Constructor Summary

Constructors

Constructor and Description
Builder(Class<? extends Annotation> annotationType) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
OperatorDescription.Builder	addAttribute(FlowElementAttribute attribute) Adds an attribute.
OperatorDescription.Builder	addInput(String portName, Source<?> typeReference) Adds a new input port of the target operator.
OperatorDescription.Builder	addInput(String portName, Source<?> typeReference, ShuffleKey key) Adds a new input port of the target operator.
OperatorDescription.Builder	addInput(String portName, Type dataType) Adds a new input port of the target operator.
OperatorDescription.Builder	addInput(String portName, Type dataType, ShuffleKey key) Adds a new input port of the target operator.
OperatorDescription.Builder	addOutput(String portName, Source<?> typeReference) Adds a new output port of the target operator.
OperatorDescription.Builder	addOutput(String portName, Type dataType) Adds a new output port of the target operator.
OperatorDescription.Builder	addParameter(String parameterName, Type parameterType, Object argument) Adds a new user parameter.
OperatorDescription.Builder	addPort(FlowElementPortDescription description) Adds a new port of the target operator.
OperatorDescription.Builder	addResource(FlowResourceDescription resource) Adds a new external resource.
OperatorDescription.Builder	declare(Class<?> operatorClass, Class<?> implementorClass, String methodName) Sets information of operator method declaration.
OperatorDescription.Builder	declareParameter(Class<?> parameterType) Adds a parameter of the target operator method.
void	setOrigin(FlowElementDescription origin) Sets the original description for the building description.
OperatorDescription	toDescription() Creates a new description object from the previously information.
FlowElementResolver	toResolver() Creates a new FlowElementResolver object from the previously information.

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder(Class<? extends Annotation> annotationType)

Creates a new instance.

Parameters:

annotationType - the operator annotation type

Throws:

IllegalArgumentException - if the parameter is null

Method Detail

declare

public OperatorDescription.Builder declare(Class<?> operatorClass,
                                           Class<?> implementorClass,
                                           String methodName)

Sets information of operator method declaration. Note that, clients should use declareParameter(Class) to add method parameters.

Parameters:

operatorClass - the operator class

implementorClass - the implementation class

methodName - the operator method name

Returns:

this

Throws:

IllegalArgumentException - if some parameters are null

setOrigin

public void setOrigin(FlowElementDescription origin)

Sets the original description for the building description.

Parameters:

origin - the original description, or null if the building one is the origin

declareParameter

public OperatorDescription.Builder declareParameter(Class<?> parameterType)

Adds a parameter of the target operator method.

Parameters:

parameterType - the erased parameter type

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

addPort

public OperatorDescription.Builder addPort(FlowElementPortDescription description)

Adds a new port of the target operator.

Parameters:

description - the port description

Returns:

this

Since:

0.9.1

addInput

public OperatorDescription.Builder addInput(String portName,
                                            Type dataType)

Adds a new input port of the target operator.

Parameters:

portName - the port name

dataType - the data type

Returns:

this

Throws:

IllegalArgumentException - if some parameters are null

addInput

public OperatorDescription.Builder addInput(String portName,
                                            Source<?> typeReference)

Adds a new input port of the target operator.

Parameters:

portName - the port name

typeReference - a source that has the data type as same to the creating port

Returns:

this

Throws:

IllegalArgumentException - if some parameters are null

addInput

public OperatorDescription.Builder addInput(String portName,
                                            Type dataType,
                                            ShuffleKey key)

Adds a new input port of the target operator.

Parameters:

portName - the port name

dataType - the data type

key - information of the shuffle operation

Returns:

this

Throws:

IllegalArgumentException - if some parameters are null

addInput

public OperatorDescription.Builder addInput(String portName,
                                            Source<?> typeReference,
                                            ShuffleKey key)

Adds a new input port of the target operator.

Parameters:

portName - the port name

typeReference - a source that has the data type as same to the creating port

key - information of the shuffle operation

Returns:

this

Throws:

IllegalArgumentException - if some parameters are null

addOutput

public OperatorDescription.Builder addOutput(String portName,
                                             Type dataType)

Adds a new output port of the target operator.

Parameters:

portName - the port name

dataType - the data type

Returns:

this

Throws:

IllegalArgumentException - if some parameters are null

addOutput

public OperatorDescription.Builder addOutput(String portName,
                                             Source<?> typeReference)

Adds a new output port of the target operator.

Parameters:

portName - the port name

typeReference - a source that has the data type as same to the creating port

Returns:

this

Throws:

IllegalArgumentException - if some parameters are null

addResource

public OperatorDescription.Builder addResource(FlowResourceDescription resource)

Adds a new external resource.

Parameters:

resource - the external resource

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

addParameter

public OperatorDescription.Builder addParameter(String parameterName,
                                                Type parameterType,
                                                Object argument)

Adds a new user parameter.

Parameters:

parameterName - the parameter name

parameterType - the parameter value

argument - the actual parameter argument, or null if the argument is just null

Returns:

this

Throws:

IllegalArgumentException - if some parameters are null

addAttribute

public OperatorDescription.Builder addAttribute(FlowElementAttribute attribute)

Adds an attribute.

Parameters:

attribute - the attribute

Returns:

this

Throws:

IllegalArgumentException - if the parameter is null

toDescription

public OperatorDescription toDescription()

Creates a new description object from the previously information.

Returns:

the created description

toResolver

public FlowElementResolver toResolver()

Creates a new FlowElementResolver object from the previously information.

Returns:

the created object