FixedWidthReadOptions.Builder (tablesaw-core 0.43.0 API)

java.lang.Object
- tech.tablesaw.io.ReadOptions.Builder
- - tech.tablesaw.io.fixed.FixedWidthReadOptions.Builder

Enclosing class:: FixedWidthReadOptions

public static class FixedWidthReadOptions.Builder
extends ReadOptions.Builder

Field Summary

Fields
Modifier and Type	Field	Description
`protected com.univocity.parsers.fixed.FixedWidthFields`	`columnSpecs`
`protected String`	`lineEnding`
`protected char`	`lookupWildcard`
`protected Integer`	`maxNumberOfColumns`
`protected char`	`padding`
`protected boolean`	`recordEndsOnNewline`
`protected boolean`	`skipInvalidRows`
`protected boolean`	`skipTrailingCharsUntilNewline`

Fields inherited from class tech.tablesaw.io.ReadOptions.Builder
columnTypeFunction, columnTypeMap, columnTypes, columnTypesToDetect, completeColumnTypeFunction, dateFormat, dateFormatter, dateTimeFormat, dateTimeFormatter, header, ignoreZeroDecimal, locale, maxCharsPerColumn, minimizeColumnSizes, missingValueIndicators, sample, skipRowsWithInvalidColumnCount, source, tableName, timeFormat, timeFormatter

Constructor Summary

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

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`FixedWidthReadOptions`	`build()`
`FixedWidthReadOptions.Builder`	`columnSpecs(com.univocity.parsers.fixed.FixedWidthFields columnSpecs)`
`FixedWidthReadOptions.Builder`	`columnTypes(Function<String,ColumnType> columnTypeFunction)`	Provide a function that determines ColumnType for all column names.
`FixedWidthReadOptions.Builder`	`columnTypes(ColumnType[] columnTypes)`	Provide column types for all columns skipping autodetect column type logic.
`FixedWidthReadOptions.Builder`	`columnTypesPartial(Function<String,Optional<ColumnType>> columnTypeFunction)`	Provide a function that determines ColumnType for some column names.
`FixedWidthReadOptions.Builder`	`columnTypesPartial(Map<String,ColumnType> columnTypeByName)`	Provide a map that determines ColumnType for given column names.
`FixedWidthReadOptions.Builder`	`dateFormat(String dateFormat)`	Deprecated.
`FixedWidthReadOptions.Builder`	`dateFormat(DateTimeFormatter dateFormat)`
`FixedWidthReadOptions.Builder`	`dateTimeFormat(String dateTimeFormat)`	Deprecated.
`FixedWidthReadOptions.Builder`	`dateTimeFormat(DateTimeFormatter dateTimeFormat)`
`FixedWidthReadOptions.Builder`	`header(boolean header)`
`FixedWidthReadOptions.Builder`	`ignoreZeroDecimal(boolean ignoreZeroDecimal)`	Ignore zero value decimals in data values.
`FixedWidthReadOptions.Builder`	`lineEnding(String lineEnding)`
`FixedWidthReadOptions.Builder`	`locale(Locale locale)`
`FixedWidthReadOptions.Builder`	`lookupWildcard(char lookupWildcard)`
`FixedWidthReadOptions.Builder`	`maxCharsPerColumn(int maxCharsPerColumn)`
`FixedWidthReadOptions.Builder`	`maxNumberOfColumns(Integer maxNumberOfColumns)`	Defines maximal value of columns in fixed-width file.
`FixedWidthReadOptions.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
`FixedWidthReadOptions.Builder`	`missingValueIndicator(String... missingValueIndicator)`
`FixedWidthReadOptions.Builder`	`padding(char padding)`
`FixedWidthReadOptions.Builder`	`recordEndsOnNewline(boolean recordEndsOnNewline)`
`FixedWidthReadOptions.Builder`	`sample(boolean sample)`
`FixedWidthReadOptions.Builder`	`skipInvalidRows(boolean skipInvalidRows)`
`FixedWidthReadOptions.Builder`	`skipTrailingCharsUntilNewline(boolean skipTrailingCharsUntilNewline)`
`FixedWidthReadOptions.Builder`	`systemLineEnding()`
`FixedWidthReadOptions.Builder`	`tableName(String tableName)`
`FixedWidthReadOptions.Builder`	`timeFormat(String timeFormat)`	Deprecated.
`FixedWidthReadOptions.Builder`	`timeFormat(DateTimeFormatter timeFormat)`

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

Methods inherited from class tech.tablesaw.io.ReadOptions.Builder
allowDuplicateColumnNames, columnTypesToDetect, skipRowsWithInvalidColumnCount

- Field Detail
  - columnSpecs
```
protected com.univocity.parsers.fixed.FixedWidthFields columnSpecs
```
  - lineEnding
```
protected String lineEnding
```
  - padding
```
protected char padding
```
  - lookupWildcard
```
protected char lookupWildcard
```
  - skipTrailingCharsUntilNewline
```
protected boolean skipTrailingCharsUntilNewline
```
  - recordEndsOnNewline
```
protected boolean recordEndsOnNewline
```
  - skipInvalidRows
```
protected boolean skipInvalidRows
```
  - maxNumberOfColumns
```
protected Integer maxNumberOfColumns
```
- 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
  - columnSpecs
```
public FixedWidthReadOptions.Builder columnSpecs(com.univocity.parsers.fixed.FixedWidthFields columnSpecs)
```
  - maxCharsPerColumn
```
public FixedWidthReadOptions.Builder maxCharsPerColumn(int maxCharsPerColumn)
```
    Overrides:
    
    maxCharsPerColumn in class ReadOptions.Builder
  - lineEnding
```
public FixedWidthReadOptions.Builder lineEnding(String lineEnding)
```
  - systemLineEnding
```
public FixedWidthReadOptions.Builder systemLineEnding()
```
  - padding
```
public FixedWidthReadOptions.Builder padding(char padding)
```
  - lookupWildcard
```
public FixedWidthReadOptions.Builder lookupWildcard(char lookupWildcard)
```
  - skipTrailingCharsUntilNewline
```
public FixedWidthReadOptions.Builder skipTrailingCharsUntilNewline(boolean skipTrailingCharsUntilNewline)
```
  - recordEndsOnNewline
```
public FixedWidthReadOptions.Builder recordEndsOnNewline(boolean recordEndsOnNewline)
```
  - skipInvalidRows
```
public FixedWidthReadOptions.Builder skipInvalidRows(boolean skipInvalidRows)
```
  - columnTypes
```
public FixedWidthReadOptions.Builder columnTypes(ColumnType[] columnTypes)
```
    Description copied from class: ReadOptions.Builder
    
    Provide column types for all columns skipping autodetect column type logic. The array must contain a ColumnType for each column in the table. An error will be thrown if they don't match up
    
    Overrides:
    
    columnTypes in class ReadOptions.Builder
  - columnTypes
```
public FixedWidthReadOptions.Builder columnTypes(Function<String,ColumnType> columnTypeFunction)
```
    Description copied from class: ReadOptions.Builder
    
    Provide a function that determines ColumnType for all column names. To provide only for some use ReadOptions.Builder.columnTypesPartial(Function)
    This method is generally more efficient because it skips column type detection
    
    Overrides:
    
    columnTypes in class ReadOptions.Builder
  - columnTypesPartial
```
public FixedWidthReadOptions.Builder columnTypesPartial(Function<String,Optional<ColumnType>> columnTypeFunction)
```
    Description copied from class: ReadOptions.Builder
    
    Provide a function that determines ColumnType for some column names. To provide for all column names use ReadOptions.Builder.columnTypes(Function) that generally is more efficient because it skips column type detection
    
    Overrides:
    
    columnTypesPartial in class ReadOptions.Builder
  - columnTypesPartial
```
public FixedWidthReadOptions.Builder columnTypesPartial(Map<String,ColumnType> columnTypeByName)
```
    Description copied from class: ReadOptions.Builder
    
    Provide a map that determines ColumnType for given column names. Types for not present column names will be autodetected. To provide type for all column names use ReadOptions.Builder.columnTypes(Function) that generally is more efficient because it skips column type detection
    
    Overrides:
    
    columnTypesPartial in class ReadOptions.Builder
  - maxNumberOfColumns
```
public FixedWidthReadOptions.Builder maxNumberOfColumns(Integer maxNumberOfColumns)
```
    Defines maximal value of columns in fixed-width file.
    
    Parameters:
    
    maxNumberOfColumns - - must be positive integer. Default is 512. *
  - build
```
public FixedWidthReadOptions build()
```
    Overrides:
    
    build in class ReadOptions.Builder
  - header
```
public FixedWidthReadOptions.Builder header(boolean header)
```
    Overrides:
    
    header in class ReadOptions.Builder
  - tableName
```
public FixedWidthReadOptions.Builder tableName(String tableName)
```
    Overrides:
    
    tableName in class ReadOptions.Builder
  - sample
```
public FixedWidthReadOptions.Builder sample(boolean sample)
```
    Overrides:
    
    sample in class ReadOptions.Builder
  - dateFormat
```
@Deprecated
public FixedWidthReadOptions.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 FixedWidthReadOptions.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 FixedWidthReadOptions.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 FixedWidthReadOptions.Builder dateFormat(DateTimeFormatter dateFormat)
```
    Overrides:
    
    dateFormat in class ReadOptions.Builder
  - timeFormat
```
public FixedWidthReadOptions.Builder timeFormat(DateTimeFormatter timeFormat)
```
    Overrides:
    
    timeFormat in class ReadOptions.Builder
  - dateTimeFormat
```
public FixedWidthReadOptions.Builder dateTimeFormat(DateTimeFormatter dateTimeFormat)
```
    Overrides:
    
    dateTimeFormat in class ReadOptions.Builder
  - locale
```
public FixedWidthReadOptions.Builder locale(Locale locale)
```
    Overrides:
    
    locale in class ReadOptions.Builder
  - missingValueIndicator
```
public FixedWidthReadOptions.Builder missingValueIndicator(String... missingValueIndicator)
```
    Overrides:
    
    missingValueIndicator in class ReadOptions.Builder
  - minimizeColumnSizes
```
public FixedWidthReadOptions.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
  - ignoreZeroDecimal
```
public FixedWidthReadOptions.Builder ignoreZeroDecimal(boolean ignoreZeroDecimal)
```
    Description copied from class: ReadOptions.Builder
    
    Ignore zero value decimals in data values. Defaults to true.
    
    Overrides:
    
    ignoreZeroDecimal in class ReadOptions.Builder

Class FixedWidthReadOptions.Builder

Field Summary

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

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

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

Field Detail

columnSpecs

lineEnding

padding

lookupWildcard

skipTrailingCharsUntilNewline

recordEndsOnNewline

skipInvalidRows

maxNumberOfColumns

Constructor Detail

Builder

Builder

Builder

Builder

Builder

Method Detail

columnSpecs

maxCharsPerColumn

lineEnding

systemLineEnding

padding

lookupWildcard

skipTrailingCharsUntilNewline

recordEndsOnNewline

skipInvalidRows

columnTypes

columnTypes

columnTypesPartial

columnTypesPartial

maxNumberOfColumns

build

header

tableName

sample

dateFormat

timeFormat

dateTimeFormat

dateFormat

timeFormat

dateTimeFormat

locale

missingValueIndicator

minimizeColumnSizes

ignoreZeroDecimal