Package com.orchestranetworks.addon.dint.transformation

Class OutputDefinition

java.lang.Object

com.orchestranetworks.addon.dint.transformation.OutputDefinition

public final class OutputDefinition
extends java.lang.Object

The definition of a transformation's output.

An output may contain a single or multiple values of a certain DataType.

Since:

4.1.0

See Also:

TransformationDefinition.getOutputDefinition()

Constructor Summary

Constructors

Constructor	Description
OutputDefinition(java.lang.String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, DataType type, boolean multiValued)	Constructs a new OutputDefinition.
OutputDefinition(java.lang.String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, java.util.List<OutputDefinition> childrenOutputs)	Constructs a new OutputDefinition with multiple outputs from children.
OutputDefinition(java.lang.String name, com.onwbp.base.text.UserMessage label, DataType type)	Constructs a new single-valued OutputDefinition.

Method Summary

Modifier and Type	Method	Description
com.onwbp.base.text.UserMessage	getDescription()	Returns the description.
com.onwbp.base.text.UserMessage	getLabel()	Returns the label.
java.lang.String	getName()	Returns the unique name.
DataType	getType()	Returns the data type.
boolean	isMultiValued()	Returns true if the output is multi-valued.
boolean	isUnbounded()	Returns true if the output size is unbounded.
void	setUnbounded(boolean unbounded)	Sets sets whether the output size is unbounded.

Methods inherited from class java.lang.Object

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

Constructor Detail

OutputDefinition

public OutputDefinition(java.lang.String name,
                        com.onwbp.base.text.UserMessage label,
                        DataType type)

Constructs a new single-valued OutputDefinition.

Parameters:

name - the unique name.

label - the label.

type - the data type.

Since:

4.4.0

OutputDefinition

public OutputDefinition(java.lang.String name,
                        com.onwbp.base.text.UserMessage label,
                        com.onwbp.base.text.UserMessage description,
                        DataType type,
                        boolean multiValued)

Constructs a new OutputDefinition.

Parameters:

name - the unique name.

label - the label.

description - the description.

type - the data type.

multiValued - whether this input is multiple-valued.

OutputDefinition

public OutputDefinition(java.lang.String name,
                        com.onwbp.base.text.UserMessage label,
                        com.onwbp.base.text.UserMessage description,
                        java.util.List<OutputDefinition> childrenOutputs)

Constructs a new OutputDefinition with multiple outputs from children.

The object returns a GenericDataObject.

The graphical mapping screen will display all ports that correspond with the number of the child outputs.

Parameters:

name - the output's unique name

label - the output's label

description - the output's description

childrenOutputs - the list that defines child outputs. Multi-valued and unbounded values are not supported for child output definitions.

Since:

6.1.2

Method Detail

getName

public java.lang.String getName()

Returns the unique name.

getLabel

public com.onwbp.base.text.UserMessage getLabel()

Returns the label.

getDescription

public com.onwbp.base.text.UserMessage getDescription()

Returns the description.

getType

public DataType getType()

Returns the data type.

isMultiValued

public boolean isMultiValued()

Returns true if the output is multi-valued.

isUnbounded

public boolean isUnbounded()

Returns true if the output size is unbounded.

Returns false if the output size is fixed.

Since:

4.2.0

setUnbounded

public void setUnbounded(boolean unbounded)

Sets sets whether the output size is unbounded.

Parameters:

unbounded - Determines whether all output values are considered.

Since:

4.2.0