ExcelSourceTableSpec (EBX® EBX Data Exchange Add-on (New) Version 6.1.4 Java API)

java.lang.Object
- com.orchestranetworks.addon.dint.dataconnector.spec.TableSpec
- - com.orchestranetworks.addon.dint.dataconnector.spec.ExcelSourceTableSpec

public final class ExcelSourceTableSpec
extends com.orchestranetworks.addon.dint.dataconnector.spec.TableSpec

Specification for an ExcelSourceTable.

Since:: 4.1.0

Nested Class Summary

Nested Classes
Modifier and Type Class Description

static class ExcelSourceTableSpec.ExcelSourceTableSpecBuilder
Builder for creating an ExcelSourceTableSpec instance.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`java.io.File`	`getFile()`	Returns the source file.
`java.io.File`	`getInvalidDataFile()`	Returns the file where invalid records are written.
`char`	`getListSeparator()`	Returns the list separator character.
`java.lang.String`	`getSheetName()`	Returns the sheet name.
`int`	`getStartColumn()`	Returns the start column of the data table.
`int`	`getStartRow()`	Returns the start row of the data table.
`boolean`	`isColumnHeaderIncluded()`	Returns `true` if the file contains a header row.
`static ExcelSourceTableSpec.ExcelSourceTableSpecBuilder`	`newBuilder(java.io.File file)`	Create a builder instance.

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

- Method Detail
  - newBuilder
```
public static ExcelSourceTableSpec.ExcelSourceTableSpecBuilder newBuilder(java.io.File file)
```
    Create a builder instance.
    
    Parameters:
    
    file - The source file.
  - getFile
```
public java.io.File getFile()
```
    Returns the source file.
  - getSheetName
```
public java.lang.String getSheetName()
```
    Returns the sheet name.
  - getStartRow
```
public int getStartRow()
```
    Returns the start row of the data table. Returns 1 by default.
  - getStartColumn
```
public int getStartColumn()
```
    Returns the start column of the data table.
    Returns 1 by default.
  - getListSeparator
```
public char getListSeparator()
```
    Returns the list separator character.
    Returns line-break by default.
    
    Since:
    
    4.2.0
  - isColumnHeaderIncluded
```
public boolean isColumnHeaderIncluded()
```
    Returns true if the file contains a header row.
    Returns true by default.
  - getInvalidDataFile
```
public java.io.File getInvalidDataFile()
```
    Returns the file where invalid records are written.
    Returns null by default.
    
    Since:
    
    4.5.0