com.asakusafw.vocabulary.flow.graph

Class FlowPartDescription

java.lang.Object

com.asakusafw.vocabulary.flow.graph.FlowPartDescription

All Implemented Interfaces:

FlowElementAttributeProvider, FlowElementDescription

public class FlowPartDescription
extends Object
implements FlowElementDescription

A description of flow-part.

Since:

0.1.0

Version:

0.9.1

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	FlowPartDescription.Builder A builder for building FlowPartDescription.
static class	FlowPartDescription.Parameter Represents a parameter and its argument for flow-part.

Constructor Summary

Constructors

Constructor and Description
FlowPartDescription(FlowGraph flowGraph) Creates a new instance.
FlowPartDescription(FlowGraph flowGraph, List<? extends FlowPartDescription.Parameter> parameters) 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<? extends Class<? extends FlowElementAttribute>>	getAttributeTypes() Returns the all available attribute types of this.
FlowGraph	getFlowGraph() Returns the flow-graph which represents this flow-part structure.
List<FlowElementPortDescription>	getInputPorts() Returns the input ports of this element.
FlowIn<?>	getInternalInputPort(FlowElementPortDescription externalInput) Returns the flow-inside input ports that individually corresponded to each flow-outside input port.
FlowOut<?>	getInternalOutputPort(FlowElementPortDescription externalOutput) Returns the flow-inside outputs ports that individually corresponded to each flow-outside output port.
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<FlowPartDescription.Parameter>	getParameters() Returns the parameters for this flow-part.
List<FlowResourceDescription>	getResources() Returns the external resources of this element.
void	setName(String newName) 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

FlowPartDescription

public FlowPartDescription(FlowGraph flowGraph)

Creates a new instance.

Parameters:

flowGraph - the flow-graph which represents this flow-part structure

Throws:

IllegalArgumentException - if the parameter is null

FlowPartDescription

public FlowPartDescription(FlowGraph flowGraph,
                           List<? extends FlowPartDescription.Parameter> parameters)

Creates a new instance.

Parameters:

flowGraph - the flow-graph which represents this flow-part structure

parameters - the parameters for this flow-part

Throws:

IllegalArgumentException - if some parameters were null

Since:

0.5.0

Method Detail

getFlowGraph

public FlowGraph getFlowGraph()

Returns the flow-graph which represents this flow-part structure.

Returns:

the flow-graph

getParameters

public List<FlowPartDescription.Parameter> getParameters()

Returns the parameters for this flow-part.

Returns:

the parameters

Since:

0.5.0

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

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 newName)

Description copied from interface: FlowElementDescription

Sets name of this element.

Specified by:

setName in interface FlowElementDescription

Parameters:

newName - 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

getInternalInputPort

public FlowIn<?> getInternalInputPort(FlowElementPortDescription externalInput)

Returns the flow-inside input ports that individually corresponded to each flow-outside input port. Note that each flow-inside port is a member of flow graph, on the other hand, each flow-outside port is a member of input ports of this element.

Parameters:

externalInput - flow-outside port

Returns:

the corresponded flow-inside port

Throws:

IllegalArgumentException - if the parameter is null

getInternalOutputPort

public FlowOut<?> getInternalOutputPort(FlowElementPortDescription externalOutput)

Returns the flow-inside outputs ports that individually corresponded to each flow-outside output port. Note that each flow-inside port is a member of flow graph, on the other hand, each flow-outside port is a member of output ports of this element.

Parameters:

externalOutput - flow-outside port

Returns:

the corresponded flow-inside port

Throws:

IllegalArgumentException - if the parameter is null

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

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

toString

public String toString()

Overrides:

toString in class Object