com.tangosol.coherence.jcache.partitionedcache

Class PartitionedJCacheStatistics.PartitionedCacheStatisticsAggregator

java.lang.Object

com.tangosol.coherence.jcache.partitionedcache.PartitionedJCacheStatistics.PartitionedCacheStatisticsAggregator

All Implemented Interfaces:

ExternalizableLite, PortableObject, InvocableMap.EntryAggregator, InvocableMap.StreamingAggregator, Serializable

Enclosing class:

PartitionedJCacheStatistics

public static class PartitionedJCacheStatistics.PartitionedCacheStatisticsAggregator
extends Object
implements InvocableMap.StreamingAggregator, ExternalizableLite, PortableObject

Collect JCache CacheStatistics from all storage-enabled members.

Field Summary

Fields inherited from interface com.tangosol.util.InvocableMap.StreamingAggregator

ALLOW_INCONSISTENCIES, BY_MEMBER, BY_PARTITION, PARALLEL, PRESENT_ONLY, RETAINS_ENTRIES, SERIAL

Constructor Summary

Constructors

Constructor and Description
PartitionedCacheStatisticsAggregator() Constructs PartitionedJCacheStatistics.PartitionedCacheStatisticsAggregator
PartitionedCacheStatisticsAggregator(JCacheIdentifier id, ValueExtractor valueExtractor) Constructs an aggregator to aggregate JCache Cache Statistics from all storage-enabled servers for a JCache implemented as a Partitioned Cache.

Method Summary

Modifier and Type	Method and Description
boolean	accumulate(InvocableMap.Entry entry) Accumulate one entry into the result.
int	characteristics() A bit mask representing the set of characteristics of this aggregator.
boolean	combine(Object partialResult) Merge another partial result into the result.
Object	finalizeResult() Return the final result of the aggregation.
Object	getPartialResult() Return the partial result of the aggregation.
protected void	process(Object o)
void	readExternal(DataInput in) Restore the contents of this object by loading the object's state from the passed DataInput object.
void	readExternal(PofReader in) Restore the contents of a user type instance by reading its state using the specified PofReader object.
InvocableMap.StreamingAggregator	supply() Create a new instance of this aggregator.
void	writeExternal(DataOutput out) Save the contents of this object by storing the object's state into the passed DataOutput object.
void	writeExternal(PofWriter out) Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.tangosol.util.InvocableMap.StreamingAggregator

accumulate, aggregate, isAllowInconsistencies, isByMember, isByPartition, isParallel, isPresentOnly, isRetainsEntries, isSerial

Constructor Detail

PartitionedCacheStatisticsAggregator

public PartitionedCacheStatisticsAggregator()

Constructs PartitionedJCacheStatistics.PartitionedCacheStatisticsAggregator

PartitionedCacheStatisticsAggregator

public PartitionedCacheStatisticsAggregator(JCacheIdentifier id,
                                            ValueExtractor valueExtractor)

Constructs an aggregator to aggregate JCache Cache Statistics from all storage-enabled servers for a JCache implemented as a Partitioned Cache.

Parameters:

id - the JCache cache to collect cache statistics for.

valueExtractor - extract CacheStatistics via binary entry context.

Method Detail

supply

public InvocableMap.StreamingAggregator supply()

Description copied from interface: InvocableMap.StreamingAggregator

Create a new instance of this aggregator.

Specified by:

supply in interface InvocableMap.StreamingAggregator

Returns:

a StreamAggregator

accumulate

public boolean accumulate(InvocableMap.Entry entry)

Description copied from interface: InvocableMap.StreamingAggregator

Accumulate one entry into the result.

Specified by:

accumulate in interface InvocableMap.StreamingAggregator

Parameters:

entry - the entry to accumulate into the aggregation result

Returns:

true to continue the aggregation, and false to signal to the caller that the result is ready and the aggregation can be short-circuited

combine

public boolean combine(Object partialResult)

Description copied from interface: InvocableMap.StreamingAggregator

Merge another partial result into the result.

Specified by:

combine in interface InvocableMap.StreamingAggregator

Parameters:

partialResult - the partial result to merge

Returns:

true to continue the aggregation, and false to signal to the caller that the result is ready and the aggregation can be short-circuited

getPartialResult

public Object getPartialResult()

Description copied from interface: InvocableMap.StreamingAggregator

Return the partial result of the aggregation.

Specified by:

getPartialResult in interface InvocableMap.StreamingAggregator

Returns:

the partial result of the aggregation

finalizeResult

public Object finalizeResult()

Description copied from interface: InvocableMap.StreamingAggregator

Return the final result of the aggregation.

Specified by:

finalizeResult in interface InvocableMap.StreamingAggregator

Returns:

the final result of the aggregation

characteristics

public int characteristics()

Description copied from interface: InvocableMap.StreamingAggregator

A bit mask representing the set of characteristics of this aggregator.

Be default, characteristics are a combination of InvocableMap.StreamingAggregator.PARALLEL and InvocableMap.StreamingAggregator.RETAINS_ENTRIES, which is sub-optimal and should be overridden by the aggregator implementation if the aggregator does not need to retain entries (which is often the case).

Specified by:

characteristics in interface InvocableMap.StreamingAggregator

Returns:

a bit mask representing the set of characteristics of this aggregator

See Also:

InvocableMap.StreamingAggregator.PARALLEL, InvocableMap.StreamingAggregator.SERIAL, InvocableMap.StreamingAggregator.BY_MEMBER, InvocableMap.StreamingAggregator.BY_PARTITION, InvocableMap.StreamingAggregator.RETAINS_ENTRIES, InvocableMap.StreamingAggregator.PRESENT_ONLY

process

protected void process(Object o)

readExternal

public void readExternal(DataInput in)
                  throws IOException

Description copied from interface: ExternalizableLite

Restore the contents of this object by loading the object's state from the passed DataInput object.

Specified by:

readExternal in interface ExternalizableLite

Parameters:

in - the DataInput stream to read data from in order to restore the state of this object

Throws:

IOException - if an I/O exception occurs

NotActiveException - if the object is not in its initial state, and therefore cannot be deserialized into

writeExternal

public void writeExternal(DataOutput out)
                   throws IOException

Description copied from interface: ExternalizableLite

Save the contents of this object by storing the object's state into the passed DataOutput object.

Specified by:

writeExternal in interface ExternalizableLite

Parameters:

out - the DataOutput stream to write the state of this object to

Throws:

IOException - if an I/O exception occurs

readExternal

public void readExternal(PofReader in)
                  throws IOException

Description copied from interface: PortableObject

Restore the contents of a user type instance by reading its state using the specified PofReader object.

Specified by:

readExternal in interface PortableObject

Parameters:

in - the PofReader from which to read the object's state

Throws:

IOException - if an I/O error occurs

writeExternal

public void writeExternal(PofWriter out)
                   throws IOException

Description copied from interface: PortableObject

Save the contents of a POF user type instance by writing its state using the specified PofWriter object.

Specified by:

writeExternal in interface PortableObject

Parameters:

out - the PofWriter to which to write the object's state

Throws:

IOException - if an I/O error occurs