com.pervasive.datarush.ports

Interface PhysicalPort

All Superinterfaces:

Named, TokenTyped

All Known Subinterfaces:

PhysicalInputPort, PhysicalOutputPort, RecordInput, RecordOutput

public interface PhysicalPort
extends Named, TokenTyped

The common interface for all ports, both input and output. Ports represent an access point to a flow for an operator.

Ports are strongly typed, based upon the underlying tokens of the associated flow. Many common token types are supported, including Java primitive types and composite types.

Method Summary

Modifier and Type	Method and Description
void	detach() Forcibly releases the resources of a port.
PortStatistics	getStats() Retrieves the run-time statistics gathered for this port.
TokenType	getType() Gets the type of tokens in the underlying flow.
boolean	isAttached() Indicates whether the port is still attached.

Methods inherited from interface com.pervasive.datarush.namespace.Named

getName

Method Detail

getType

TokenType getType()

Gets the type of tokens in the underlying flow.

Specified by:

getType in interface TokenTyped

Returns:

the token type for this port.

getStats

PortStatistics getStats()

Retrieves the run-time statistics gathered for this port.

Returns:

PortStats gathered during execution or null if the configuration did not specify collecting statistics

isAttached

boolean isAttached()

Indicates whether the port is still attached.

Returns:

true if the port may still have data flowing, false otherwise

detach

void detach()

Forcibly releases the resources of a port.