Package yearreview.app.data.processor.toplist

Class TopListGenerator

java.lang.Object

yearreview.app.data.processor.toplist.TopListGenerator

public class TopListGenerator
extends Object

Generates a TopList of TopListElements by sorting them by their associated Value.

Author:

ColdStone37

Field Summary

Fields

Modifier and Type	Field	Description
private final TopListAdapter	adapter	Adapter used to get the TopListElements from a DataSource.
private final TopListElementComparator	comparator	Comparator used to sort the TopListElements.
private final int	topListLength	Length of the TopList to generate.

Constructor Summary

Constructors

Constructor	Description
TopListGenerator(TopListAdapter adapter, int topListLength, ValueType sortingValue)	Constructs a new TopListGenerator from an Adapter and a length.

Method Summary

Modifier and Type	Method	Description
List<TopListElement>	getTopList(Instant t)	Gets a List of TopListElements sorted by their Values of at most size topListLength.

Methods inherited from class java.lang.Object

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

Field Details

adapter

private final TopListAdapter adapter

Adapter used to get the TopListElements from a DataSource.

topListLength

private final int topListLength

Length of the TopList to generate.

comparator

private final TopListElementComparator comparator

Comparator used to sort the TopListElements.

Constructor Details

TopListGenerator

public TopListGenerator(TopListAdapter adapter,
 int topListLength,
 ValueType sortingValue)

Constructs a new TopListGenerator from an Adapter and a length.

Parameters:

adapter - Adapter to use for getting the data from a DataSource

topListLength - Length of the TopList to generate

sortingValue - type of Value to sort by

Method Details

getTopList

public List<TopListElement> getTopList(Instant t)

Gets a List of TopListElements sorted by their Values of at most size topListLength.

Parameters:

t - time until which to generate the TopList

Returns:

TopList of the elements