com.bigdata.counters.query

Enum ReportEnum

java.lang.Object

java.lang.Enum<ReportEnum>

com.bigdata.counters.query.ReportEnum

All Implemented Interfaces:

Serializable, Comparable<ReportEnum>

public enum ReportEnum
extends Enum<ReportEnum>

The different kinds of reports that we can generate.

Version:

$Id$

Author:

Bryan Thompson

Enum Constant Summary

Enum Constants

Enum Constant and Description
correlated A correlated view will be generated for the spanned counters showing all samples for each counter in a column where the rows are all for the same sample period.
events Plot a timeline of events.
hierarchy This is the navigational view of the performance counter hierarchy.
pivot This is a pivot table ready view, which is useful for aggregating the performance counter data in a variety of ways.

Method Summary

Methods

Modifier and Type	Method and Description
static ReportEnum	valueOf(String name) Returns the enum constant of this type with the specified name.
static ReportEnum[]	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

hierarchy

public static final ReportEnum hierarchy

This is the navigational view of the performance counter hierarchy.

correlated

public static final ReportEnum correlated

A correlated view will be generated for the spanned counters showing all samples for each counter in a column where the rows are all for the same sample period. Counters without history are elided in this view. This is useful for plotting timeseries.

pivot

public static final ReportEnum pivot

This is a pivot table ready view, which is useful for aggregating the performance counter data in a variety of ways.

events

public static final ReportEnum events

Plot a timeline of events.

Method Detail

values

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

Returns:

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

valueOf

public static ReportEnum valueOf(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:

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

NullPointerException - if the argument is null