com.asakusafw.vocabulary.flow.graph

Class InputDescription

java.lang.Object

com.asakusafw.vocabulary.flow.graph.InputDescription

All Implemented Interfaces:

FlowElementAttributeProvider, FlowElementDescription

public class InputDescription
extends Object
implements FlowElementDescription

A description of flow input.

Field Summary

Fields

Modifier and Type	Field and Description
static String	OUTPUT_PORT_NAME The port name.

Constructor Summary

Constructors

Constructor and Description
InputDescription(String name, ImporterDescription importer) Creates a new instance.
InputDescription(String name, Type type) 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() Returns the data type of this input.
ImporterDescription	getImporterDescription() Returns the importer description of this input.
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<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

Field Detail

OUTPUT_PORT_NAME

public static final String OUTPUT_PORT_NAME

The port name.

See Also:

Constant Field Values

Constructor Detail

InputDescription

public InputDescription(String name,
                        Type type)

Creates a new instance.

Parameters:

name - the input name

type - the data type

Throws:

IllegalArgumentException - if some parameters are null

InputDescription

public InputDescription(String name,
                        ImporterDescription importer)

Creates a new instance.

Parameters:

name - the input name

importer - the importer description of this input

Throws:

IllegalArgumentException - if some parameters are null

Method Detail

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

getImporterDescription

public ImporterDescription getImporterDescription()

Returns the importer description of this input.

Returns:

the importer description, or null if this input is not external

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

getDataType

public Type getDataType()

Returns the data type of this input.

Returns:

the data type

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

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