com.ibm.streams.operator.metrics

Enum OperatorMetrics.OutputPortMetric

java.lang.Object

java.lang.Enum<OperatorMetrics.OutputPortMetric>

com.ibm.streams.operator.metrics.OperatorMetrics.OutputPortMetric

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<OperatorMetrics.OutputPortMetric>

Enclosing interface:

OperatorMetrics

public static enum OperatorMetrics.OutputPortMetric
extends java.lang.Enum<OperatorMetrics.OutputPortMetric>

Enumeration representing metric names for operator output ports. Any Metric object returned for one of these names is read only.

Enum Constant Summary

Enum Constants

Enum Constant and Description
nFinalPunctsSubmitted Number of final punctuation marks submitted on an output port.
nTuplesSubmitted Number of tuples submitted on an output port.
nWindowPunctsSubmitted Number of window punctuation marks submitted on an output port.

Method Summary

Modifier and Type	Method and Description
Metric	getMetric(OperatorContext context, int port) Convenience method to get the Metric for a specific operator port.
static OperatorMetrics.OutputPortMetric	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static OperatorMetrics.OutputPortMetric[]	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

nTuplesSubmitted

public static final OperatorMetrics.OutputPortMetric nTuplesSubmitted

Number of tuples submitted on an output port.

nWindowPunctsSubmitted

public static final OperatorMetrics.OutputPortMetric nWindowPunctsSubmitted

Number of window punctuation marks submitted on an output port.

See Also:

StreamingData.Punctuation.WINDOW_MARKER

nFinalPunctsSubmitted

public static final OperatorMetrics.OutputPortMetric nFinalPunctsSubmitted

Number of final punctuation marks submitted on an output port.

See Also:

StreamingData.Punctuation.FINAL_MARKER

Method Detail

values

public static OperatorMetrics.OutputPortMetric[] 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 (OperatorMetrics.OutputPortMetric c : OperatorMetrics.OutputPortMetric.values())
    System.out.println(c);

Returns:

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

valueOf

public static OperatorMetrics.OutputPortMetric 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 operator port.

Parameters:

context - Operator's context.

port - Operator port.

Returns:

The Metric object for this operator output port metric.

Throws:

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