tech.bitey.dataframe

Enum DateSeriesFactory

java.lang.Object

java.lang.Enum<DateSeriesFactory>

tech.bitey.dataframe.DateSeriesFactory

All Implemented Interfaces:

Serializable, Comparable<DateSeriesFactory>

public enum DateSeriesFactory
extends Enum<DateSeriesFactory>

Factory methods for creating DateSeries.

Author:

biteytech@protonmail.com

Method Summary

Modifier and Type	Method and Description
static DateSeries	create(DateColumn dates, DoubleColumn values) Returns a DateSeries with the specified dates and values, using the default column names: "DATES" and "VALUES"
static DateSeries	create(DateColumn dates, String dateColumnName, DoubleColumn values, String valueColumnName) Returns a DateSeries with the specified dates, values, and column names.
static DateSeries	readFrom(File file) Load a time series from a file created via DataFrame.writeTo(File).
static DateSeries	readFrom(ReadableByteChannel channel) Read a time series from the specified ReadableByteChannel.
static DateSeriesFactory	valueOf(String name) Returns the enum constant of this type with the specified name.
static DateSeriesFactory[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

values

public static DateSeriesFactory[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (DateSeriesFactory c : DateSeriesFactory.values())
    System.out.println(c);

Returns:

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

valueOf

public static DateSeriesFactory valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

create

public static DateSeries create(DateColumn dates,
                                DoubleColumn values)

Returns a DateSeries with the specified dates and values, using the default column names: "DATES" and "VALUES"

Parameters:

dates - - the dates

values - - the values

Returns:

a DateSeries with the specified dates and values.

create

public static DateSeries create(DateColumn dates,
                                String dateColumnName,
                                DoubleColumn values,
                                String valueColumnName)

Returns a DateSeries with the specified dates, values, and column names.

Parameters:

dates - - the dates

dateColumnName - - the date column name

values - - the values

valueColumnName - - the value column name

Returns:

a DateSeries with the specified dates and values.

readFrom

public static DateSeries readFrom(File file)
                           throws IOException

Load a time series from a file created via DataFrame.writeTo(File).

Parameters:

file - - the file to read from

Returns:

the time series loaded from the specified file

Throws:

IOException - if some I/O error occurs

readFrom

public static DateSeries readFrom(ReadableByteChannel channel)
                           throws IOException

Read a time series from the specified ReadableByteChannel.

Parameters:

channel - - the channel to read from

Returns:

the time series read from the specified channel

Throws:

IOException - if some I/O error occurs