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

Class StatisticsSummaryFilter

java.lang.Object

io.goobi.viewer.model.statistics.usage.StatisticsSummaryFilter

public final class StatisticsSummaryFilter
extends Object

A class holding values by which a StatisticsSummary instance should be filtered

Author:

florian

Field Summary

Fields

Modifier and Type	Field	Description
static final LocalDate	LOCAL_DATE_MAX	LOCAL_DATE_MAX is not accepted as date by SQL, so this is the max date to use, 3000-12-31
static final LocalDate	LOCAL_DATE_MIN	LOCAL_DATE_MIN is not accepted as date by SQL, so this is the min date to use, 0000-01-01

Method Summary

Modifier and Type	Method	Description
static StatisticsSummaryFilter	forRecord(String pi)	Create an instance for a single record identifier
LocalDate	getEndDate()
String	getFilterQuery()
LocalDate	getStartDate()
boolean	hasEndDateRestriction()	Check if a endDate has been set for this filter
boolean	hasFilterQuery()	Check if a SOLR query has been set for the filter
boolean	hasStartDateRestriction()	Check if a startDate has been set for this filter
boolean	isDateRange()	Check if the filter is set for a range of dates
static StatisticsSummaryFilter	of(LocalDate start, LocalDate end, String query)	Create an instance of a date range and a SOLR query
static StatisticsSummaryFilter	ofDate(LocalDate date)	Create an instance filtering by a single date
static StatisticsSummaryFilter	ofDateRange(LocalDate start, LocalDate end)	Create an instance for a range of dates
static StatisticsSummaryFilter	ofDigitalCollection(String collectionName)	Create an instance for all records within a single digital collection
static StatisticsSummaryFilter	ofQuery(String query)	Create an instance for all records returned by a SOLR query

Methods inherited from class java.lang.Object

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

Field Details

LOCAL_DATE_MIN

public static final LocalDate LOCAL_DATE_MIN

LOCAL_DATE_MIN is not accepted as date by SQL, so this is the min date to use, 0000-01-01

LOCAL_DATE_MAX

public static final LocalDate LOCAL_DATE_MAX

LOCAL_DATE_MAX is not accepted as date by SQL, so this is the max date to use, 3000-12-31

Method Details

getStartDate

public LocalDate getStartDate()

Returns:

the startDate

getEndDate

public LocalDate getEndDate()

Returns:

the endDate

getFilterQuery

public String getFilterQuery()

Returns:

the filterQuery

ofDate

public static StatisticsSummaryFilter ofDate(LocalDate date)

Create an instance filtering by a single date

Parameters:

date -

Returns:

StatisticsSummaryFilter

ofDateRange

public static StatisticsSummaryFilter ofDateRange(LocalDate start,
 LocalDate end)

Create an instance for a range of dates

Parameters:

start - the first date to include

end - the last date to include

Returns:

StatisticsSummaryFilter

forRecord

public static StatisticsSummaryFilter forRecord(String pi)

Create an instance for a single record identifier

Parameters:

pi -

Returns:

StatisticsSummaryFilter

ofDigitalCollection

public static StatisticsSummaryFilter ofDigitalCollection(String collectionName)

Create an instance for all records within a single digital collection

Parameters:

collectionName -

Returns:

StatisticsSummaryFilter

ofQuery

public static StatisticsSummaryFilter ofQuery(String query)

Create an instance for all records returned by a SOLR query

Parameters:

query - the SOLR query returning all record identifiers which to include in the summary

Returns:

StatisticsSummaryFilter

of

public static StatisticsSummaryFilter of(LocalDate start,
 LocalDate end,
 String query)

Create an instance of a date range and a SOLR query

Parameters:

start - the first date to include

end - the last date to include

query - the SOLR query returning all record identifiers which to include in the summary

Returns:

StatisticsSummaryFilter

hasStartDateRestriction

public boolean hasStartDateRestriction()

Check if a startDate has been set for this filter

Returns:

true if a startDate has been set

hasEndDateRestriction

public boolean hasEndDateRestriction()

Check if a endDate has been set for this filter

Returns:

true if a endDate has been set

isDateRange

public boolean isDateRange()

Check if the filter is set for a range of dates

Returns:

true if the filter is set for a range of dates (more than a single date

hasFilterQuery

public boolean hasFilterQuery()

Check if a SOLR query has been set for the filter

Returns:

true if a filterQuery has been set for this filter