com.bigdata.counters.query

Class CounterSetSelector

java.lang.Object

com.bigdata.counters.query.CounterSetSelector

All Implemented Interfaces:

ICounterSelector

public class CounterSetSelector
extends Object
implements ICounterSelector

Reads counters from a CounterSet.

Author:

Bryan Thompson

Constructor Summary

Constructors

Constructor and Description
CounterSetSelector(CounterSet counterSet)

Method Summary

Methods

Modifier and Type	Method and Description
CounterSet	getRoot()
ICounter[]	selectCounters(int depth, Pattern pattern, long fromTime, long toTime, PeriodEnum period, boolean historyRequired) Selects and returns a collection of performance counters with history.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

CounterSetSelector

public CounterSetSelector(CounterSet counterSet)

Method Detail

getRoot

public CounterSet getRoot()

selectCounters

public ICounter[] selectCounters(int depth,
                        Pattern pattern,
                        long fromTime,
                        long toTime,
                        PeriodEnum period,
                        boolean historyRequired)

Description copied from interface: ICounterSelector

Selects and returns a collection of performance counters with history.

Specified by:

selectCounters in interface ICounterSelector

Parameters:

depth - When GT ZERO, this specifies a constraint on the maximum depth for a counter may can be selected.

pattern - A regular expression which must be satisified (optional).

fromTime - The inclusive lower bound in milliseconds of the performance counter timestamps which will be selected.

toTime - The exclusive upper bound in milliseconds of the performance counter timestamps which will be selected.

period - The unit of aggregation for the selected performance counters.

historyRequired - When true the ICounter will be ignored unless it is associated with a HistoryInstrument. (This used to be the default behavior, but there are use cases where we do not need to have history.)

Returns:

The selected performance counters.