com.ibm.streams.operator.metrics

Enum PEMetrics.InputPortMetric

java.lang.Object

java.lang.Enum<PEMetrics.InputPortMetric>

com.ibm.streams.operator.metrics.PEMetrics.InputPortMetric

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PEMetrics.InputPortMetric>

Enclosing interface:

PEMetrics

public static enum PEMetrics.InputPortMetric
extends java.lang.Enum<PEMetrics.InputPortMetric>

Enumeration representing metric names for processing element input ports. Any Metric object returned for one of these names is read only.

Enum Constant Summary

Enum Constants

Enum Constant and Description
nFinalPunctsProcessed Number of final punctuation marks processed by the port.
nTupleBytesProcessed Number of bytes processed by the port.
nTuplesProcessed Number of tuples processed by the port.
nWindowPunctsProcessed Number of window punctuation marks processed by the port.

Method Summary

Modifier and Type	Method and Description
Metric	getMetric(OperatorContext context, int port) Convenience method to get the Metric for a specific processing element port.
static PEMetrics.InputPortMetric	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PEMetrics.InputPortMetric[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

nTuplesProcessed

public static final PEMetrics.InputPortMetric nTuplesProcessed

Number of tuples processed by the port.

nTupleBytesProcessed

public static final PEMetrics.InputPortMetric nTupleBytesProcessed

Number of bytes processed by the port.

nWindowPunctsProcessed

public static final PEMetrics.InputPortMetric nWindowPunctsProcessed

Number of window punctuation marks processed by the port.

nFinalPunctsProcessed

public static final PEMetrics.InputPortMetric nFinalPunctsProcessed

Number of final punctuation marks processed by the port.

Method Detail

values

public static PEMetrics.InputPortMetric[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (PEMetrics.InputPortMetric c : PEMetrics.InputPortMetric.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PEMetrics.InputPortMetric valueOf(java.lang.String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null

getMetric

public Metric getMetric(OperatorContext context,
                        int port)

Convenience method to get the Metric for a specific processing element port.

Parameters:

context - Operator's context.

port - Processing Element port.

Returns:

The Metric object for this processing element input port metric.

Throws:

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