DelimitedTextEditOptions
Inheritance: java.lang.Object
All Implemented Interfaces: com.groupdocs.editor.options.IEditOptions
public final class DelimitedTextEditOptions implements IEditOptions
Options for loading text-based Spreadsheet documents (CSV, Tab-based etc.), that use a separator (delimiter)
https://en.wikipedia.org/wiki/Delimiter-separated_values
Constructors
| Constructor | Description |
|---|---|
| DelimitedTextEditOptions(String separator) | Creates an instance of options class for delimited text with mandatory separator (delimiter) |
Methods
| Method | Description |
|---|---|
| getSeparator() | Allows to specify a string separator (delimiter) for text-based Spreadsheet documents |
| setSeparator(String value) | Allows to specify a string separator (delimiter) for text-based Spreadsheet documents |
| getConvertDateTimeData() | Gets or sets a value that indicates whether the string in text-based document is converted to the date data. |
| setConvertDateTimeData(boolean value) | Gets or sets a value that indicates whether the string in text-based document is converted to the date data. |
| getConvertNumericData() | Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. |
| setConvertNumericData(boolean value) | Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. |
| getTreatConsecutiveDelimitersAsOne() | Defines whether consecutive delimiters should be treated as one. |
| setTreatConsecutiveDelimitersAsOne(boolean value) | Defines whether consecutive delimiters should be treated as one. |
| getOptimizeMemoryUsage() | Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. |
| setOptimizeMemoryUsage(boolean value) | Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. |
DelimitedTextEditOptions(String separator)
public DelimitedTextEditOptions(String separator)
Creates an instance of options class for delimited text with mandatory separator (delimiter)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| separator | java.lang.String | Mandatory separator (delimiter), that cannot be NULL or empty |
getSeparator()
public final String getSeparator()
Allows to specify a string separator (delimiter) for text-based Spreadsheet documents
Returns: java.lang.String
setSeparator(String value)
public final void setSeparator(String value)
Allows to specify a string separator (delimiter) for text-based Spreadsheet documents
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
getConvertDateTimeData()
public final boolean getConvertDateTimeData()
Gets or sets a value that indicates whether the string in text-based document is converted to the date data. Default is false.
Returns: boolean
setConvertDateTimeData(boolean value)
public final void setConvertDateTimeData(boolean value)
Gets or sets a value that indicates whether the string in text-based document is converted to the date data. Default is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getConvertNumericData()
public final boolean getConvertNumericData()
Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. Default is false.
Returns: boolean
setConvertNumericData(boolean value)
public final void setConvertNumericData(boolean value)
Gets or sets a value that indicates whether the string in text-based document is converted to numeric data. Default is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getTreatConsecutiveDelimitersAsOne()
public final boolean getTreatConsecutiveDelimitersAsOne()
Defines whether consecutive delimiters should be treated as one. By default is false.
Returns: boolean
setTreatConsecutiveDelimitersAsOne(boolean value)
public final void setTreatConsecutiveDelimitersAsOne(boolean value)
Defines whether consecutive delimiters should be treated as one. By default is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
getOptimizeMemoryUsage()
public final boolean getOptimizeMemoryUsage()
Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).
Returns: boolean
setOptimizeMemoryUsage(boolean value)
public final void setOptimizeMemoryUsage(boolean value)
Enables memory optimization mechanisms during input document processing, which may degrade performance in some special cases, but on the other hand decrease memory usage. Useful when processing huge documents and facing OutOfMemoryException. Default is false (memory optimization is disabled for the sake of better performance).
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |