Package org.tribuo.data.columnar.processors.field

Enum Class DateFieldProcessor.DateFeatureType

java.lang.Object

java.lang.Enum<DateFieldProcessor.DateFeatureType>

org.tribuo.data.columnar.processors.field.DateFieldProcessor.DateFeatureType

All Implemented Interfaces:

Serializable, Comparable<DateFieldProcessor.DateFeatureType>, Constable

Enclosing class:

DateFieldProcessor

public static enum DateFieldProcessor.DateFeatureType
extends Enum<DateFieldProcessor.DateFeatureType>

The types of date features which can be extracted.

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
CALENDAR_QUARTER	The calendar quarter of the year.
DAY	The day.
DAY_OF_QUARTER	The day of the quarter.
DAY_OF_WEEK	The day of the week in ISO 8601.
DAY_OF_YEAR	The day of the year.
EVEN_OR_ODD_DAY	The parity of the day of the year.
EVEN_OR_ODD_MONTH	The parity of the month.
EVEN_OR_ODD_WEEK	The parity of the week of the year as defined by ISO 8601.
EVEN_OR_ODD_YEAR	The parity of the year.
MONTH	The month.
WEEK_OF_MONTH	The week of the month, as defined by ISO 8601 semantics for week of the year.
WEEK_OF_YEAR	The week of the year in ISO 8601.
YEAR	The year.

Method Summary

Modifier and Type	Method	Description
int	extract(LocalDate date)	Applies this enum's extraction function to the supplied date.
static DateFieldProcessor.DateFeatureType	valueOf(String name)	Returns the enum constant of this class with the specified name.
static DateFieldProcessor.DateFeatureType[]	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

DAY_OF_WEEK

public static final DateFieldProcessor.DateFeatureType DAY_OF_WEEK

The day of the week in ISO 8601.

WEEK_OF_YEAR

public static final DateFieldProcessor.DateFeatureType WEEK_OF_YEAR

The week of the year in ISO 8601.

WEEK_OF_MONTH

public static final DateFieldProcessor.DateFeatureType WEEK_OF_MONTH

The week of the month, as defined by ISO 8601 semantics for week of the year.

DAY_OF_YEAR

public static final DateFieldProcessor.DateFeatureType DAY_OF_YEAR

The day of the year.

EVEN_OR_ODD_DAY

public static final DateFieldProcessor.DateFeatureType EVEN_OR_ODD_DAY

The parity of the day of the year.

EVEN_OR_ODD_WEEK

public static final DateFieldProcessor.DateFeatureType EVEN_OR_ODD_WEEK

The parity of the week of the year as defined by ISO 8601.

EVEN_OR_ODD_MONTH

public static final DateFieldProcessor.DateFeatureType EVEN_OR_ODD_MONTH

The parity of the month.

EVEN_OR_ODD_YEAR

public static final DateFieldProcessor.DateFeatureType EVEN_OR_ODD_YEAR

The parity of the year.

CALENDAR_QUARTER

public static final DateFieldProcessor.DateFeatureType CALENDAR_QUARTER

The calendar quarter of the year.

DAY_OF_QUARTER

public static final DateFieldProcessor.DateFeatureType DAY_OF_QUARTER

The day of the quarter.

DAY

public static final DateFieldProcessor.DateFeatureType DAY

The day.

MONTH

public static final DateFieldProcessor.DateFeatureType MONTH

The month.

YEAR

public static final DateFieldProcessor.DateFeatureType YEAR

The year.

Method Details

values

public static DateFieldProcessor.DateFeatureType[] 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 DateFieldProcessor.DateFeatureType 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

extract

public int extract(LocalDate date)

Applies this enum's extraction function to the supplied date.

Parameters:

date - The date to extract from.

Returns:

The output of the extraction function.