com.rapidminer.operator.ports
Interface OutputPort

All Superinterfaces:

Observable<Port>, Port

All Known Implementing Classes:

OutputPortImpl

public interface OutputPort
extends Port

An output port which forwards it output to a connected input port. Operators place their output into output ports which take care of forwarding the data to the input ports.

Author:

Simon Fischer

Field Summary

Fields inherited from interface com.rapidminer.operator.ports.Port

CLEAR_ALL, CLEAR_ALL_ERRORS, CLEAR_ALL_METADATA, CLEAR_DATA, CLEAR_META_DATA_ERRORS, CLEAR_METADATA, CLEAR_REAL_METADATA, CLEAR_SIMPLE_ERRORS

Method Summary

void	connectTo(InputPort inputPort) Connects to an input port.
void	deliver(IOObject object) Delivers an object to the connected InputPort or ignores it if the output port is not connected.
void	deliverMD(MetaData md) Does the same as #deliver(Object) except that only meta data is delivered.
void	disconnect() Disconnects the OutputPort from its InputPort.
InputPort	getDestination() Returns the destination input port.
boolean	shouldAutoConnect() Asks the owning operator Operator.shouldAutoConnect(OutputPort).

Methods inherited from interface com.rapidminer.operator.ports.Port

addError, clear, collectQuickFixes, freeMemory, getAnyDataOrNull, getData, getData, getDataOrNull, getDescription, getErrors, getMetaData, getName, getPorts, getShortName, getSpec, isConnected, isLocked, lock, simulatesStack, unlock

Methods inherited from interface com.rapidminer.tools.Observable

addObserver, addObserverAsFirst, removeObserver

Method Detail

connectTo

void connectTo(InputPort inputPort)
               throws PortException

Connects to an input port.

Throws:

PortException - if already connected.

disconnect

void disconnect()
                throws PortException

Disconnects the OutputPort from its InputPort. Note: As a side effect, disconnecting ports may trigger PortExtenders removing these ports. In order to avoid this behaviour, Port.lock() port first.

Throws:

PortException - if not connected.

deliver

void deliver(IOObject object)

Delivers an object to the connected InputPort or ignores it if the output port is not connected.

getDestination

InputPort getDestination()

Returns the destination input port.

deliverMD

void deliverMD(MetaData md)

Does the same as #deliver(Object) except that only meta data is delivered. This method is called by the Operator's MDTransformer.

shouldAutoConnect

boolean shouldAutoConnect()

Asks the owning operator Operator.shouldAutoConnect(OutputPort).