DateRange (SIRIUS db 5.0-rc9 API)

java.lang.Object
- sirius.db.mixing.DateRange

```
public class DateRange
extends Object
```
Represents a date range which will collect and count all matching entities in a query to provide an appropriate facet filter.

Constructor Summary

Constructors
Constructor and Description
`DateRange(String key, String name, LocalDateTime from, LocalDateTime until)` Creates a new DateRange with the given unique key, translated (shown) name and two dates specifying the range

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`applyTo(String field, Query<?,?,?> qry)` Applies this date range to the given query in the given field.
`static DateRange`	`beforeLastYear()` Creates a date range filtering on everything before the last year.
`static DateRange`	`beforeThisYear()` Creates a date range filtering on everything before this year.
`LocalDateTime`	`getFrom()`
`String`	`getKey()`
`LocalDateTime`	`getUntil()`
`static DateRange`	`lastFiveMinutes()` Creates a date range filtering on the last five minutes.
`static DateRange`	`lastFiveteenMinutes()` Creates a date range filtering on the last 15 minutes.
`static DateRange`	`lastHour()` Creates a date range filtering on the last hour.
`static DateRange`	`lastMonth()` Creates a date range filtering on the last month.
`static DateRange`	`lastTwoHours()` Creates a date range filtering on the last two hours.
`static DateRange`	`lastWeek()` Creates a date range filtering on the last week.
`static DateRange`	`lastYear()` Creates a date range filtering on the last year.
`static DateRange`	`thisMonth()` Creates a date range filtering on the current month.
`static DateRange`	`thisWeek()` Creates a date range filtering on this week.
`static DateRange`	`thisYear()` Creates a date range filtering on the current year.
`static DateRange`	`today()` Creates a date range filtering on "today".
`String`	`toString()`
`DateRange`	`useLocalDate()` Can be used if the `DateRange` should be used on a database field of type `LocalDate` and not `LocalDateTime`.
`static DateRange`	`yesterday()` Creates a date range filtering on "yesterday".

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - DateRange
```
public DateRange(String key,
                 String name,
                 @Nullable
                 LocalDateTime from,
                 @Nullable
                 LocalDateTime until)
```
    Creates a new DateRange with the given unique key, translated (shown) name and two dates specifying the range
    
    Parameters:
    
    key - the unique name of the ranged used as filter value
    
    name - the translated name shown to the user
    
    from - the lower limit (including) of the range
    
    until - the upper limit (including) of the range
- Method Detail
  - lastFiveMinutes
```
public static DateRange lastFiveMinutes()
```
    Creates a date range filtering on the last five minutes.
    
    Returns:
    
    a date range for the given interval
  - lastFiveteenMinutes
```
public static DateRange lastFiveteenMinutes()
```
    Creates a date range filtering on the last 15 minutes.
    
    Returns:
    
    a date range for the given interval
  - lastHour
```
public static DateRange lastHour()
```
    Creates a date range filtering on the last hour.
    
    Returns:
    
    a date range for the given interval
  - lastTwoHours
```
public static DateRange lastTwoHours()
```
    Creates a date range filtering on the last two hours.
    
    Returns:
    
    a date range for the given interval
  - today
```
public static DateRange today()
```
    Creates a date range filtering on "today".
    
    Returns:
    
    a date range for the given interval
  - yesterday
```
public static DateRange yesterday()
```
    Creates a date range filtering on "yesterday".
    
    Returns:
    
    a date range for the given interval
  - thisWeek
```
public static DateRange thisWeek()
```
    Creates a date range filtering on this week.
    
    Returns:
    
    a date range for the given interval
  - lastWeek
```
public static DateRange lastWeek()
```
    Creates a date range filtering on the last week.
    
    Returns:
    
    a date range for the given interval
  - thisMonth
```
public static DateRange thisMonth()
```
    Creates a date range filtering on the current month.
    
    Returns:
    
    a date range for the given interval
  - lastMonth
```
public static DateRange lastMonth()
```
    Creates a date range filtering on the last month.
    
    Returns:
    
    a date range for the given interval
  - thisYear
```
public static DateRange thisYear()
```
    Creates a date range filtering on the current year.
    
    Returns:
    
    a date range for the given interval
  - lastYear
```
public static DateRange lastYear()
```
    Creates a date range filtering on the last year.
    
    Returns:
    
    a date range for the given interval
  - beforeThisYear
```
public static DateRange beforeThisYear()
```
    Creates a date range filtering on everything before this year.
    
    Returns:
    
    a date range for the given interval
  - beforeLastYear
```
public static DateRange beforeLastYear()
```
    Creates a date range filtering on everything before the last year.
    
    Returns:
    
    a date range for the given interval
  - useLocalDate
```
public DateRange useLocalDate()
```
    Can be used if the DateRange should be used on a database field of type LocalDate and not LocalDateTime.
    
    Returns:
    
    the DateRange object itself for fluent method calls
  - getKey
```
public String getKey()
```
  - getFrom
```
public LocalDateTime getFrom()
```
  - getUntil
```
public LocalDateTime getUntil()
```
  - applyTo
```
public void applyTo(String field,
                    Query<?,?,?> qry)
```
    Applies this date range to the given query in the given field.
    
    Parameters:
    
    field - the field to filter on
    
    qry - the query to expand
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class DateRange

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DateRange

Method Detail

lastFiveMinutes

lastFiveteenMinutes

lastHour

lastTwoHours

today

yesterday

thisWeek

lastWeek

thisMonth

lastMonth

thisYear

lastYear

beforeThisYear

beforeLastYear

useLocalDate

getKey

getFrom

getUntil

applyTo

toString