com.ibm.streams.operator.metrics

Interface PEMetrics

public interface PEMetrics

PEMetrics provides access to metrics related to an processing element's ports.

See Also:

ProcessingElement.getMetrics(), Metric

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	PEMetrics.InputPortMetric Enumeration representing metric names for processing element input ports.
static class	PEMetrics.OutputPortMetric Enumeration representing metric names for processing element output ports.

Method Summary

Methods

Modifier and Type	Method and Description
Metric	getInputPortMetric(int port, PEMetrics.InputPortMetric name) Get a read-only Metric for a specific processing element input port.
Metric	getOutputPortMetric(int port, PEMetrics.OutputPortMetric name) Get a read-only Metric for a specific processing element output port.

Method Detail

getInputPortMetric

Metric getInputPortMetric(int port,
                        PEMetrics.InputPortMetric name)

Get a read-only Metric for a specific processing element input port.

Parameters:

port - Port for the metric.

name - Enumeration representing the name of the metric.

Returns:

A read-only Metric.

Throws:

java.lang.NullPointerException - name is null.

java.lang.IllegalStateException - Operator has been shutdown and the metric has not been accessed previously.

getOutputPortMetric

Metric getOutputPortMetric(int port,
                         PEMetrics.OutputPortMetric name)

Get a read-only Metric for a specific processing element output port.

Parameters:

port - Port for the metric.

name - Enumeration representing the name of the metric.

Returns:

A read-only Metric.

Throws:

java.lang.NullPointerException - name is null.

java.lang.IllegalStateException - Operator has been shutdown and the metric has not been accessed previously.