tech.bitey.dataframe

Class DateSeriesBuilder

java.lang.Object

tech.bitey.dataframe.DateSeriesBuilder

public class DateSeriesBuilder
extends Object

A builder for creating DateSeries instances. Example:

 DateSeries ds = DateSeriesBuilder.builder().add(LocalDate.now(), 1).add(LocalDate.now().plusDays(1), 2).build();
 

The resulting DateSeries will be sorted by date regardless of the order the points were added in.

Builder instances can be reused; it is safe to call build multiple times to build multiple time series. Each new series contains all the points of the ones created before it.

Author:

biteytech@protonmail.com

Constructor Summary

Constructors

Constructor and Description
DateSeriesBuilder() Create a bulider with the default column names ("DATES" and "VALUES").
DateSeriesBuilder(String dateColumnName, String valueColumnName) Create a bulider with the specified column names.

Method Summary

Modifier and Type	Method and Description
DateSeriesBuilder	add(int yyyymmdd, double value) Add a point to this time series.
DateSeriesBuilder	add(int year, int month, int day, double value) Add a point to this time series.
DateSeriesBuilder	add(LocalDate date, double value) Add a point to this time series.
DateSeries	build() Sorts the added points by date and returns a new DateSeries.

Methods inherited from class java.lang.Object

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

Constructor Detail

DateSeriesBuilder

public DateSeriesBuilder()

Create a bulider with the default column names ("DATES" and "VALUES").

DateSeriesBuilder

public DateSeriesBuilder(String dateColumnName,
                         String valueColumnName)

Create a bulider with the specified column names.

Parameters:

dateColumnName - - the date column name

valueColumnName - - the value column name

Method Detail

add

public DateSeriesBuilder add(int year,
                             int month,
                             int day,
                             double value)

Add a point to this time series.

Parameters:

year - - the year

month - - the month (1-based)

day - - the day (1-based)

value - - the value

Returns:

this builder

add

public DateSeriesBuilder add(int yyyymmdd,
                             double value)

Add a point to this time series.

Parameters:

yyyymmdd - - the date in yyyymmdd format

value - - the value

Returns:

this builder

add

public DateSeriesBuilder add(LocalDate date,
                             double value)

Add a point to this time series.

Parameters:

date - - the date

value - - the value

Returns:

this builder

Throws:

NullPointerException - if date is null

build

public DateSeries build()

Sorts the added points by date and returns a new DateSeries.

Returns:

a new DateSeries

Throws:

IllegalStateException - if the dates are not all distinct