com.asakusafw.vocabulary.flow.graph

Class FlowElementPortDescription

java.lang.Object

com.asakusafw.vocabulary.flow.graph.FlowElementPortDescription

All Implemented Interfaces:

FlowElementAttributeProvider

public class FlowElementPortDescription
extends Object
implements FlowElementAttributeProvider

A description of I/O port of flow elements.

Since:

0.1.0

Version:

0.9.1

Constructor Summary

Constructors

Constructor and Description
FlowElementPortDescription(String name, Type dataType, PortDirection direction) Creates a new instance.
FlowElementPortDescription(String name, Type dataType, PortDirection direction, ShuffleKey shuffleKey, FlowElementAttribute... attributes) Creates a new instance.
FlowElementPortDescription(String name, Type dataType, PortDirection direction, ShuffleKey shuffleKey, List<? extends FlowElementAttribute> attributes) Creates a new instance.
FlowElementPortDescription(String name, Type dataType, ShuffleKey shuffleKey) 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.
Type	getDataType() Return the data type of this port.
PortDirection	getDirection() Returns the port direction.
String	getName() Returns the port name.
ShuffleKey	getShuffleKey() Returns information of the shuffle operation which will performs on this port.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

FlowElementPortDescription

public FlowElementPortDescription(String name,
                                  Type dataType,
                                  PortDirection direction)

Creates a new instance.

Parameters:

name - the port name

dataType - the data type of the port

direction - the port direction

Throws:

IllegalArgumentException - if some parameters are null

FlowElementPortDescription

public FlowElementPortDescription(String name,
                                  Type dataType,
                                  ShuffleKey shuffleKey)

Creates a new instance.

Parameters:

name - the port name

dataType - the data type of the port

shuffleKey - information of the shuffle operation

Throws:

IllegalArgumentException - if some parameters are null

FlowElementPortDescription

public FlowElementPortDescription(String name,
                                  Type dataType,
                                  PortDirection direction,
                                  ShuffleKey shuffleKey,
                                  FlowElementAttribute... attributes)

Creates a new instance.

Parameters:

name - the port name

dataType - the data type of the port

direction - the port direction

shuffleKey - the shuffle key (nullable)

attributes - the attributes

Throws:

IllegalArgumentException - if some parameters are null

Since:

0.9.1

FlowElementPortDescription

public FlowElementPortDescription(String name,
                                  Type dataType,
                                  PortDirection direction,
                                  ShuffleKey shuffleKey,
                                  List<? extends FlowElementAttribute> attributes)

Creates a new instance.

Parameters:

name - the port name

dataType - the data type of the port

direction - the port direction

shuffleKey - the shuffle key (nullable)

attributes - the attributes

Throws:

IllegalArgumentException - if some parameters are null

Since:

0.9.1

Method Detail

getName

public String getName()

Returns the port name.

Returns:

the port name.

getDataType

public Type getDataType()

Return the data type of this port.

Returns:

the data type

getDirection

public PortDirection getDirection()

Returns the port direction.

Returns:

the port direction

getShuffleKey

public ShuffleKey getShuffleKey()

Returns information of the shuffle operation which will performs on this port.

Returns:

shuffle operation information, or null if this port does not support shuffle operations

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