CsvReadOptions.Builder (tablesaw-core 0.37.1 API)

java.lang.Object
- tech.tablesaw.io.ReadOptions.Builder
- - tech.tablesaw.io.csv.CsvReadOptions.Builder

Enclosing class:: CsvReadOptions

public static class CsvReadOptions.Builder
extends ReadOptions.Builder

Field Summary
- Fields inherited from class tech.tablesaw.io.ReadOptions.Builder
  columnTypesToDetect, dateFormat, dateFormatter, dateTimeFormat, dateTimeFormatter, header, locale, maxCharsPerColumn, minimizeColumnSizes, missingValueIndicator, sample, source, tableName, timeFormat, timeFormatter

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Builder(File file)`
`protected`	`Builder(InputStream stream)`
`protected`	`Builder(Reader reader)`
`protected`	`Builder(Source source)`
`protected`	`Builder(URL url)`

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`CsvReadOptions`	`build()`
`CsvReadOptions.Builder`	`columnTypes(ColumnType[] columnTypes)`
`CsvReadOptions.Builder`	`commentPrefix(Character commentPrefix)`
`CsvReadOptions.Builder`	`dateFormat(DateTimeFormatter dateFormat)`
`CsvReadOptions.Builder`	`dateFormat(String dateFormat)` Deprecated.
`CsvReadOptions.Builder`	`dateTimeFormat(DateTimeFormatter dateTimeFormat)`
`CsvReadOptions.Builder`	`dateTimeFormat(String dateTimeFormat)` Deprecated.
`CsvReadOptions.Builder`	`header(boolean header)`
`CsvReadOptions.Builder`	`lineEnding(String lineEnding)`
`CsvReadOptions.Builder`	`locale(Locale locale)`
`CsvReadOptions.Builder`	`maxCharsPerColumn(int maxCharsPerColumn)`
`CsvReadOptions.Builder`	`maxNumberOfColumns(Integer maxNumberOfColumns)` Defines maximal value of columns in csv file.
`CsvReadOptions.Builder`	`minimizeColumnSizes()` Allow the `ColumnTypeDetector` to choose shorter column types such as float instead of double when the data will fit in a smaller type
`CsvReadOptions.Builder`	`missingValueIndicator(String missingValueIndicator)`
`CsvReadOptions.Builder`	`quoteChar(Character quoteChar)`
`CsvReadOptions.Builder`	`sample(boolean sample)`
`CsvReadOptions.Builder`	`sampleSize(int numSamples)` Defines the maximum number of rows to be read from the file.
`CsvReadOptions.Builder`	`separator(Character separator)`
`CsvReadOptions.Builder`	`tableName(String tableName)`
`CsvReadOptions.Builder`	`timeFormat(DateTimeFormatter timeFormat)`
`CsvReadOptions.Builder`	`timeFormat(String timeFormat)` Deprecated.

Methods inherited from class tech.tablesaw.io.ReadOptions.Builder
columnTypesToDetect

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Builder
```
protected Builder(Source source)
```
  - Builder
```
protected Builder(URL url)
           throws IOException
```
    Throws:
    
    IOException
  - Builder
```
protected Builder(File file)
```
  - Builder
```
protected Builder(Reader reader)
```
  - Builder
```
protected Builder(InputStream stream)
```
- Method Detail
  - columnTypes
```
public CsvReadOptions.Builder columnTypes(ColumnType[] columnTypes)
```
  - separator
```
public CsvReadOptions.Builder separator(Character separator)
```
  - quoteChar
```
public CsvReadOptions.Builder quoteChar(Character quoteChar)
```
  - lineEnding
```
public CsvReadOptions.Builder lineEnding(String lineEnding)
```
  - maxNumberOfColumns
```
public CsvReadOptions.Builder maxNumberOfColumns(Integer maxNumberOfColumns)
```
    Defines maximal value of columns in csv file.
    
    Parameters:
    
    maxNumberOfColumns - - must be positive integer. Default is 512.
  - commentPrefix
```
public CsvReadOptions.Builder commentPrefix(Character commentPrefix)
```
  - sampleSize
```
public CsvReadOptions.Builder sampleSize(int numSamples)
```
    Defines the maximum number of rows to be read from the file. Sampling is performed in a single pass using the reservoir sampling algorithm (https://en.wikipedia.org/wiki/Reservoir_sampling). Given a file with 'n' rows, if 'numSamples is smaller than 'n', than exactly 'numSamples' random samples are returned; if 'numSamples' is greater than 'n', then only 'n' samples are returned (no oversampling is performed to increase the data to match 'numSamples').
  - build
```
public CsvReadOptions build()
```
    Overrides:
    
    build in class ReadOptions.Builder
  - header
```
public CsvReadOptions.Builder header(boolean header)
```
    Overrides:
    
    header in class ReadOptions.Builder
  - tableName
```
public CsvReadOptions.Builder tableName(String tableName)
```
    Overrides:
    
    tableName in class ReadOptions.Builder
  - sample
```
public CsvReadOptions.Builder sample(boolean sample)
```
    Overrides:
    
    sample in class ReadOptions.Builder
  - dateFormat
```
@Deprecated
public CsvReadOptions.Builder dateFormat(String dateFormat)
```
    Deprecated.
    
    Description copied from class: ReadOptions.Builder
    
    Deprecated. Use dateFormat(DateTimeFormatter dateFormat) instead
    
    Overrides:
    
    dateFormat in class ReadOptions.Builder
  - timeFormat
```
@Deprecated
public CsvReadOptions.Builder timeFormat(String timeFormat)
```
    Deprecated.
    
    Description copied from class: ReadOptions.Builder
    
    Deprecated. Use timeFormat(DateTimeFormatter dateFormat) instead
    
    Overrides:
    
    timeFormat in class ReadOptions.Builder
  - dateTimeFormat
```
@Deprecated
public CsvReadOptions.Builder dateTimeFormat(String dateTimeFormat)
```
    Deprecated.
    
    Description copied from class: ReadOptions.Builder
    
    Deprecated. Use dateTimeFormat(DateTimeFormatter dateFormat) instead
    
    Overrides:
    
    dateTimeFormat in class ReadOptions.Builder
  - dateFormat
```
public CsvReadOptions.Builder dateFormat(DateTimeFormatter dateFormat)
```
    Overrides:
    
    dateFormat in class ReadOptions.Builder
  - timeFormat
```
public CsvReadOptions.Builder timeFormat(DateTimeFormatter timeFormat)
```
    Overrides:
    
    timeFormat in class ReadOptions.Builder
  - dateTimeFormat
```
public CsvReadOptions.Builder dateTimeFormat(DateTimeFormatter dateTimeFormat)
```
    Overrides:
    
    dateTimeFormat in class ReadOptions.Builder
  - maxCharsPerColumn
```
public CsvReadOptions.Builder maxCharsPerColumn(int maxCharsPerColumn)
```
    Overrides:
    
    maxCharsPerColumn in class ReadOptions.Builder
  - locale
```
public CsvReadOptions.Builder locale(Locale locale)
```
    Overrides:
    
    locale in class ReadOptions.Builder
  - missingValueIndicator
```
public CsvReadOptions.Builder missingValueIndicator(String missingValueIndicator)
```
    Overrides:
    
    missingValueIndicator in class ReadOptions.Builder
  - minimizeColumnSizes
```
public CsvReadOptions.Builder minimizeColumnSizes()
```
    Description copied from class: ReadOptions.Builder
    
    Allow the ColumnTypeDetector to choose shorter column types such as float instead of double when the data will fit in a smaller type
    
    Overrides:
    
    minimizeColumnSizes in class ReadOptions.Builder

Class CsvReadOptions.Builder

Field Summary

Fields inherited from class tech.tablesaw.io.ReadOptions.Builder

Constructor Summary

Method Summary

Methods inherited from class tech.tablesaw.io.ReadOptions.Builder

Methods inherited from class java.lang.Object

Constructor Detail

Builder

Builder

Builder

Builder

Builder

Method Detail

columnTypes

separator

quoteChar

lineEnding

maxNumberOfColumns

commentPrefix

sampleSize

build

header

tableName

sample

dateFormat

timeFormat

dateTimeFormat

dateFormat

timeFormat

dateTimeFormat

maxCharsPerColumn

locale

missingValueIndicator

minimizeColumnSizes