com.ibm.streams.operator

Interface StreamingData

All Known Subinterfaces:

InputPortDeclaration, OutputPortDeclaration, PortDeclaration<T>, StreamingInput<T>, StreamingOutput<T>

public interface StreamingData

StreamingData describes an Operator's port.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	StreamingData.Punctuation Enumeration for punctuation marks.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Get the name for this port as defined in the application.
int	getPEPortNumber() Get the PE (processing element) port number index for this port.
int	getPortNumber() Get the port number as defined in the application.
StreamSchema	getStreamSchema() Get the schema for this port.
boolean	isConnectedToPEPort() Is this port connected to a PE (processing element) port.

Method Detail

getStreamSchema

StreamSchema getStreamSchema()

Get the schema for this port.

Returns:

schema for the port

getName

java.lang.String getName()

Get the name for this port as defined in the application.

Returns:

name of the port

getPortNumber

int getPortNumber()

Get the port number as defined in the application.

Returns:

port number

isConnectedToPEPort

boolean isConnectedToPEPort()

Is this port connected to a PE (processing element) port.

Returns:

True if port is connected to a PE port, false otherwise.

Since:

InfoSphere® Streams Version 3.0

See Also:

getPEPortNumber()

getPEPortNumber

int getPEPortNumber()

Get the PE (processing element) port number index for this port.

Returns:

PE port number

Throws:

java.lang.IllegalStateException - Port is not connected to a PE port (isConnectedToPEPort() is false)

Since:

InfoSphere® Streams Version 3.0

See Also:

ProcessingElement, PEMetrics.getInputPortMetric(int, InputPortMetric), PEMetrics.getOutputPortMetric(int, OutputPortMetric)