com.pervasive.datarush.ports

Class LogicalPort

java.lang.Object

com.pervasive.datarush.ports.LogicalPort

Direct Known Subclasses:

AbstractModelPort, RecordPort

public abstract class LogicalPort
extends Object

A operator's port ( either input or output ). Clients should create ports via one of the factory methods on AbstractLogicalOperator. For example use newRecordInput to create a record input port.

See Also:

LogicalOperator

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	LogicalPort.Direction Indicates whether the port is input or output

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	LogicalPort(LogicalOperator owner, String name, LogicalPort.Direction direction, boolean optional) Create a new LogicalPort

Method Summary

Modifier and Type	Method and Description
LogicalPort.Direction	getDirection() Returns whether this port is for input or output
abstract LogicalPortFactory<?>	getFactory() Returns the factory that knows how to create ports of this type
abstract Class<? extends PortMetadata>	getMetadataType() Returns the class of metadata that this port uses
String	getName() Returns the name of this port
LogicalOperator	getOwner() Returns a reference to the operator that declared this port
boolean	isOptional() Returns whether this port is optional.
String	toString() Returns a string for ease debugging of the form <ownerClass>.<name>

Methods inherited from class java.lang.Object

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

Constructor Detail

LogicalPort

protected LogicalPort(LogicalOperator owner,
                      String name,
                      LogicalPort.Direction direction,
                      boolean optional)

Create a new LogicalPort

Parameters:

owner - the owner of the port

name - the name of the port

direction - the port direction

optional - whether the port is optional

Method Detail

getOwner

public final LogicalOperator getOwner()

Returns a reference to the operator that declared this port

Returns:

the operator that declared this port

getName

public final String getName()

Returns the name of this port

Returns:

the name of this port

getDirection

public final LogicalPort.Direction getDirection()

Returns whether this port is for input or output

Returns:

whether this port is for input or output

isOptional

public final boolean isOptional()

Returns whether this port is optional. Only input ports may be optional.

Returns:

whether this port is optional

getMetadataType

public abstract Class<? extends PortMetadata> getMetadataType()

Returns the class of metadata that this port uses

Returns:

the class of metadata that this port uses

getFactory

public abstract LogicalPortFactory<?> getFactory()

Returns the factory that knows how to create ports of this type

Returns:

the factory that knows how to create ports of this type

toString

public String toString()

Returns a string for ease debugging of the form <ownerClass>.<name>

Overrides:

toString in class Object