cascading.stats.local
Class LocalStepStats

java.lang.Object
  cascading.stats.CascadingStats
      cascading.stats.FlowStepStats
          cascading.stats.local.LocalStepStats

All Implemented Interfaces:

Serializable

public class LocalStepStats
extends FlowStepStats

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class cascading.stats.CascadingStats

CascadingStats.Status

Field Summary

Fields inherited from class cascading.stats.CascadingStats

clientState, STATS_STORE_INTERVAL

Constructor Summary

LocalStepStats(FlowStep<Properties> flowStep, ClientState clientState)
Constructor CascadingStats creates a new CascadingStats instance.

Method Summary

void	captureDetail() Method captureDetail will recursively capture details about nested systems.
Collection	getChildren() Method getChildren returns any relevant child statistics instances.
Collection<String>	getCounterGroups() Method getCounterGroups returns all the available counter group names.
Collection<String>	getCounterGroupsMatching(String regex) Method getCounterGroupsMatching returns all the available counter group names that match the given regular expression.
Collection<String>	getCountersFor(String group) Method getCountersFor returns all the counter names for the give group name.
long	getCounterValue(Enum counter) Method getCounter returns the current value for the given counter Enum.
long	getCounterValue(String group, String counter) Method getCounter returns the current value for the given group and counter.
void	increment(Enum counter, long amount)
void	increment(String group, String counter, long amount)
void	recordChildStats()

Methods inherited from class cascading.stats.FlowStepStats

getFlowStep, getID, recordInfo, toString

Methods inherited from class cascading.stats.CascadingStats

cleanup, getCountersFor, getCurrentDuration, getDuration, getFinishedTime, getName, getPendingTime, getRunTime, getStartTime, getStatsString, getStatus, getSubmitTime, getThrowable, isEngaged, isFailed, isFinished, isPending, isRunning, isSkipped, isStarted, isStopped, isSubmitted, isSuccessful, markFailed, markPending, markPendingTime, markRunning, markRunTime, markSkipped, markStarted, markStartedThenRunning, markStartTime, markStartToRunTime, markStopped, markSubmitted, markSubmitTime, markSuccessful, prepare, recordStats, setStatsStoreInterval

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalStepStats

public LocalStepStats(FlowStep<Properties> flowStep,
                      ClientState clientState)

Constructor CascadingStats creates a new CascadingStats instance.

Method Detail

recordChildStats

public void recordChildStats()

Specified by:

recordChildStats in class FlowStepStats

getCounterGroups

public Collection<String> getCounterGroups()

Description copied from class: CascadingStats

Method getCounterGroups returns all the available counter group names.

Specified by:

getCounterGroups in class CascadingStats

Returns:

the counterGroups (type Collection) of this CascadingStats object.

getCounterGroupsMatching

public Collection<String> getCounterGroupsMatching(String regex)

Description copied from class: CascadingStats

Method getCounterGroupsMatching returns all the available counter group names that match the given regular expression.

Specified by:

getCounterGroupsMatching in class CascadingStats

Parameters:

regex - of type String

Returns:

Collection

getCountersFor

public Collection<String> getCountersFor(String group)

Description copied from class: CascadingStats

Method getCountersFor returns all the counter names for the give group name.

Specified by:

getCountersFor in class CascadingStats

Returns:

Collection

getCounterValue

public long getCounterValue(Enum counter)

Description copied from class: CascadingStats

Method getCounter returns the current value for the given counter Enum.

Specified by:

getCounterValue in class CascadingStats

Parameters:

counter - of type Enum

Returns:

the current counter value

getCounterValue

public long getCounterValue(String group,
                            String counter)

Description copied from class: CascadingStats

Method getCounter returns the current value for the given group and counter.

Specified by:

getCounterValue in class CascadingStats

Parameters:

group - of type String

counter - of type String

Returns:

the current counter value

increment

public void increment(Enum counter,
                      long amount)

increment

public void increment(String group,
                      String counter,
                      long amount)

captureDetail

public void captureDetail()

Description copied from class: CascadingStats

Method captureDetail will recursively capture details about nested systems. Use this method to persist statistics about a given Cascade, Flow, or FlowStep.

Each CascadingStats object must be individually inspected for any system specific details.

Specified by:

captureDetail in class CascadingStats

getChildren

public Collection getChildren()

Description copied from class: CascadingStats

Method getChildren returns any relevant child statistics instances. They may not be of type CascadingStats, but instead platform specific.

Specified by:

getChildren in class CascadingStats

Returns:

a Collection of child statistics