DocumentTableOptions
Inheritance: java.lang.Object
public class DocumentTableOptions
Provides a set of options to control extraction of data from a document table.
Constructors
| Constructor | Description |
|---|---|
| DocumentTableOptions() | Creates a new instance of this class. |
Methods
| Method | Description |
|---|---|
| getMinRowIndex() | Gets the smallest zero-based index of a row to be extracted from a document table. |
| setMinRowIndex(int value) | Sets the smallest zero-based index of a row to be extracted from a document table. |
| getMaxRowIndex() | Gets the largest zero-based index of a row to be extracted from a document table. |
| setMaxRowIndex(int value) | Sets the largest zero-based index of a row to be extracted from a document table. |
| getMinColumnIndex() | Gets the smallest zero-based index of a column to be extracted from a document table. |
| setMinColumnIndex(int value) | Sets the smallest zero-based index of a column to be extracted from a document table. |
| getMaxColumnIndex() | Gets the largest zero-based index of a column to be extracted from a document table. |
| setMaxColumnIndex(int value) | Sets the largest zero-based index of a column to be extracted from a document table. |
| getFirstRowContainsColumnNames() | Gets a value indicating whether column names are to be obtained from the first extracted row of a document table. |
| setFirstRowContainsColumnNames(boolean value) | Sets a value indicating whether column names are to be obtained from the first extracted row of a document table. |
DocumentTableOptions()
public DocumentTableOptions()
Creates a new instance of this class.
getMinRowIndex()
public int getMinRowIndex()
Gets the smallest zero-based index of a row to be extracted from a document table. The default value is negative which means that the smallest row index is not limited.
Returns: int - The smallest zero-based index of a row to be extracted from a document table.
setMinRowIndex(int value)
public void setMinRowIndex(int value)
Sets the smallest zero-based index of a row to be extracted from a document table. The default value is negative which means that the smallest row index is not limited.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The smallest zero-based index of a row to be extracted from a document table. |
getMaxRowIndex()
public int getMaxRowIndex()
Gets the largest zero-based index of a row to be extracted from a document table. The default value is negative which means that the largest row index is not limited.
Returns: int - The largest zero-based index of a row to be extracted from a document table.
setMaxRowIndex(int value)
public void setMaxRowIndex(int value)
Sets the largest zero-based index of a row to be extracted from a document table. The default value is negative which means that the largest row index is not limited.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The largest zero-based index of a row to be extracted from a document table. |
getMinColumnIndex()
public int getMinColumnIndex()
Gets the smallest zero-based index of a column to be extracted from a document table. The default value is negative which means that the smallest column index is not limited.
Returns: int - The smallest zero-based index of a column to be extracted from a document table.
setMinColumnIndex(int value)
public void setMinColumnIndex(int value)
Sets the smallest zero-based index of a column to be extracted from a document table. The default value is negative which means that the smallest column index is not limited.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The smallest zero-based index of a column to be extracted from a document table. |
getMaxColumnIndex()
public int getMaxColumnIndex()
Gets the largest zero-based index of a column to be extracted from a document table. The default value is negative which means that the largest column index is not limited.
Returns: int - The largest zero-based index of a column to be extracted from a document table.
setMaxColumnIndex(int value)
public void setMaxColumnIndex(int value)
Sets the largest zero-based index of a column to be extracted from a document table. The default value is negative which means that the largest column index is not limited.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int | The largest zero-based index of a column to be extracted from a document table. |
getFirstRowContainsColumnNames()
public boolean getFirstRowContainsColumnNames()
Gets a value indicating whether column names are to be obtained from the first extracted row of a document table. The default value is false. If column names are not set to be obtained from the first extracted row of a document table, default column names are used instead. For documents of Spreadsheet file formats, default column names are defined as A, B, C, … Z, AA, AB, and so on. For documents of other file formats, default column names are defined as Column1, Column2, Column3, and so on.
Returns: boolean - A value indicating whether column names are to be obtained from the first extracted row of a document table.
setFirstRowContainsColumnNames(boolean value)
public void setFirstRowContainsColumnNames(boolean value)
Sets a value indicating whether column names are to be obtained from the first extracted row of a document table. The default value is false. If column names are not set to be obtained from the first extracted row of a document table, default column names are used instead. For documents of Spreadsheet file formats, default column names are defined as A, B, C, … Z, AA, AB, and so on. For documents of other file formats, default column names are defined as Column1, Column2, Column3, and so on.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean | A value indicating whether column names are to be obtained from the first extracted row of a document table. |