univocity-parsers 2.9.1 · com.univocity.parsers.csv.CsvParser

Field Summary

Modifier and Type	Field and Description
private boolean	backToDelimiter
private char	delimiter
private char[]	delimiters
private final boolean	doNotEscapeUnquotedValues
private final String	emptyValue
private char	escapeEscape
private int	formatDetectorRowSampleCount
private final boolean	keepEscape
private final boolean	keepQuotes
private int	match
private final int	maxColumnLength
private char[]	multiDelimiter
private char	newLine
private final boolean	normalizeLineEndingsInQuotes
private final String	nullValue
private boolean	parseUnescapedQuotes
private boolean	parseUnescapedQuotesUntilDelimiter
private char	prev
private char	quote
private char	quoteEscape
private UnescapedQuoteHandling	quoteHandling
private final boolean	trimQuotedLeading
private final boolean	trimQuotedTrailing
private boolean	unescaped
private final DefaultCharAppender	whitespaceAppender

Inherited from com.univocity.parsers.common.AbstractParser:: ch comment comments context ignoreLeadingWhitespace ignoreTrailingWhitespace input lastComment output processor settings whitespaceRangeStart

Constructor Summary

Access	Constructor and Description
public	CsvParser(CsvParserSettings the parser configuration settings) The CsvParser supports all settings provided by `CsvParserSettings`, and requires this configuration to be properly initialized.

Method Summary

Modifier and Type	Method and Description
private void	appendUntilMultiDelimiter()
protected final boolean	consumeValueOnEOF() Overrides com.univocity.parsers.common.AbstractParser.consumeValueOnEOF. Allows the parser implementation to handle any value that was being consumed when the end of the input was reached
public final CsvFormat	Returns: the detected CSV format, or `null` if no detection has been enabled or if the parsing process has not been started yet. getDetectedFormat() Returns the CSV format detected when one of the following settings is enabled: `CommonParserSettings#isLineSeparatorDetectionEnabled()` `CsvParserSettings#isDelimiterDetectionEnabled()` `CsvParserSettings#isQuoteDetectionEnabled()`
protected final InputAnalysisProcess	getInputAnalysisProcess() Overrides com.univocity.parsers.common.AbstractParser.getInputAnalysisProcess. Allows the parser implementation to traverse the input buffer before the parsing process starts, in order to enable automatic configuration and discovery of data formats.
private boolean	handleUnescapedQuote()
private void	handleUnescapedQuoteInValue()
private void	handleValueSkipping(boolean quoted)
private boolean	matchDelimiter()
private boolean	matchDelimiterAfterQuote()
private int	nextDelimiter()
private void	parseMultiDelimiterRecord()
private void	parseQuotedValue()
private void	parseQuotedValueMultiDelimiter()
protected final void	parseRecord() Implements abstract com.univocity.parsers.common.AbstractParser.parseRecord. Parser-specific implementation for reading a single record from the input.
private final void	parseSingleDelimiterRecord()
private void	parseValueProcessingEscape()
private void	parseValueProcessingEscapeMultiDelimiter()
private void	processQuoteEscape()
private void	saveMatchingCharacters()
private void	skipValue()
private void	skipWhitespace()
public final void	updateFormat(CsvFormat the new format to use. format) Allows changing the format of the input on the fly.

Inherited from com.univocity.parsers.common.AbstractParser:: beginParsing beginParsing beginParsing beginParsing beginParsing beginParsing beginParsing createParsingContext getContext getRecordMetadata inComment initialize iterate iterate iterate iterate iterate iterate iterate iterateRecords iterateRecords iterateRecords iterateRecords iterateRecords iterateRecords iterateRecords parse parse parse parse parse parse parse parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAll parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseAllRecords parseLine parseNext parseNextRecord parseRecord processComment reloadHeaders stopParsing

Field Detail

backToDelimiter	back to summary
private boolean backToDelimiter

delimiter	back to summary
private char delimiter

delimiters	back to summary
private char[] delimiters

doNotEscapeUnquotedValues	back to summary
private final boolean doNotEscapeUnquotedValues

emptyValue	back to summary
private final String emptyValue

escapeEscape	back to summary
private char escapeEscape

formatDetectorRowSampleCount	back to summary
private int formatDetectorRowSampleCount

keepEscape	back to summary
private final boolean keepEscape

keepQuotes	back to summary
private final boolean keepQuotes

match	back to summary
private int match

maxColumnLength	back to summary
private final int maxColumnLength

multiDelimiter	back to summary
private char[] multiDelimiter

newLine	back to summary
private char newLine

normalizeLineEndingsInQuotes	back to summary
private final boolean normalizeLineEndingsInQuotes

nullValue	back to summary
private final String nullValue

parseUnescapedQuotes	back to summary
private boolean parseUnescapedQuotes

parseUnescapedQuotesUntilDelimiter	back to summary
private boolean parseUnescapedQuotesUntilDelimiter

prev	back to summary
private char prev

quote	back to summary
private char quote

quoteEscape	back to summary
private char quoteEscape

quoteHandling	back to summary
private UnescapedQuoteHandling quoteHandling

trimQuotedLeading	back to summary
private final boolean trimQuotedLeading

trimQuotedTrailing	back to summary
private final boolean trimQuotedTrailing

unescaped	back to summary
private boolean unescaped

whitespaceAppender	back to summary
private final DefaultCharAppender whitespaceAppender

Constructor Detail

CsvParser back to summary

CsvParser	back to summary
public CsvParser(CsvParserSettings settings) The CsvParser supports all settings provided by `CsvParserSettings`, and requires this configuration to be properly initialized. Parameters settings:CsvParserSettings the parser configuration

public CsvParser(CsvParserSettings settings)

The CsvParser supports all settings provided by CsvParserSettings, and requires this configuration to be properly initialized.

Parameters

settings:CsvParserSettings: the parser configuration

Method Detail

appendUntilMultiDelimiter	back to summary
private void appendUntilMultiDelimiter()

consumeValueOnEOF	back to summary
protected final boolean consumeValueOnEOF() Overrides com.univocity.parsers.common.AbstractParser.consumeValueOnEOF. Doc from com.univocity.parsers.common.AbstractParser.consumeValueOnEOF. Allows the parser implementation to handle any value that was being consumed when the end of the input was reached Returns:boolean a flag indicating whether the parser was processing a value when the end of the input was reached. Annotations @Override

consumeValueOnEOF

back to summary

protected final boolean consumeValueOnEOF()

Overrides com.univocity.parsers.common.AbstractParser.consumeValueOnEOF.

Doc from com.univocity.parsers.common.AbstractParser.consumeValueOnEOF.

Allows the parser implementation to handle any value that was being consumed when the end of the input was reached

Returns:boolean

a flag indicating whether the parser was processing a value when the end of the input was reached.

Annotations

@Override

getDetectedFormat back to summary

getDetectedFormat	back to summary
public final CsvFormat getDetectedFormat() Returns the CSV format detected when one of the following settings is enabled: `CommonParserSettings#isLineSeparatorDetectionEnabled()` `CsvParserSettings#isDelimiterDetectionEnabled()` `CsvParserSettings#isQuoteDetectionEnabled()` The detected format will be available once the parsing process is initialized (i.e. when `runs`. Returns:CsvFormat the detected CSV format, or `null` if no detection has been enabled or if the parsing process has not been started yet.

public final CsvFormat getDetectedFormat()

Returns the CSV format detected when one of the following settings is enabled:

The detected format will be available once the parsing process is initialized (i.e. when runs.

Returns:CsvFormat: the detected CSV format, or null if no detection has been enabled or if the parsing process has not been started yet.

getInputAnalysisProcess back to summary

getInputAnalysisProcess	back to summary
protected final InputAnalysisProcess getInputAnalysisProcess() Overrides com.univocity.parsers.common.AbstractParser.getInputAnalysisProcess. Doc from com.univocity.parsers.common.AbstractParser.getInputAnalysisProcess. Allows the parser implementation to traverse the input buffer before the parsing process starts, in order to enable automatic configuration and discovery of data formats. Returns:InputAnalysisProcess a custom implementation of `InputAnalysisProcess`. By default, `null` is returned and no special input analysis will be performed. Annotations @Override

protected final InputAnalysisProcess getInputAnalysisProcess()

Overrides com.univocity.parsers.common.AbstractParser.getInputAnalysisProcess.

Doc from com.univocity.parsers.common.AbstractParser.getInputAnalysisProcess.

Allows the parser implementation to traverse the input buffer before the parsing process starts, in order to enable automatic configuration and discovery of data formats.

Returns:InputAnalysisProcess

a custom implementation of InputAnalysisProcess. By default, null is returned and no special input analysis will be performed.

Annotations

@Override

handleUnescapedQuote	back to summary
private boolean handleUnescapedQuote()

handleUnescapedQuoteInValue	back to summary
private void handleUnescapedQuoteInValue()

handleValueSkipping	back to summary
private void handleValueSkipping(boolean quoted)

matchDelimiter	back to summary
private boolean matchDelimiter()

matchDelimiterAfterQuote	back to summary
private boolean matchDelimiterAfterQuote()

nextDelimiter	back to summary
private int nextDelimiter()

parseMultiDelimiterRecord	back to summary
private void parseMultiDelimiterRecord()

parseQuotedValue	back to summary
private void parseQuotedValue()

parseQuotedValueMultiDelimiter	back to summary
private void parseQuotedValueMultiDelimiter()

parseRecord back to summary

parseRecord	back to summary
protected final void parseRecord() Implements abstract com.univocity.parsers.common.AbstractParser.parseRecord. Doc from com.univocity.parsers.common.AbstractParser.parseRecord. Parser-specific implementation for reading a single record from the input. The AbstractParser handles the initialization and processing of the input until it is ready to be parsed. It then delegates the input to the parser-specific implementation defined by `parseRecord()`. In general, an implementation of `AbstractParser#parseRecord()` will perform the following steps: Test the character stored in ch and take some action on it (e.g. is while (ch != '\n'){doSomething()}) Request more characters by calling ch = input.nextChar(); Append the desired characters to the output by executing, for example, output.appender.append(ch) Notify a value of the record has been fully read by executing output.valueParsed(). This will clear the output appender (`CharAppender`) so the next call to output.appender.append(ch) will be store the character of the next parsed value Rinse and repeat until all values of the record are parsed Once the `parseRecord()` returns, the AbstractParser takes over and handles the information (generally, reorganizing it and passing it on to a `RowProcessor`). After the record processing, the AbstractParser reads the next characters from the input, delegating control again to the parseRecord() implementation for processing of the next record. This cycle repeats until the reading process is stopped by the user, the input is exhausted, or an error happens. In case of errors, the unchecked exception `TextParsingException` will be thrown and all resources in use will be closed automatically unless `CommonParserSettings#isAutoClosingEnabled()` evaluates to `false`. The exception should contain the cause and more information about where in the input the error happened. Annotations @Override

protected final void parseRecord()

Implements abstract com.univocity.parsers.common.AbstractParser.parseRecord.

Doc from com.univocity.parsers.common.AbstractParser.parseRecord.

Parser-specific implementation for reading a single record from the input.

The AbstractParser handles the initialization and processing of the input until it is ready to be parsed.

It then delegates the input to the parser-specific implementation defined by parseRecord(). In general, an implementation of AbstractParser#parseRecord() will perform the following steps:

Test the character stored in ch and take some action on it (e.g. is while (ch != '\n'){doSomething()})
Request more characters by calling ch = input.nextChar();
Append the desired characters to the output by executing, for example, output.appender.append(ch)
Notify a value of the record has been fully read by executing output.valueParsed(). This will clear the output appender (CharAppender) so the next call to output.appender.append(ch) will be store the character of the next parsed value
Rinse and repeat until all values of the record are parsed

Once the parseRecord() returns, the AbstractParser takes over and handles the information (generally, reorganizing it and passing it on to a RowProcessor).

After the record processing, the AbstractParser reads the next characters from the input, delegating control again to the parseRecord() implementation for processing of the next record.

This cycle repeats until the reading process is stopped by the user, the input is exhausted, or an error happens.

In case of errors, the unchecked exception TextParsingException will be thrown and all resources in use will be closed automatically unless CommonParserSettings#isAutoClosingEnabled() evaluates to false. The exception should contain the cause and more information about where in the input the error happened.

Annotations

@Override

parseSingleDelimiterRecord	back to summary
private final void parseSingleDelimiterRecord()

parseValueProcessingEscape	back to summary
private void parseValueProcessingEscape()

parseValueProcessingEscapeMultiDelimiter	back to summary
private void parseValueProcessingEscapeMultiDelimiter()

processQuoteEscape	back to summary
private void processQuoteEscape()

saveMatchingCharacters	back to summary
private void saveMatchingCharacters()

skipValue	back to summary
private void skipValue()

skipWhitespace	back to summary
private void skipWhitespace()

updateFormat

back to summary

public final void updateFormat(CsvFormat format)

Allows changing the format of the input on the fly.

Parameters

format:CsvFormat: the new format to use.

public final Class CsvParser

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail