org.springframework.analytics.metrics

Interface FieldValueCounterWriter

All Known Subinterfaces:

FieldValueCounterRepository

All Known Implementing Classes:

InMemoryFieldValueCounterRepository, RedisFieldValueCounterRepository

public interface FieldValueCounterWriter

Contains operations to modify and reset FieldValueCounter instances. The name is the id and should be unique.

Author:

Mark Pollack, Ilayaperumal Gopinathan

Method Summary

Methods

Modifier and Type	Method and Description
void	decrement(String name, String fieldName, double score) Decrement the FieldValueCounter for a given field name by score, creating missing counters.
void	increment(String name, String fieldName, double score) Increment the FieldValueCounter for a given field name by score, creating missing counters.
void	reset(String name) Reset the given FieldValueCounter.

Method Detail

increment

void increment(String name,
             String fieldName,
             double score)

Increment the FieldValueCounter for a given field name by score, creating missing counters.

Parameters:

name - the FieldValueCounter name

fieldName - the name of the field

score - the incremental value

Throws:

IllegalArgumentException - in case the given name is null

decrement

void decrement(String name,
             String fieldName,
             double score)

Decrement the FieldValueCounter for a given field name by score, creating missing counters.

Parameters:

name - the FieldValueCounter name

fieldName - the name of the field

score - the decremental value

Throws:

IllegalArgumentException - in case the given name is null

reset

void reset(String name)

Reset the given FieldValueCounter.

Parameters:

name - the FieldValueCounter name