Package io.goobi.viewer.model.statistics.usage

Class StatisticsSummary

java.lang.Object

io.goobi.viewer.model.statistics.usage.StatisticsSummary

public class StatisticsSummary
extends Object

Summary of request counts for a certain date range. Used for delivering record counts to users

Author:

Florian Alpers

Constructor Summary

Constructors

Constructor	Description
StatisticsSummary()
StatisticsSummary(DailySessionUsageStatistics dailyStats)	Constructor to create an instance from a DailySessionUsageStatistics object.
StatisticsSummary(DailySessionUsageStatistics dailyStats, List<String> includedIdentifiers)	Constructor to create an instance from a DailySessionUsageStatistics object filtered by a list of record identifiers.
StatisticsSummary(Map<RequestType,RequestTypeSummary> types)	Default constructor.

Method Summary

Modifier and Type	Method	Description
StatisticsSummary	add(StatisticsSummary other)	Creates a new summary with the sum of request counts from this and another summary.
String	calculateEndDate()
String	calculateStartDate()
static StatisticsSummary	empty()	Creates an empty summary.
String	getAsCsv(Locale locale, String separator)
LocalDateTime	getCreationTime()
UsageStatisticsInformation	getInformation()
LocalDate	getLastRecordedDate(RequestType... types)	Gets the last date for which requests have been recorded.
long	getTotalRequests(RequestType... types)	Get the total amount for requests for a given RequestType.
Map<RequestType,RequestTypeSummary>	getTypes()	Get the request counts sorted by RequestType.
long	getUniqueRequests(RequestType... types)	Get the number of unique request for a given RequestType.
boolean	isEmpty()
boolean	isOlderThan(long num, TemporalUnit unit)
boolean	isOlderThan(long num, TemporalUnit unit, Temporal currentTime)
void	setInformation(UsageStatisticsInformation info)

Methods inherited from class java.lang.Object

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

Constructor Details

StatisticsSummary

public StatisticsSummary()

StatisticsSummary

public StatisticsSummary(Map<RequestType,RequestTypeSummary> types)

Default constructor.

Parameters:

types - Request counts sorted by RequestType

StatisticsSummary

public StatisticsSummary(DailySessionUsageStatistics dailyStats)

Constructor to create an instance from a DailySessionUsageStatistics object.

Parameters:

dailyStats - The DailySessionUsageStatistics from which to retrieve the request counts

StatisticsSummary

public StatisticsSummary(DailySessionUsageStatistics dailyStats,
 List<String> includedIdentifiers)

Constructor to create an instance from a DailySessionUsageStatistics object filtered by a list of record identifiers.

Parameters:

dailyStats - The DailySessionUsageStatistics from which to retrieve the request counts

includedIdentifiers - A list of record identifiers for which to count the requests. If empty, all requests will be counted

Method Details

empty

public static StatisticsSummary empty()

Creates an empty summary.

Returns:

an empty StatisticsSummary

getTypes

public Map<RequestType,RequestTypeSummary> getTypes()

Get the request counts sorted by RequestType.

Returns:

a Map

add

public StatisticsSummary add(StatisticsSummary other)

Creates a new summary with the sum of request counts from this and another summary.

Parameters:

other - the other SummaryStatistics to add to this one

Returns:

the sum of SummaryStatistics

getTotalRequests

public long getTotalRequests(RequestType... types)

Get the total amount for requests for a given RequestType.

Parameters:

types - the RequestTypes to count

Returns:

number of requests

getUniqueRequests

public long getUniqueRequests(RequestType... types)

Get the number of unique request for a given RequestType.

Parameters:

types - the RequestTypes to count

Returns:

number of unique requests

getLastRecordedDate

public LocalDate getLastRecordedDate(RequestType... types)

Gets the last date for which requests have been recorded.

Parameters:

types - the RequestType to check

Returns:

LocalDate

getAsCsv

public String getAsCsv(Locale locale,
 String separator)

calculateStartDate

public String calculateStartDate()

calculateEndDate

public String calculateEndDate()

isEmpty

public boolean isEmpty()

setInformation

public void setInformation(UsageStatisticsInformation info)

getInformation

public UsageStatisticsInformation getInformation()

isOlderThan

public boolean isOlderThan(long num,
 TemporalUnit unit)

isOlderThan

public boolean isOlderThan(long num,
 TemporalUnit unit,
 Temporal currentTime)

getCreationTime

public LocalDateTime getCreationTime()