Package com.orchestranetworks.addon.dint.transformation

Class InputDefinition

java.lang.Object

com.orchestranetworks.addon.dint.transformation.InputDefinition

public final class InputDefinition
extends java.lang.Object

The definition of a transformation's input.

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

Since:

4.1.0

See Also:

TransformationDefinition.getInputDefinition()

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method	Description
java.util.List<InputDefinition>	getChildrenInputs()
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 input is multi-valued.
boolean	isUnbounded()	Returns true if the input size is unbounded.
void	setUnbounded(boolean unbounded)	Sets whether the input size is unbounded.

Methods inherited from class java.lang.Object

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

Constructor Detail

InputDefinition

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

Constructs a new single-valued InputDefinition.

Parameters:

name - the unique name.

label - the label.

type - the data type.

Since:

4.4.0

See Also:

InputDefinition(String, UserMessage, UserMessage, DataType, boolean)

InputDefinition

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

Constructs a new InputDefinition.

Parameters:

name - the unique name.

label - the label.

description - the description.

type - the data type.

multiValued - whether this input is multi-valued.

InputDefinition

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

Constructs a new InputDefinition with multiple inputs from children.

The object returned is a GenericDataObject.

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

Parameters:

name - the input's unique name

label - the input's label

description - the input's description

childrenInputs - the list that defines child inputs. Multi-valued and unbounded values are not supported for child input 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 input is multi-valued.

isUnbounded

public boolean isUnbounded()

Returns true if the input size is unbounded.

Returns false if the input size is fixed.

Since:

4.2.0

setUnbounded

public void setUnbounded(boolean unbounded)

Sets whether the input size is unbounded.

Parameters:

unbounded - Determines whether all input values are considered.

Since:

4.2.0

getChildrenInputs

public java.util.List<InputDefinition> getChildrenInputs()