com.github.rollingmetrics.ranking

Interface Ranking<T>

Type Parameters:

T -

All Known Implementing Classes:

ResetByChunksRanking, ResetOnSnapshotRanking, SnapshotCachingRanking, UniformRanking

public interface Ranking<T>

The ranking of queries sorted by its latency. The top is sized, independent of count of recorded queries, the top always stores no more than getSize() positions, the longer queries displace shorter queries when ranking reaches it max size.

Method Summary

Modifier and Type	Method and Description
static RankingBuilder	builder(int size) Creates new instance of RankingBuilder
List<Position>	getPositionsInDescendingOrder() Returns the top of queries in descend order, slowest query will be at first place.
int	getSize()
void	update(long weight, T identity) Updates the ranking positions.

Method Detail

builder

static RankingBuilder builder(int size)

Creates new instance of RankingBuilder

Parameters:

size - maximum count of positions in the ranking

Returns:

new instance of RankingBuilder

update

void update(long weight,
            T identity)

Updates the ranking positions.

Parameters:

weight - the weight of query

identity - the identity by which one query can be distinguished from another.

getPositionsInDescendingOrder

List<Position> getPositionsInDescendingOrder()

Returns the top of queries in descend order, slowest query will be at first place. The size of returned list can be less then getSize() if not enough count of quires were recorded.

Returns:

the top of queries in descend order.

getSize

int getSize()

Returns:

the maximum count of positions that can be stored in the ranking.