eu.mihosoft.vrl.workflow

Class IOConnector

java.lang.Object

eu.mihosoft.vrl.workflow.IOConnector

All Implemented Interfaces:

Connector, Model

public final class IOConnector
extends Object

Author:

Michael Hoffer <info@michaelhoffer.de>

Property Summary

Type	Property and Description
ObjectProperty<Integer>	maxNumberOfConnections Returns the property of the maximum allowed number of connections.
ObjectProperty<ValueObject>	valueObject Returns the value object property (can be used to get notified if the value object changes).
ReadOnlyProperty<VisualizationRequest>	visualizationRequest Returns the visualization request property of this model.

Constructor Summary

Constructors

Constructor and Description
IOConnector(VNode node, String type, String localId, boolean input)

Method Summary

Modifier and Type	Method and Description
void	addClickEventListener(EventHandler<ClickEvent> handler) Adds the specified click-event listener to this connector.
void	addConnectionEventListener(EventHandler<ConnectionEvent> handler) Adds the specified connection-event listener to this connector.
void	click(MouseButton btn, Object event) Perform a mouse click on this connector.
List<EventHandler<ClickEvent>>	getClickEventHandlers()
List<EventHandler<ConnectionEvent>>	getConnectionEventHandlers()
String	getId() Returns the global id of this connector.
String	getLocalId() Returns the local id of this connector.
int	getMaxNumberOfConnections() Gets the value of the property maxNumberOfConnections.
VNode	getNode() Returns the parent node of this connector.
String	getType() Returns the conneciton type of this connector.
ValueObject	getValueObject() Gets the value of the property valueObject.
VisualizationRequest	getVisualizationRequest() Returns the visualization request of this model.
boolean	isInput() Determines whether this connector is an input connector.
boolean	isOutput() Determines whether this connector is an output connector.
boolean	isVisualizationRequestInitialized() Determines whether the visualization request is already initialized.
ObjectProperty<Integer>	maxNumberOfConnectionsProperty() Returns the property of the maximum allowed number of connections.
void	removeClickEventListener(EventHandler<ClickEvent> handler) Removes the specified click-event listener from this connector.
void	removeConnectionEventListener(EventHandler<ConnectionEvent> handler) Removes the specified connection-event listener from this connector.
void	setLocalId(String id) Defines the local id of this connector.
void	setMaxNumberOfConnections(int numConnections) Sets the value of the property maxNumberOfConnections.
void	setValueObject(ValueObject vObj) Sets the value of the property valueObject.
void	setVisualizationRequest(VisualizationRequest vReq) Defines the visualization request for this model.
ObjectProperty<ValueObject>	valueObjectProperty() Returns the value object property (can be used to get notified if the value object changes).
ReadOnlyProperty<VisualizationRequest>	visualizationRequestProperty() Returns the visualization request property of this model.

Methods inherited from class java.lang.Object

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

Constructor Detail

IOConnector

public IOConnector(VNode node,
                   String type,
                   String localId,
                   boolean input)

Method Detail

getType

public String getType()

Description copied from interface: Connector

Returns the conneciton type of this connector.

Specified by:

getType in interface Connector

Returns:

connection type (e.g. "control" or "data")

getId

public String getId()

Description copied from interface: Connector

Returns the global id of this connector.

Specified by:

getId in interface Connector

Returns:

global connector id

getLocalId

public String getLocalId()

Description copied from interface: Connector

Returns the local id of this connector.

Specified by:

getLocalId in interface Connector

Returns:

local connector id

setLocalId

public void setLocalId(String id)

Description copied from interface: Connector

Defines the local id of this connector.

Specified by:

setLocalId in interface Connector

Parameters:

id - the id to set

getNode

public VNode getNode()

Description copied from interface: Connector

Returns the parent node of this connector.

Specified by:

getNode in interface Connector

Returns:

parent node of this connector

getVisualizationRequest

public VisualizationRequest getVisualizationRequest()

Description copied from interface: Model

Returns the visualization request of this model.

Specified by:

getVisualizationRequest in interface Model

Returns:

the vReq

setVisualizationRequest

public void setVisualizationRequest(VisualizationRequest vReq)

Description copied from interface: Model

Defines the visualization request for this model.

Specified by:

setVisualizationRequest in interface Model

Parameters:

vReq - the vReq to set

visualizationRequestProperty

public ReadOnlyProperty<VisualizationRequest> visualizationRequestProperty()

Description copied from interface: Model

Returns the visualization request property of this model.

Specified by:

visualizationRequestProperty in interface Model

Returns:

visualization request property

See Also:

getVisualizationRequest(), setVisualizationRequest(VisualizationRequest)

isInput

public boolean isInput()

Description copied from interface: Connector

Determines whether this connector is an input connector.

Specified by:

isInput in interface Connector

Returns:

the input

isOutput

public boolean isOutput()

Description copied from interface: Connector

Determines whether this connector is an output connector.

Specified by:

isOutput in interface Connector

Returns:

the output

setValueObject

public final void setValueObject(ValueObject vObj)

Sets the value of the property valueObject.

Specified by:

setValueObject in interface Connector

Parameters:

vObj - value object to set

getValueObject

public ValueObject getValueObject()

Gets the value of the property valueObject.

Specified by:

getValueObject in interface Connector

Returns:

value object or null if no value object has been defined

valueObjectProperty

public ObjectProperty<ValueObject> valueObjectProperty()

Description copied from interface: Connector

Returns the value object property (can be used to get notified if the value object changes).

Specified by:

valueObjectProperty in interface Connector

See Also:

getValueObject(), setValueObject(ValueObject)

addConnectionEventListener

public void addConnectionEventListener(EventHandler<ConnectionEvent> handler)

Description copied from interface: Connector

Adds the specified connection-event listener to this connector.

Specified by:

addConnectionEventListener in interface Connector

Parameters:

handler - the listener to add

removeConnectionEventListener

public void removeConnectionEventListener(EventHandler<ConnectionEvent> handler)

Description copied from interface: Connector

Removes the specified connection-event listener from this connector.

Specified by:

removeConnectionEventListener in interface Connector

Parameters:

handler - the listener to remove

getConnectionEventHandlers

public List<EventHandler<ConnectionEvent>> getConnectionEventHandlers()

Returns:

the connectionEventHandlers

addClickEventListener

public void addClickEventListener(EventHandler<ClickEvent> handler)

Description copied from interface: Connector

Adds the specified click-event listener to this connector.

Specified by:

addClickEventListener in interface Connector

Parameters:

handler - the listener to add

removeClickEventListener

public void removeClickEventListener(EventHandler<ClickEvent> handler)

Description copied from interface: Connector

Removes the specified click-event listener from this connector.

Specified by:

removeClickEventListener in interface Connector

Parameters:

handler - the listener to remove

getClickEventHandlers

public List<EventHandler<ClickEvent>> getClickEventHandlers()

Returns:

the clickEventHandlers

click

public void click(MouseButton btn,
                  Object event)

Description copied from interface: Connector

Perform a mouse click on this connector.

Specified by:

click in interface Connector

Parameters:

btn - the click button

event - the event (e.g. javafx mouse-event)

isVisualizationRequestInitialized

public boolean isVisualizationRequestInitialized()

Description copied from interface: Model

Determines whether the visualization request is already initialized. Use this method to prevent unnecessary initialization. Depending on the model implementation Model.getVisualizationRequest() can cause initialization.

Specified by:

isVisualizationRequestInitialized in interface Model

Returns:

true if the visualization request is already initialized

setMaxNumberOfConnections

public void setMaxNumberOfConnections(int numConnections)

Sets the value of the property maxNumberOfConnections.

Specified by:

setMaxNumberOfConnections in interface Connector

Parameters:

numConnections - maximum allowed number of connections ([0,MAX_INT])

getMaxNumberOfConnections

public int getMaxNumberOfConnections()

Gets the value of the property maxNumberOfConnections.

Specified by:

getMaxNumberOfConnections in interface Connector

Returns:

maximum allowed number of connections ([0,MAX_INT])

maxNumberOfConnectionsProperty

public ObjectProperty<Integer> maxNumberOfConnectionsProperty()

Description copied from interface: Connector

Returns the property of the maximum allowed number of connections.

Specified by:

maxNumberOfConnectionsProperty in interface Connector

See Also:

getMaxNumberOfConnections(), setMaxNumberOfConnections(int)