com.asakusafw.operator.model

Class OperatorDescription

java.lang.Object

com.asakusafw.operator.model.OperatorDescription

All Implemented Interfaces:

AttributeContainer

public class OperatorDescription
extends Object
implements AttributeContainer

Represents an operator's semantics for Asakusa DSL.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	OperatorDescription.Document Represents document.
static class	OperatorDescription.ExternalDocument Represents a document provided by an external element.
static class	OperatorDescription.MethodReference Represents a reference to body of declaration.
static class	OperatorDescription.Node Represents input/output/argument.
static class	OperatorDescription.ParameterReference Represents a reference to a parameter declaration.
static class	OperatorDescription.Reference Represents reference to original declaration.
static class	OperatorDescription.ReferenceDocument Represents a document with reference.
static class	OperatorDescription.ReturnReference Represents a reference to return type/value of declaration.
static class	OperatorDescription.SpecialReference Represents an operator specific reference.
static class	OperatorDescription.TextDocument Represents a document with text.

Constructor Summary

Constructors

Constructor and Description
OperatorDescription(OperatorDescription.Document document, List<? extends OperatorDescription.Node> parameters, List<? extends OperatorDescription.Node> outputs) Creates a new instance.
OperatorDescription(OperatorDescription.Document document, List<? extends OperatorDescription.Node> parameters, List<? extends OperatorDescription.Node> outputs, List<? extends ValueDescription> attributes) Creates a new instance.

Method Summary

Modifier and Type	Method and Description
List<OperatorDescription.Node>	getAllNodes() Returns input/output/arguments.
List<OperatorDescription.Node>	getArguments() Returns the input arguments.
List<ValueDescription>	getAttributes() Returns the attributes.
OperatorDescription.Document	getDocument() Returns the documents about the operator.
List<OperatorDescription.Node>	getInputs() Returns the input datasets.
List<OperatorDescription.Node>	getOutputs() Returns the output datasets.
List<OperatorDescription.Node>	getParameters() Returns the parameters, which include input datasets and arguments.
ExecutableElement	getSupport() Returns the support method for this operator.
OperatorDescription	withSupport(ExecutableElement newValue) Sets the support method for this operator.

Methods inherited from class java.lang.Object

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

Constructor Detail

OperatorDescription

public OperatorDescription(OperatorDescription.Document document,
                           List<? extends OperatorDescription.Node> parameters,
                           List<? extends OperatorDescription.Node> outputs)

Creates a new instance.

Parameters:

document - the document about the operator

parameters - parameters (input datasets/arguments)

outputs - output datasets

Throws:

IllegalArgumentException - if some parameters were null

OperatorDescription

public OperatorDescription(OperatorDescription.Document document,
                           List<? extends OperatorDescription.Node> parameters,
                           List<? extends OperatorDescription.Node> outputs,
                           List<? extends ValueDescription> attributes)

Creates a new instance.

Parameters:

document - the document about the operator

parameters - parameters (input datasets/arguments)

outputs - output datasets

attributes - operator attributes

Throws:

IllegalArgumentException - if some parameters were null

Method Detail

getDocument

public OperatorDescription.Document getDocument()

Returns the documents about the operator.

Returns:

the document

getParameters

public List<OperatorDescription.Node> getParameters()

Returns the parameters, which include input datasets and arguments.

Returns:

the parameters

getInputs

public List<OperatorDescription.Node> getInputs()

Returns the input datasets.

Returns:

the inputs

getArguments

public List<OperatorDescription.Node> getArguments()

Returns the input arguments.

Returns:

the arguments

getOutputs

public List<OperatorDescription.Node> getOutputs()

Returns the output datasets.

Returns:

the outputs

getAllNodes

public List<OperatorDescription.Node> getAllNodes()

Returns input/output/arguments.

Returns:

all node elements

getAttributes

public List<ValueDescription> getAttributes()

Description copied from interface: AttributeContainer

Returns the attributes.

Specified by:

getAttributes in interface AttributeContainer

Returns:

the attributes

getSupport

public ExecutableElement getSupport()

Returns the support method for this operator.

Returns:

the support method for this operator, or null if this operator does not have support methods

withSupport

public OperatorDescription withSupport(ExecutableElement newValue)

Sets the support method for this operator.

Parameters:

newValue - the support method

Returns:

this