Package io.revealbi.core

Enum Class RVPeriodRelation

java.lang.Object

java.lang.Enum<RVPeriodRelation>

io.revealbi.core.RVPeriodRelation

All Implemented Interfaces:

Serializable, Comparable<RVPeriodRelation>, Constable

public enum RVPeriodRelation
extends Enum<RVPeriodRelation>

Represents the relation of a period to the current date, for use in date rules.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ALL	All time
LAST	Last [period] = 1 [period] ago until today
NEXT	Next [period] = beginning of next [period] until end of next [period]
PREVIOUS	Previous [period] = beginning of last [period] until end of last [period].
THIS	This [period] = beginning of current [period] until end of current [period]
TO_DATE	[period] to date = beginning of current [period] until today

Method Summary

Modifier and Type	Method	Description
String	getSerializationFriendlyName()
static RVPeriodRelation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static RVPeriodRelation[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ALL

public static final RVPeriodRelation ALL

All time

LAST

public static final RVPeriodRelation LAST

Last [period] = 1 [period] ago until today

PREVIOUS

public static final RVPeriodRelation PREVIOUS

Previous [period] = beginning of last [period] until end of last [period]. When going back a certain amount of months, quarters, semesters or years causes the day component to exceed the resulting month's duration, the day will be adjusted to fit.

TO_DATE

public static final RVPeriodRelation TO_DATE

[period] to date = beginning of current [period] until today

THIS

public static final RVPeriodRelation THIS

This [period] = beginning of current [period] until end of current [period]

NEXT

public static final RVPeriodRelation NEXT

Next [period] = beginning of next [period] until end of next [period]

Method Details

values

public static RVPeriodRelation[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static RVPeriodRelation valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null

getSerializationFriendlyName

public String getSerializationFriendlyName()