org.apache.hadoop.mapred

Class Counters.Group

java.lang.Object

org.apache.hadoop.mapred.Counters.Group

All Implemented Interfaces:

java.lang.Iterable<Counters.Counter>, org.apache.hadoop.io.Writable, CounterGroupBase<Counters.Counter>

Enclosing class:

Counters

public static class Counters.Group
extends java.lang.Object
implements CounterGroupBase<Counters.Counter>

Group of counters, comprising of counters from a particular counter Enum class.

Grouphandles localization of the class name and the counter names.

Method Summary

Methods

Modifier and Type	Method and Description
void	addCounter(Counters.Counter counter) Add a counter to this group.
Counters.Counter	addCounter(java.lang.String name, java.lang.String displayName, long value) Add a counter to this group
boolean	equals(java.lang.Object genericRight)
Counters.Counter	findCounter(java.lang.String counterName) Find a counter in the group.
Counters.Counter	findCounter(java.lang.String counterName, boolean create) Find a counter in the group
Counters.Counter	findCounter(java.lang.String counterName, java.lang.String displayName) Find a counter in the group.
Counters.Counter	getCounter(int id, java.lang.String name) Deprecated. use findCounter(String) instead
long	getCounter(java.lang.String counterName)
Counters.Counter	getCounterForName(java.lang.String name) Get the counter for the given name and create it if it doesn't exist.
java.lang.String	getDisplayName() Get the display name of the group.
java.lang.String	getName() Get the internal name of the group
CounterGroupBase<Counters.Counter>	getUnderlyingGroup() Exposes the underlying group type if a facade.
int	hashCode()
void	incrAllCounters(CounterGroupBase<Counters.Counter> rightGroup) Increment all counters by a group of counters
java.util.Iterator<Counters.Counter>	iterator()
java.lang.String	makeEscapedCompactString()
void	readFields(java.io.DataInput in)
void	setDisplayName(java.lang.String displayName) Set the display name of the group
int	size()
void	write(java.io.DataOutput out)

Methods inherited from class java.lang.Object

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

Method Detail

getCounter

public long getCounter(java.lang.String counterName)

Parameters:

counterName - the name of the counter

Returns:

the value of the specified counter, or 0 if the counter does not exist.

makeEscapedCompactString

public java.lang.String makeEscapedCompactString()

Returns:

the compact stringified version of the group in the format {(actual-name)(display-name)(value)[][][]} where [] are compact strings for the counters within.

getCounter

@Deprecated
public Counters.Counter getCounter(int id,
                                     java.lang.String name)

Deprecated. use findCounter(String) instead

Get the counter for the given id and create it if it doesn't exist.

Parameters:

id - the numeric id of the counter within the group

name - the internal counter name

Returns:

the counter

getCounterForName

public Counters.Counter getCounterForName(java.lang.String name)

Get the counter for the given name and create it if it doesn't exist.

Parameters:

name - the internal counter name

Returns:

the counter

write

public void write(java.io.DataOutput out)
           throws java.io.IOException

Specified by:

write in interface org.apache.hadoop.io.Writable

Throws:

java.io.IOException

readFields

public void readFields(java.io.DataInput in)
                throws java.io.IOException

Specified by:

readFields in interface org.apache.hadoop.io.Writable

Throws:

java.io.IOException

iterator

public java.util.Iterator<Counters.Counter> iterator()

Specified by:

iterator in interface java.lang.Iterable<Counters.Counter>

getName

public java.lang.String getName()

Description copied from interface: CounterGroupBase

Get the internal name of the group

Specified by:

getName in interface CounterGroupBase<Counters.Counter>

Returns:

the internal name

getDisplayName

public java.lang.String getDisplayName()

Description copied from interface: CounterGroupBase

Get the display name of the group.

Specified by:

getDisplayName in interface CounterGroupBase<Counters.Counter>

Returns:

the human readable name

setDisplayName

public void setDisplayName(java.lang.String displayName)

Description copied from interface: CounterGroupBase

Set the display name of the group

Specified by:

setDisplayName in interface CounterGroupBase<Counters.Counter>

Parameters:

displayName - of the group

addCounter

public void addCounter(Counters.Counter counter)

Description copied from interface: CounterGroupBase

Add a counter to this group.

Specified by:

addCounter in interface CounterGroupBase<Counters.Counter>

Parameters:

counter - to add

addCounter

public Counters.Counter addCounter(java.lang.String name,
                          java.lang.String displayName,
                          long value)

Description copied from interface: CounterGroupBase

Add a counter to this group

Specified by:

addCounter in interface CounterGroupBase<Counters.Counter>

Parameters:

name - of the counter

displayName - of the counter

value - of the counter

Returns:

the counter

findCounter

public Counters.Counter findCounter(java.lang.String counterName,
                           java.lang.String displayName)

Description copied from interface: CounterGroupBase

Find a counter in the group.

Specified by:

findCounter in interface CounterGroupBase<Counters.Counter>

Parameters:

counterName - the name of the counter

displayName - the display name of the counter

Returns:

the counter that was found or added

findCounter

public Counters.Counter findCounter(java.lang.String counterName,
                           boolean create)

Description copied from interface: CounterGroupBase

Find a counter in the group

Specified by:

findCounter in interface CounterGroupBase<Counters.Counter>

Parameters:

counterName - the name of the counter

create - create the counter if not found if true

Returns:

the counter that was found or added or null if create is false

findCounter

public Counters.Counter findCounter(java.lang.String counterName)

Description copied from interface: CounterGroupBase

Find a counter in the group.

Specified by:

findCounter in interface CounterGroupBase<Counters.Counter>

Parameters:

counterName - the name of the counter

Returns:

the counter that was found or added

size

public int size()

Specified by:

size in interface CounterGroupBase<Counters.Counter>

Returns:

the number of counters in this group.

incrAllCounters

public void incrAllCounters(CounterGroupBase<Counters.Counter> rightGroup)

Description copied from interface: CounterGroupBase

Increment all counters by a group of counters

Specified by:

incrAllCounters in interface CounterGroupBase<Counters.Counter>

Parameters:

rightGroup - the group to be added to this group

getUnderlyingGroup

public CounterGroupBase<Counters.Counter> getUnderlyingGroup()

Description copied from interface: CounterGroupBase

Exposes the underlying group type if a facade.

Specified by:

getUnderlyingGroup in interface CounterGroupBase<Counters.Counter>

Returns:

the underlying object that this object is wrapping up.

equals

public boolean equals(java.lang.Object genericRight)

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object