hivis.data.reader

Class SpreadSheetReader.Config

java.lang.Object

hivis.data.reader.SpreadSheetReader.Config

All Implemented Interfaces:

Cloneable

Enclosing class:

SpreadSheetReader

public static class SpreadSheetReader.Config
extends Object
implements Cloneable

Defines the configuration for a SpreadSheetReader.

Field Summary

Fields

Modifier and Type	Field and Description
static int	AUTO
static int	CSV
static int	EXCEL
static int	NONE

Constructor Summary

Constructors

Constructor and Description
Config()

Method Summary

Modifier and Type	Method and Description
SpreadSheetReader.Config	columnCount(int columnCount) Set the number of columns to extract, or AUTO to read up to the last column.
SpreadSheetReader.Config	columnIndex(int columnIndex) Set the (zero-based) index of the column to start creating series from.
SpreadSheetReader.Config	copy() Creates a copy of this Config.
SpreadSheetReader.Config	csvQuote(String csvQuote) Set the value quote character, only applicable for CSV format.
SpreadSheetReader.Config	csvSeparator(String csvSeparator) Set the value separator character, only applicable for CSV format.
SpreadSheetReader.Config	dateFormats(String... formats) Set custom date/time formats for parsing dates, only applicable for CSV format.
SpreadSheetReader.Config	doublePrecision(boolean doublePrecision) Set whether numeric series should be created as DataSeries<Double> (true), or as DataSeries<Float> (false).
SpreadSheetReader.Config	fileFormat(int fileFormat) Set the format of the data, options are AUTO, EXCEL, CSV.
SpreadSheetReader.Config	headerRowIndex(int headerRowIndex) Set the (zero-based) index of the row to use as column headers, or AUTO or NONE.
SpreadSheetReader.Config	ignoreColumnsWithNoHeader(boolean ignoreColumnsWithNoHeader) Set whether to ignore columns that have an empty header value.
SpreadSheetReader.Config	rowCount(int rowCount) Set the number of rows to extract (not including header), or AUTO to read to the end of the sheet.
SpreadSheetReader.Config	rowIndex(int rowIndex) Set the zero-based index of the row to start reading data from.
SpreadSheetReader.Config	sheetIndex(int sheetIndex) Set the (zero-based) index of the sheet in the spreadsheet to read from (if applicable).
SpreadSheetReader.Config	sourceFile(File sourceFile) Set the file to read data from.
SpreadSheetReader.Config	sourceFile(String sourceFile) Set the file to read data from.
SpreadSheetReader.Config	useDeprecatedDates(boolean useDeprecatedDates) Set whether to use the (now deprecated) java.util.Date objects to represent dates/times (true), instead of java.time.temporal.TemporalAccessor (false).

Methods inherited from class java.lang.Object

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

Field Detail

AUTO

public static final int AUTO

See Also:

Constant Field Values

NONE

public static final int NONE

See Also:

Constant Field Values

EXCEL

public static final int EXCEL

See Also:

Constant Field Values

CSV

public static final int CSV

See Also:

Constant Field Values

Constructor Detail

Config

public Config()

Method Detail

sourceFile

public SpreadSheetReader.Config sourceFile(File sourceFile)

Set the file to read data from.

sourceFile

public SpreadSheetReader.Config sourceFile(String sourceFile)

Set the file to read data from.

fileFormat

public SpreadSheetReader.Config fileFormat(int fileFormat)

Set the format of the data, options are AUTO, EXCEL, CSV.

See Also:

csvSeparator, csvQuote

sheetIndex

public SpreadSheetReader.Config sheetIndex(int sheetIndex)

Set the (zero-based) index of the sheet in the spreadsheet to read from (if applicable).

headerRowIndex

public SpreadSheetReader.Config headerRowIndex(int headerRowIndex)

Set the (zero-based) index of the row to use as column headers, or AUTO or NONE. Default is AUTO.

rowIndex

public SpreadSheetReader.Config rowIndex(int rowIndex)

Set the zero-based index of the row to start reading data from. Default is 0.

rowCount

public SpreadSheetReader.Config rowCount(int rowCount)

Set the number of rows to extract (not including header), or AUTO to read to the end of the sheet.

columnIndex

public SpreadSheetReader.Config columnIndex(int columnIndex)

Set the (zero-based) index of the column to start creating series from. Default is 0.

columnCount

public SpreadSheetReader.Config columnCount(int columnCount)

Set the number of columns to extract, or AUTO to read up to the last column.

doublePrecision

public SpreadSheetReader.Config doublePrecision(boolean doublePrecision)

Set whether numeric series should be created as DataSeries<Double> (true), or as DataSeries<Float> (false).

ignoreColumnsWithNoHeader

public SpreadSheetReader.Config ignoreColumnsWithNoHeader(boolean ignoreColumnsWithNoHeader)

Set whether to ignore columns that have an empty header value. Only applicable when a header row has been set (manually or automatically detected).

csvSeparator

public SpreadSheetReader.Config csvSeparator(String csvSeparator)

Set the value separator character, only applicable for CSV format. Use "\t" for tab-separated (TSV). Default is "," (CSV).

csvQuote

public SpreadSheetReader.Config csvQuote(String csvQuote)

Set the value quote character, only applicable for CSV format. Default is ".

dateFormats

public SpreadSheetReader.Config dateFormats(String... formats)

Set custom date/time formats for parsing dates, only applicable for CSV format. See https://docs.oracle.com/javase/7/docs/api/java/text/SimpleDateFormat.html

useDeprecatedDates

public SpreadSheetReader.Config useDeprecatedDates(boolean useDeprecatedDates)

Set whether to use the (now deprecated) java.util.Date objects to represent dates/times (true), instead of java.time.temporal.TemporalAccessor (false). Default is false.

copy

public SpreadSheetReader.Config copy()

Creates a copy of this Config.