com.univocity.parsers.tsv

Class TsvParserSettings

java.lang.Object

com.univocity.parsers.common.CommonSettings<F>

com.univocity.parsers.common.CommonParserSettings<TsvFormat>

com.univocity.parsers.tsv.TsvParserSettings

All Implemented Interfaces:

Cloneable

public class TsvParserSettings
extends CommonParserSettings<TsvFormat>

This is the configuration class used by the TSV parser (TsvParser)

It supports the configuration options provided by CommonParserSettings only

Author:

Univocity Software Pty Ltd - parsers@univocity.com

See Also:

TsvParser, TsvFormat, CommonParserSettings

Field Summary

Fields inherited from class com.univocity.parsers.common.CommonParserSettings

headerExtractionEnabled

Constructor Summary

Constructors

Constructor and Description
TsvParserSettings()

Method Summary

Modifier and Type	Method and Description
protected void	addConfiguration(Map<String,Object> out)
TsvParserSettings	clone() Clones this configuration object.
TsvParserSettings	clone(boolean clearInputSpecificSettings) Clones this configuration object to reuse user-provided settings.
protected TsvFormat	createDefaultFormat() Returns the default TsvFormat configured to handle TSV inputs
boolean	isLineJoiningEnabled() Identifies whether or lines ending with the escape character (defined by TsvFormat.getEscapeChar() and followed by a line separator character should be joined with the following line.
TsvParserSettings	setAutoConfigurationEnabled(boolean autoConfigurationEnabled) Indicates whether this settings object can automatically derive configuration options.
TsvParserSettings	setErrorContentLength(int errorContentLength) Configures the parser/writer to limit the length of displayed contents being parsed/written in the exception message when an error occurs.
TsvParserSettings	setFormat(TsvFormat format) Defines the format of the file to be parsed/written (returns the format's defaults).
TsvParserSettings	setHeaders(String... headers) Defines the field names in the input/output, in the sequence they occur (defaults to null).
TsvParserSettings	setHeadersDerivedFromClass(Class<?> headerSourceClass, String... headers) Defines the field names in the input/output derived from a given class with Parsed annotated attributes/methods.
TsvParserSettings	setIgnoreLeadingWhitespaces(boolean ignoreLeadingWhitespaces) Defines whether or not leading whitespaces from values being read/written should be skipped (defaults to true)
TsvParserSettings	setIgnoreTrailingWhitespaces(boolean ignoreTrailingWhitespaces) Defines whether or not trailing whitespaces from values being read/written should be skipped (defaults to true)
TsvParserSettings	setLineJoiningEnabled(boolean lineJoiningEnabled) Defines how the parser should handle escaped line separators.
TsvParserSettings	setMaxCharsPerColumn(int maxCharsPerColumn) Defines the maximum number of characters allowed for any given value being written/read.
TsvParserSettings	setMaxColumns(int maxColumns) Defines a hard limit of how many columns a record can have (defaults to 512).
TsvParserSettings	setNullValue(String emptyValue) Sets the String representation of a null value (defaults to null)
TsvParserSettings	setProcessorErrorHandler(ProcessorErrorHandler<? extends Context> processorErrorHandler) Defines a custom error handler to capture and handle errors that might happen while processing records with a Processor or a RowWriterProcessor (i.e.
TsvParserSettings	setRowProcessorErrorHandler(RowProcessorErrorHandler rowProcessorErrorHandler) Deprecated. Use the setProcessorErrorHandler(ProcessorErrorHandler) method as it allows format-specific error handlers to be built to work with different implementations of Context. Implementations based on RowProcessorErrorHandler allow only parsers who provide a ParsingContext to be used.
TsvParserSettings	setSkipBitsAsWhitespace(boolean skipBitsAsWhitespace) Configures the parser to skip bit values as whitespace.
TsvParserSettings	setSkipEmptyLines(boolean skipEmptyLines) Defines whether or not empty lines should be ignored (defaults to true)

Methods inherited from class com.univocity.parsers.common.CommonParserSettings

addInputAnalysisProcess, clearInputSpecificSettings, configureFromAnnotations, getInputAnalysisProcesses, getInputBufferSize, getNumberOfRecordsToRead, getNumberOfRowsToSkip, getProcessor, getReadInputOnSeparateThread, getRowProcessor, isAutoClosingEnabled, isBlankCommentCollectionEnabled, isColumnReorderingEnabled, isCommentCollectionEnabled, isCommentProcessingEnabled, isHeaderExtractionEnabled, isLineSeparatorDetectionEnabled, newCharAppender, newCharInputReader, setAutoClosingEnabled, setColumnReorderingEnabled, setCommentCollectionEnabled, setCommentCollectionEnabled, setCommentProcessingEnabled, setHeaderExtractionEnabled, setInputBufferSize, setLineSeparatorDetectionEnabled, setNumberOfRecordsToRead, setNumberOfRowsToSkip, setProcessor, setReadInputOnSeparateThread, setRowProcessor

Methods inherited from class com.univocity.parsers.common.CommonSettings

excludeFields, excludeFields, excludeIndexes, getErrorContentLength, getFormat, getHeaders, getIgnoreLeadingWhitespaces, getIgnoreTrailingWhitespaces, getMaxCharsPerColumn, getMaxColumns, getNullValue, getProcessorErrorHandler, getRowProcessorErrorHandler, getSkipBitsAsWhitespace, getSkipEmptyLines, getWhitespaceRangeStart, isAutoConfigurationEnabled, isProcessorErrorHandlerDefined, selectFields, selectFields, selectIndexes, toString, trimValues

Methods inherited from class java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

TsvParserSettings

public TsvParserSettings()

Method Detail

isLineJoiningEnabled

public boolean isLineJoiningEnabled()

Identifies whether or lines ending with the escape character (defined by TsvFormat.getEscapeChar() and followed by a line separator character should be joined with the following line. Typical examples include inputs where lines end with sequences such as: '\'+'\n' and '\'+'\r'+'\n'. When line joining is disabled (the default), the TsvParser converts sequences containing the escape character (typically '\') followed by characters 'n' or 'r' into a '\n' or '\r' character. It will continue processing the contents found in the same line, until a new line character is found. If line joining is enabled, the TsvParser will convert sequences containing the escape character, followed by characters '\n', '\r' or '\r\n', into a '\n' or '\r' character. It will continue processing the contents found in the next line, until a new line character is found, given it is not preceded by another escape character.

Returns:

true if line joining is enabled, otherwise false

setLineJoiningEnabled

public TsvParserSettings setLineJoiningEnabled(boolean lineJoiningEnabled)

Defines how the parser should handle escaped line separators. By enabling lines joining, lines ending with the escape character (defined by TsvFormat.getEscapeChar() and followed by a line separator character will be joined with the following line. Typical examples include inputs where lines end with sequences such as: '\'+'\n' and '\'+'\r'+'\n'. When line joining is disabled (the default), the TsvParser converts sequences containing the escape character (typically '\') followed by characters 'n' or 'r' into a '\n' or '\r' character. It will continue processing the contents found in the same line, until a new line character is found. If line joining is enabled, the TsvParser will convert sequences containing the escape character, followed by characters '\n', '\r' or '\r\n', into a '\n' or '\r' character. It will continue processing the contents found in the next line, until a new line character is found, given it is not preceded by another escape character.

Parameters:

lineJoiningEnabled - a flag indicating whether or not to enable line joining.

Returns:

this TsvParserSettings instance

setNullValue

public TsvParserSettings setNullValue(String emptyValue)

Sets the String representation of a null value (defaults to null)

When reading, if the parser does not read any character from the input, the nullValue is used instead of an empty string

When writing, if the writer has a null object to write to the output, the nullValue is used instead of an empty string

Overrides:

setNullValue in class CommonSettings<TsvFormat>

Parameters:

emptyValue - the String representation of a null value

Returns:

this TsvParserSettings instance

setMaxCharsPerColumn

public TsvParserSettings setMaxCharsPerColumn(int maxCharsPerColumn)

Defines the maximum number of characters allowed for any given value being written/read. Used to avoid OutOfMemoryErrors (defaults to 4096).

To enable auto-expansion of the internal array, set this property to -1

Overrides:

setMaxCharsPerColumn in class CommonSettings<TsvFormat>

Parameters:

maxCharsPerColumn - The maximum number of characters allowed for any given value being written/read

Returns:

this TsvParserSettings instance

setSkipEmptyLines

public TsvParserSettings setSkipEmptyLines(boolean skipEmptyLines)

Defines whether or not empty lines should be ignored (defaults to true)

when reading, if the parser reads a line that is empty, it will be skipped.

when writing, if the writer receives an empty or null row to write to the output, it will be ignored

Overrides:

setSkipEmptyLines in class CommonSettings<TsvFormat>

Parameters:

skipEmptyLines - true if empty lines should be ignored, false otherwise

Returns:

this TsvParserSettings instance

setIgnoreTrailingWhitespaces

public TsvParserSettings setIgnoreTrailingWhitespaces(boolean ignoreTrailingWhitespaces)

Defines whether or not trailing whitespaces from values being read/written should be skipped (defaults to true)

Overrides:

setIgnoreTrailingWhitespaces in class CommonSettings<TsvFormat>

Parameters:

ignoreTrailingWhitespaces - true if trailing whitespaces from values being read/written should be skipped, false otherwise

Returns:

this TsvParserSettings instance

setIgnoreLeadingWhitespaces

public TsvParserSettings setIgnoreLeadingWhitespaces(boolean ignoreLeadingWhitespaces)

Defines whether or not leading whitespaces from values being read/written should be skipped (defaults to true)

Overrides:

setIgnoreLeadingWhitespaces in class CommonSettings<TsvFormat>

Parameters:

ignoreLeadingWhitespaces - true if leading whitespaces from values being read/written should be skipped, false otherwise

Returns:

this TsvParserSettings instance

setHeaders

public TsvParserSettings setHeaders(String... headers)

Defines the field names in the input/output, in the sequence they occur (defaults to null).

when reading, the given header names will be used to refer to each column irrespective of whether or not the input contains a header row

when writing, the given header names will be used to refer to each column and can be used for writing the header row

Overrides:

setHeaders in class CommonSettings<TsvFormat>

Parameters:

headers - the field name sequence associated with each column in the input/output.

Returns:

this TsvParserSettings instance

setHeadersDerivedFromClass

public TsvParserSettings setHeadersDerivedFromClass(Class<?> headerSourceClass,
                                                    String... headers)

Defines the field names in the input/output derived from a given class with Parsed annotated attributes/methods.

when reading, the given header names will be used to refer to each column irrespective of whether or not the input contains a header row

when writing, the given header names will be used to refer to each column and can be used for writing the header row

Overrides:

setHeadersDerivedFromClass in class CommonSettings<TsvFormat>

Parameters:

headerSourceClass - the class from which the headers have been derived.

headers - the field name sequence associated with each column in the input/output.

Returns:

this TsvParserSettings instance

setMaxColumns

public TsvParserSettings setMaxColumns(int maxColumns)

Defines a hard limit of how many columns a record can have (defaults to 512). You need this to avoid OutOfMemory errors in case of inputs that might be inconsistent with the format you are dealing with.

Overrides:

setMaxColumns in class CommonSettings<TsvFormat>

Parameters:

maxColumns - The maximum number of columns a record can have.

Returns:

this TsvParserSettings instance

setFormat

public TsvParserSettings setFormat(TsvFormat format)

Defines the format of the file to be parsed/written (returns the format's defaults).

Overrides:

setFormat in class CommonSettings<TsvFormat>

Parameters:

format - The format of the file to be parsed/written

Returns:

this TsvParserSettings instance

setAutoConfigurationEnabled

public final TsvParserSettings setAutoConfigurationEnabled(boolean autoConfigurationEnabled)

Indicates whether this settings object can automatically derive configuration options. This is used, for example, to define the headers when the user provides a BeanWriterProcessor where the bean class contains a Headers annotation, or to enable header extraction when the bean class of a BeanProcessor has attributes mapping to header names.

Overrides:

setAutoConfigurationEnabled in class CommonSettings<TsvFormat>

Parameters:

autoConfigurationEnabled - a flag to turn the automatic configuration feature on/off.

Returns:

this TsvParserSettings instance

setRowProcessorErrorHandler

@Deprecated
public TsvParserSettings setRowProcessorErrorHandler(RowProcessorErrorHandler rowProcessorErrorHandler)

Deprecated. Use the setProcessorErrorHandler(ProcessorErrorHandler) method as it allows format-specific error handlers to be built to work with different implementations of Context. Implementations based on RowProcessorErrorHandler allow only parsers who provide a ParsingContext to be used.

Defines a custom error handler to capture and handle errors that might happen while processing records with a RowProcessor or a RowWriterProcessor (i.e. non-fatal DataProcessingExceptions).

The parsing parsing/writing won't stop (unless the error handler rethrows the DataProcessingException or manually stops the process).

Overrides:

setRowProcessorErrorHandler in class CommonSettings<TsvFormat>

Parameters:

rowProcessorErrorHandler - the callback error handler with custom code to manage occurrences of DataProcessingException.

Returns:

this TsvParserSettings instance

setProcessorErrorHandler

public TsvParserSettings setProcessorErrorHandler(ProcessorErrorHandler<? extends Context> processorErrorHandler)

Defines a custom error handler to capture and handle errors that might happen while processing records with a Processor or a RowWriterProcessor (i.e. non-fatal DataProcessingExceptions).

The parsing parsing/writing won't stop (unless the error handler rethrows the DataProcessingException or manually stops the process).

Overrides:

setProcessorErrorHandler in class CommonSettings<TsvFormat>

Parameters:

processorErrorHandler - the callback error handler with custom code to manage occurrences of DataProcessingException.

Returns:

this TsvParserSettings instance

setErrorContentLength

public TsvParserSettings setErrorContentLength(int errorContentLength)

Configures the parser/writer to limit the length of displayed contents being parsed/written in the exception message when an error occurs.

If set to 0, then no exceptions will include the content being manipulated in their attributes, and the "<omitted>" string will appear in error messages as the parsed/written content.

defaults to -1 (no limit)

.

Overrides:

setErrorContentLength in class CommonSettings<TsvFormat>

Parameters:

errorContentLength - maximum length of contents displayed in exception messages in case of errors while parsing/writing.

Returns:

this TsvParserSettings instance

setSkipBitsAsWhitespace

public final TsvParserSettings setSkipBitsAsWhitespace(boolean skipBitsAsWhitespace)

Configures the parser to skip bit values as whitespace. By default the parser/writer removes control characters and considers a whitespace any character where character <= ' ' evaluates to true. This includes bit values, i.e. 0 (the \0 character) and 1 which might be produced by database dumps. Disabling this flag will prevent the parser/writer from discarding these characters when CommonSettings.getIgnoreLeadingWhitespaces() or CommonSettings.getIgnoreTrailingWhitespaces() evaluate to true.

defaults to true

Overrides:

setSkipBitsAsWhitespace in class CommonSettings<TsvFormat>

Parameters:

skipBitsAsWhitespace - a flag indicating whether bit values (0 or 1) should be considered whitespace.

Returns:

this TsvParserSettings instance

createDefaultFormat

protected TsvFormat createDefaultFormat()

Returns the default TsvFormat configured to handle TSV inputs

Specified by:

createDefaultFormat in class CommonSettings<TsvFormat>

Returns:

and instance of TsvFormat configured to handle TSV

addConfiguration

protected void addConfiguration(Map<String,Object> out)

Overrides:

addConfiguration in class CommonParserSettings<TsvFormat>

clone

public final TsvParserSettings clone()

Description copied from class: CommonSettings

Clones this configuration object. Use alternative CommonSettings.clone(boolean) method to reset properties that are specific to a given input, such as header names and selection of fields.

Overrides:

clone in class CommonParserSettings<TsvFormat>

Returns:

a copy of all configurations applied to the current instance.

clone

public final TsvParserSettings clone(boolean clearInputSpecificSettings)

Description copied from class: CommonSettings

Clones this configuration object to reuse user-provided settings. Properties that are specific to a given input (such as header names and selection of fields) can be reset to their defaults if the clearInputSpecificSettings flag is set to true

Overrides:

clone in class CommonParserSettings<TsvFormat>

Parameters:

clearInputSpecificSettings - flag indicating whether to clear settings that are likely to be associated with a given input.

Returns:

a copy of the configurations applied to the current instance.