com.asakusafw.vocabulary.flow.graph

Class OperatorDescription

java.lang.Object

com.asakusafw.vocabulary.flow.graph.OperatorDescription

All Implemented Interfaces:

FlowElementAttributeProvider, FlowElementDescription

public class OperatorDescription
extends Object
implements FlowElementDescription

A description of user/code operator.

Since:

0.1.0

Version:

0.9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperatorDescription.Builder A builder for building OperatorDescription.
static class	OperatorDescription.Declaration Represents a declaration of operator.
static class	OperatorDescription.Parameter Represents a user parameter.

Constructor Summary

Constructors

Constructor and Description
OperatorDescription(FlowElementDescription origin, OperatorDescription.Declaration declaration, List<FlowElementPortDescription> inputPorts, List<FlowElementPortDescription> outputPorts, List<FlowResourceDescription> resources, List<OperatorDescription.Parameter> parameters, List<FlowElementAttribute> attributes) Creates a new instance.
OperatorDescription(OperatorDescription.Declaration declaration, List<FlowElementPortDescription> inputPorts, List<FlowElementPortDescription> outputPorts, List<FlowResourceDescription> resources, List<OperatorDescription.Parameter> parameters, List<FlowElementAttribute> attributes) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
<T extends FlowElementAttribute> T	getAttribute(Class<T> attributeClass) Returns the attribute of this.
Set<FlowElementAttribute>	getAttributes() Returns the attributes of the operator.
Set<? extends Class<? extends FlowElementAttribute>>	getAttributeTypes() Returns the all available attribute types of this.
OperatorDescription.Declaration	getDeclaration() Returns information of the operator declaration.
List<FlowElementPortDescription>	getInputPorts() Returns the input ports of this element.
FlowElementKind	getKind() Returns the kind of this element.
String	getName() Returns the name of this element.
FlowElementDescription	getOrigin() Returns the original description.
List<FlowElementPortDescription>	getOutputPorts() Returns the output ports of this element.
List<OperatorDescription.Parameter>	getParameters() Returns information of the user parameters.
List<FlowResourceDescription>	getResources() Returns the external resources of this element.
void	setName(String name) Sets name of this element.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorDescription

public OperatorDescription(OperatorDescription.Declaration declaration,
                           List<FlowElementPortDescription> inputPorts,
                           List<FlowElementPortDescription> outputPorts,
                           List<FlowResourceDescription> resources,
                           List<OperatorDescription.Parameter> parameters,
                           List<FlowElementAttribute> attributes)

Creates a new instance.

Parameters:

declaration - information of the operator declaration

inputPorts - information of the input ports

outputPorts - information of the output ports

resources - information of the external resources

parameters - information of the user parameters

attributes - the attributes

Throws:

IllegalArgumentException - if some parameters are null

OperatorDescription

public OperatorDescription(FlowElementDescription origin,
                           OperatorDescription.Declaration declaration,
                           List<FlowElementPortDescription> inputPorts,
                           List<FlowElementPortDescription> outputPorts,
                           List<FlowResourceDescription> resources,
                           List<OperatorDescription.Parameter> parameters,
                           List<FlowElementAttribute> attributes)

Creates a new instance.

Parameters:

origin - the original description (nullable)

declaration - information of the operator declaration

inputPorts - information of the input ports

outputPorts - information of the output ports

resources - information of the external resources

parameters - information of the user parameters

attributes - the attributes

Throws:

IllegalArgumentException - if some parameters are null

Since:

0.5.1

Method Detail

getKind

public FlowElementKind getKind()

Description copied from interface: FlowElementDescription

Returns the kind of this element.

Specified by:

getKind in interface FlowElementDescription

Returns:

the element kind

getOrigin

public FlowElementDescription getOrigin()

Description copied from interface: FlowElementDescription

Returns the original description.

Specified by:

getOrigin in interface FlowElementDescription

Returns:

the origin the original description

getDeclaration

public OperatorDescription.Declaration getDeclaration()

Returns information of the operator declaration.

Returns:

information of the operator declaration

getName

public String getName()

Description copied from interface: FlowElementDescription

Returns the name of this element.

Specified by:

getName in interface FlowElementDescription

Returns:

the name

setName

public void setName(String name)

Description copied from interface: FlowElementDescription

Sets name of this element.

Specified by:

setName in interface FlowElementDescription

Parameters:

name - the name

getInputPorts

public List<FlowElementPortDescription> getInputPorts()

Description copied from interface: FlowElementDescription

Returns the input ports of this element.

Specified by:

getInputPorts in interface FlowElementDescription

Returns:

the input ports

getOutputPorts

public List<FlowElementPortDescription> getOutputPorts()

Description copied from interface: FlowElementDescription

Returns the output ports of this element.

Specified by:

getOutputPorts in interface FlowElementDescription

Returns:

the output ports

getResources

public List<FlowResourceDescription> getResources()

Description copied from interface: FlowElementDescription

Returns the external resources of this element.

Specified by:

getResources in interface FlowElementDescription

Returns:

the external resources

getParameters

public List<OperatorDescription.Parameter> getParameters()

Returns information of the user parameters.

Returns:

information of the user parameters

getAttributeTypes

public Set<? extends Class<? extends FlowElementAttribute>> getAttributeTypes()

Description copied from interface: FlowElementAttributeProvider

Returns the all available attribute types of this.

Specified by:

getAttributeTypes in interface FlowElementAttributeProvider

Returns:

the available attribute types

getAttribute

public <T extends FlowElementAttribute> T getAttribute(Class<T> attributeClass)

Description copied from interface: FlowElementAttributeProvider

Returns the attribute of this.

Specified by:

getAttribute in interface FlowElementAttributeProvider

Type Parameters:

T - target class

Parameters:

attributeClass - target class

Returns:

attribute, or null if not defined

getAttributes

public Set<FlowElementAttribute> getAttributes()

Returns the attributes of the operator.

Returns:

the attributes

toString

public String toString()

Overrides:

toString in class Object