eu.fthevenet.binjr.data.codec

Class CsvDecoder<T extends java.lang.Number>

java.lang.Object

eu.fthevenet.binjr.data.codec.CsvDecoder<T>

All Implemented Interfaces:

Decoder<T>

public class CsvDecoder<T extends java.lang.Number>
extends java.lang.Object
implements Decoder<T>

This class provides an implementation of a Decoder that decode data from a CSV formatted text stream into a TimeSeriesProcessor.

Author:

Frederic Thevenet

Constructor Summary

Constructors

Constructor and Description
CsvDecoder(java.lang.String encoding, char delimiter, TimeSeriesProcessorFactory<T> timeSeriesFactory, CheckedFunction<java.lang.String,T,DecodingDataFromAdapterException> numberParser, CheckedFunction<java.lang.String,java.time.ZonedDateTime,DecodingDataFromAdapterException> dateParser) Initializes a new instance of the CsvDecoder class.

Method Summary

Modifier and Type	Method and Description
void	decode(java.io.InputStream in, java.util.List<java.lang.String> headers, java.util.function.Consumer<DataSample<T>> mapToResult) Decodes data from the provided stream and invoke the provided Consumer for each decoded record.
java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>>	decode(java.io.InputStream in, java.util.List<TimeSeriesInfo<T>> seriesInfo) Decode a stream of data into a map of TimeSeriesProcessor instances.
java.util.List<java.lang.String>	getDataColumnHeaders(java.io.InputStream in) Returns the columns headers of the CSV file.
CheckedFunction<java.lang.String,java.time.ZonedDateTime,DecodingDataFromAdapterException>	getDateParser() Returns the function used to parse date fields.
char	getDelimiter() Returns the delimiter character used in the CSV file.
java.lang.String	getEncoding() Returns the encoding for the CSV file.
CheckedFunction<java.lang.String,T,DecodingDataFromAdapterException>	getNumberParser() Returns the function used to parse numeric fields.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvDecoder

public CsvDecoder(java.lang.String encoding,
                  char delimiter,
                  TimeSeriesProcessorFactory<T> timeSeriesFactory,
                  CheckedFunction<java.lang.String,T,DecodingDataFromAdapterException> numberParser,
                  CheckedFunction<java.lang.String,java.time.ZonedDateTime,DecodingDataFromAdapterException> dateParser)

Initializes a new instance of the CsvDecoder class.

Parameters:

encoding - the encoding used in the CSV stream

delimiter - the character to separate columns in the CSV stream

timeSeriesFactory - the factory used to fromUrl new TimeSeriesProcessor instances.

numberParser - the function used to parse numbers from the CSV stream

dateParser - the function used to parse dates from the CSV stream

Method Detail

getDataColumnHeaders

public java.util.List<java.lang.String> getDataColumnHeaders(java.io.InputStream in)
                                                      throws java.io.IOException,
                                                             DecodingDataFromAdapterException

Returns the columns headers of the CSV file.

Parameters:

in - an input stream for the CSV file.

Returns:

the columns headers of the CSV file.

Throws:

java.io.IOException - in the event of an I/O error.

DecodingDataFromAdapterException - if an error occurred while decoding the CSV file.

decode

public java.util.Map<TimeSeriesInfo<T>,TimeSeriesProcessor<T>> decode(java.io.InputStream in,
                                                                      java.util.List<TimeSeriesInfo<T>> seriesInfo)
                                                               throws java.io.IOException,
                                                                      DecodingDataFromAdapterException

Description copied from interface: Decoder

Decode a stream of data into a map of TimeSeriesProcessor instances.

Specified by:

decode in interface Decoder<T extends java.lang.Number>

Parameters:

in - the input stream to decode.

seriesInfo - the name of the series to extract from the stream

Returns:

a map of TimeSeriesProcessor instances.

Throws:

java.io.IOException - in the event of an IO error

DecodingDataFromAdapterException - in the event of an decoding error

decode

public void decode(java.io.InputStream in,
                   java.util.List<java.lang.String> headers,
                   java.util.function.Consumer<DataSample<T>> mapToResult)
            throws java.io.IOException,
                   DecodingDataFromAdapterException

Decodes data from the provided stream and invoke the provided Consumer for each decoded record.

Parameters:

in - the InputStream for the CSV file

headers - a list of the headers to keep from decoded records

mapToResult - the function to invoke for reach decoded record

Throws:

java.io.IOException - in the event of an I/O error.

DecodingDataFromAdapterException - if an error occurred while decoding the CSV file.

getEncoding

public java.lang.String getEncoding()

Returns the encoding for the CSV file.

Returns:

the encoding for the CSV file.

getDelimiter

public char getDelimiter()

Returns the delimiter character used in the CSV file.

Returns:

the delimiter character used in the CSV file.

getNumberParser

public CheckedFunction<java.lang.String,T,DecodingDataFromAdapterException> getNumberParser()

Returns the function used to parse numeric fields.

Returns:

the function used to parse numeric fields.

getDateParser

public CheckedFunction<java.lang.String,java.time.ZonedDateTime,DecodingDataFromAdapterException> getDateParser()

Returns the function used to parse date fields.

Returns:

the function used to parse date fields.