Module datarush.script

Package com.pervasive.datarush.script

Class PortDescriptor

java.lang.Object

com.pervasive.datarush.script.PortDescriptor

public class PortDescriptor
extends Object

Definition of an operator port.

Constructor Summary

Constructors

Constructor	Description
PortDescriptor(String name, LogicalPort.Direction direction, int index, Class<? extends LogicalPort> portClass, String description, boolean optional)	Construct a port definition.

Method Summary

Modifier and Type	Method	Description
String	getDescription()	Get the description of the port.
LogicalPort.Direction	getDirection()	Get the port direction.
int	getIndex()	Get the index of the port within the list of ports of this type for the operator.
String	getName()	Get the logical name of the port.
Class<? extends LogicalPort>	getPortClass()	Get the implementation class of the port.
boolean	isOptional()	Get the indicator of whether or not a port is optional.

Methods inherited from class java.lang.Object

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

Constructor Detail

PortDescriptor

public PortDescriptor(String name,
                      LogicalPort.Direction direction,
                      int index,
                      Class<? extends LogicalPort> portClass,
                      String description,
                      boolean optional)

Construct a port definition.

Parameters:

name - logical name of the port

direction - direction of the port (input or output)

index - zero based index of this port within the list of ports of this type for the operator

portClass - class implementation of the port

description - documentation about the port

Method Detail

getName

public String getName()

Get the logical name of the port.

Returns:

logical port name

getDescription

public String getDescription()

Get the description of the port. May be null.

Returns:

port description (may be null)

getIndex

public int getIndex()

Get the index of the port within the list of ports of this type for the operator.

Returns:

port index

getPortClass

public Class<? extends LogicalPort> getPortClass()

Get the implementation class of the port.

Returns:

implementation class

getDirection

public LogicalPort.Direction getDirection()

Get the port direction.

Returns:

port direction

isOptional

public boolean isOptional()

Get the indicator of whether or not a port is optional.

Returns:

true if the port is optional; false otherwise