com.orchestranetworks.addon.dint.transformation

Class OutputDefinition

java.lang.Object

com.orchestranetworks.addon.dint.transformation.OutputDefinition

public final class OutputDefinition
extends 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 and Description
OutputDefinition(String name, com.onwbp.base.text.UserMessage label, DataType type) Constructs a new single-valued OutputDefinition.
OutputDefinition(String name, com.onwbp.base.text.UserMessage label, com.onwbp.base.text.UserMessage description, DataType type, boolean multiValued) Constructs a new OutputDefinition.

Method Summary

Modifier and Type	Method and Description
com.onwbp.base.text.UserMessage	getDescription() Returns the description.
com.onwbp.base.text.UserMessage	getLabel() Returns the label.
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(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(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.

Method Detail

getName

public 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