univocity-parsers 2.9.1 · com.univocity.parsers.common.CommonParserSettings

Modifier and Type	Field and Description
private boolean	autoClosingEnabled
private boolean	columnReorderingEnabled
private boolean	commentCollectionEnabled
private boolean	commentProcessingEnabled
protected Boolean	headerExtractionEnabled
private List<InputAnalysisProcess>	inputAnalysisProcesses
private int	inputBufferSize
private boolean	lineSeparatorDetectionEnabled
private long	numberOfRecordsToRead
private long	numberOfRowsToSkip
private Processor<? extends Context>	processor
private boolean	readInputOnSeparateThread

Access	Constructor and Description
public	CommonParserSettings()

Method Summary

Modifier and Type	Method and Description
protected void	addConfiguration(Map<String, Object> out) Overrides com.univocity.parsers.common.CommonSettings.addConfiguration.
public void	addInputAnalysisProcess(InputAnalysisProcess a custom process to analyze the contents of the first input buffer loaded when the parsing starts. inputAnalysisProcess) Provides a custom `InputAnalysisProcess` to analyze the input buffer and potentially discover configuration options such as column separators is CSV, data formats, etc. The process will be execute only once.
protected void	clearInputSpecificSettings() Overrides com.univocity.parsers.common.CommonSettings.clearInputSpecificSettings. Clears settings that are likely to be specific to a given input.
protected CommonParserSettings<F extends Format>	clone(boolean flag indicating whether to clear settings that are likely to be associated with a given input. clearInputSpecificSettings) Overrides com.univocity.parsers.common.CommonSettings.clone. Clones this configuration object to reuse user-provided settings.
protected CommonParserSettings<F extends Format>	clone() Overrides com.univocity.parsers.common.CommonSettings.clone. Clones this configuration object.
protected synchronized void	configureFromAnnotations(Class<?> the classes whose annotations will be processed to derive configurations for parsing beanClass) Configures the parser based on the annotations provided in a given class
pack-priv FieldSelector	Returns: the FieldSelector object, which handles selected fields. Null if no field was selected/excluded getFieldSelector() Overrides com.univocity.parsers.common.CommonSettings.getFieldSelector. Returns the FieldSelector object, which handles selected fields.
pack-priv FieldSet<?>	Returns: the set of selected fields. Null if no field was selected/excluded getFieldSet() Overrides com.univocity.parsers.common.CommonSettings.getFieldSet. Returns the set of selected fields, if any
public List<InputAnalysisProcess>	Returns: the list of custom processes to analyze the contents of the first input buffer loaded when the parsing starts. getInputAnalysisProcesses() Returns the sequence of `InputAnalysisProcess` to be used for analyzing the input buffer and potentially discover configuration options such as column separators is CSV, data formats, etc. Each process will be execute only once.
public int	Returns: the number of characters held by the parser's buffer when processing the input getInputBufferSize() Informs the number of characters held by the parser's buffer when processing the input (defaults to 1024*1024 characters).
public long	Returns: the number of records to read before stopping the parsing process. getNumberOfRecordsToRead() The number of valid records to be parsed before the process is stopped.
public final long	Returns: number of rows to skip before parsing getNumberOfRowsToSkip() Returns the number of rows to skip from the input before the parser can begin to execute.
public < the context type supported by the parser implementation. T extends Context> Processor<T>	Returns: Returns the `Processor` used by the parser to handle each record getProcessor() Returns the callback implementation of the interface `Processor` which handles the lifecycle of the parsing process and processes each record extracted from the input
public boolean	Returns: true if the input should be read on a separate thread, false otherwise getReadInputOnSeparateThread() Indicates whether or not a separate thread will be used to read characters from the input while parsing (defaults true if the number of available processors at runtime is greater than 1) When enabled, a reading thread (in `com.univocity.parsers.common.input.concurrent.ConcurrentCharInputReader`) will be started and load characters from the input, while the parser is processing its input buffer.
public RowProcessor	Returns: Returns the RowProcessor used by the parser to handle each record getRowProcessor() Deprecated Use the `getProcessor()` method as it allows format-specific processors to be built to work with different implementations of `Context`. Returns the callback implementation of the interface `RowProcessor` which handles the lifecycle of the parsing process and processes each record extracted from the input
public boolean	Returns: flag indicating whether automatic input closing is enabled. isAutoClosingEnabled() Indicates whether automatic closing of the input (reader, stream, etc) is enabled.
public boolean	Returns: true if the selected fields should be reordered and returned by the parser, false otherwise isColumnReorderingEnabled() Indicates whether fields selected using the field selection methods (defined by the parent class `CommonSettings`) should be reordered (defaults to true).
public boolean	Returns: a flag indicating whether or not to enable collection of comments. isCommentCollectionEnabled() Indicates that comments found in the input must be collected (disabled by default).
public boolean	Returns: flag indicating whether parser will check for the comment line If disabled/false then parser wont treat any line as comment line including default(#) this condition will supersede the comment character(#) isCommentProcessingEnabled() Indicates whether code will check for comment line in the data file is enabled.
public boolean	Returns: true if the first valid record parsed from the input should be considered as the row containing the names of each column, false otherwise isHeaderExtractionEnabled() Indicates whether or not the first valid record parsed from the input should be considered as the row containing the names of each column
public final boolean	Returns: `true` if the first line of the input should be used to search for common line separator sequences (the matching sequence will be used as the line separator for parsing). Otherwise `false`. isLineSeparatorDetectionEnabled() Indicates whether the parser should detect the line separator automatically.
protected CharAppender	Returns: an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent a null value (when the String parsed from the input is empty) newCharAppender() Returns an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent a null value (when the String parsed from the input is empty)
protected CharInputReader	Returns: The input reader as chosen with the readInputOnSeparateThread property. newCharInputReader(int starting range of characters considered to be whitespace. whitespaceRangeStart) An implementation of `CharInputReader` which loads the parser buffer in parallel or sequentially, as defined by the readInputOnSeparateThread property
private boolean	preventReordering()
pack-priv final void	runAutomaticConfiguration() Overrides com.univocity.parsers.common.CommonSettings.runAutomaticConfiguration.
public void	setAutoClosingEnabled(boolean flag determining whether automatic input closing should be enabled. autoClosingEnabled) Configures whether the parser should always close the input (reader, stream, etc) automatically when all records have been parsed or when an error occurs.
public void	setColumnReorderingEnabled(boolean the flag indicating whether or not selected fields should be reordered and returned by the parser columnReorderingEnabled) Defines whether fields selected using the field selection methods (defined by the parent class `CommonSettings`) should be reordered (defaults to true).
public void	setCommentCollectionEnabled(boolean flag indicating whether or not to enable collection of comments. commentCollectionEnabled) Enables collection of comments found in the input (disabled by default).
public void	setCommentProcessingEnabled(boolean flag determining whether comment line check should be performed If disabled/false then parser wont treat any line as comment line including default(#) this condition will supersede the comment character(#) commentProcessingEnabled) Configures whether the parser will check for the comment line in the file Defaults to `true`
public void	setHeaderExtractionEnabled(boolean a flag indicating whether the first valid record parsed from the input should be considered as the row containing the names of each column headerExtractionEnabled) Defines whether or not the first valid record parsed from the input should be considered as the row containing the names of each column
public void	setInputBufferSize(int the new input buffer size (in number of characters) inputBufferSize) Defines the number of characters held by the parser's buffer when processing the input (defaults to 1024*1024 characters).
public final void	setLineSeparatorDetectionEnabled(boolean a flag indicating whether the first line of the input should be used to search for common line separator sequences (the matching sequence will be used as the line separator for parsing). lineSeparatorDetectionEnabled) Defines whether the parser should detect the line separator automatically.
public void	setNumberOfRecordsToRead(long the number of records to read before stopping the parsing process. numberOfRecordsToRead) Defines the number of valid records to be parsed before the process is stopped.
public final void	setNumberOfRowsToSkip(long number of rows to skip before parsing numberOfRowsToSkip) Defines a number of rows to skip from the input before the parser can begin to execute.
public void	setProcessor(Processor<? extends Context> the `Processor` instance which should used by the parser to handle each record processor) Defines the callback implementation of the interface `Processor` which handles the lifecycle of the parsing process and processes each record extracted from the input
public void	setReadInputOnSeparateThread(boolean the flag indicating whether or not the input should be read on a separate thread readInputOnSeparateThread) Defines whether or not a separate thread will be used to read characters from the input while parsing (defaults true if the number of available processors at runtime is greater than 1) When enabled, a reading thread (in `com.univocity.parsers.common.input.concurrent.ConcurrentCharInputReader`) will be started and load characters from the input, while the parser is processing its input buffer.
public void	setRowProcessor(RowProcessor the RowProcessor instance which should used by the parser to handle each record processor) Deprecated Use the `setProcessor(Processor)` method as it allows format-specific processors to be built to work with different implementations of `Context`. Defines the callback implementation of the interface `RowProcessor` which handles the lifecycle of the parsing process and processes each record extracted from the input

autoClosingEnabled	back to summary
private boolean autoClosingEnabled

columnReorderingEnabled	back to summary
private boolean columnReorderingEnabled

commentCollectionEnabled	back to summary
private boolean commentCollectionEnabled

commentProcessingEnabled	back to summary
private boolean commentProcessingEnabled

headerExtractionEnabled	back to summary
protected Boolean headerExtractionEnabled

inputAnalysisProcesses	back to summary
private List<InputAnalysisProcess> inputAnalysisProcesses

inputBufferSize	back to summary
private int inputBufferSize

lineSeparatorDetectionEnabled	back to summary
private boolean lineSeparatorDetectionEnabled

numberOfRecordsToRead	back to summary
private long numberOfRecordsToRead

numberOfRowsToSkip	back to summary
private long numberOfRowsToSkip

processor	back to summary
private Processor<? extends Context> processor

readInputOnSeparateThread	back to summary
private boolean readInputOnSeparateThread

CommonParserSettings	back to summary
public CommonParserSettings()

Method Detail

addConfiguration	back to summary
protected void addConfiguration(Map<String, Object> out) Overrides com.univocity.parsers.common.CommonSettings.addConfiguration. Annotations @Override

addConfiguration

back to summary

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

Overrides com.univocity.parsers.common.CommonSettings.addConfiguration.

Annotations

@Override

addInputAnalysisProcess back to summary

addInputAnalysisProcess	back to summary
public void addInputAnalysisProcess(InputAnalysisProcess inputAnalysisProcess) Provides a custom `InputAnalysisProcess` to analyze the input buffer and potentially discover configuration options such as column separators is CSV, data formats, etc. The process will be execute only once. Parameters inputAnalysisProcess:InputAnalysisProcess a custom process to analyze the contents of the first input buffer loaded when the parsing starts.

public void addInputAnalysisProcess(InputAnalysisProcess inputAnalysisProcess)

Provides a custom InputAnalysisProcess to analyze the input buffer and potentially discover configuration options such as column separators is CSV, data formats, etc. The process will be execute only once.

Parameters

inputAnalysisProcess:InputAnalysisProcess: a custom process to analyze the contents of the first input buffer loaded when the parsing starts.

clearInputSpecificSettings	back to summary
protected void clearInputSpecificSettings() Overrides com.univocity.parsers.common.CommonSettings.clearInputSpecificSettings. Doc from com.univocity.parsers.common.CommonSettings.clearInputSpecificSettings. Clears settings that are likely to be specific to a given input. Annotations @Override

clearInputSpecificSettings

back to summary

protected void clearInputSpecificSettings()

Overrides com.univocity.parsers.common.CommonSettings.clearInputSpecificSettings.

Doc from com.univocity.parsers.common.CommonSettings.clearInputSpecificSettings.

Clears settings that are likely to be specific to a given input.

Annotations

@Override

clone back to summary

clone	back to summary
protected CommonParserSettings<F extends Format> clone(boolean clearInputSpecificSettings) Overrides com.univocity.parsers.common.CommonSettings.clone. Doc from com.univocity.parsers.common.CommonSettings.clone. 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` Parameters clearInputSpecificSettings:boolean flag indicating whether to clear settings that are likely to be associated with a given input. Returns:CommonParserSettings<F extends Format> a copy of the configurations applied to the current instance. Annotations @Override

protected CommonParserSettings<F extends Format> clone(boolean clearInputSpecificSettings)

Overrides com.univocity.parsers.common.CommonSettings.clone.

Doc from com.univocity.parsers.common.CommonSettings.clone.

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

Parameters

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

Returns:CommonParserSettings<F extends Format>

a copy of the configurations applied to the current instance.

Annotations

@Override

clone back to summary

clone	back to summary
protected CommonParserSettings<F extends Format> clone() Overrides com.univocity.parsers.common.CommonSettings.clone. Doc from com.univocity.parsers.common.CommonSettings.clone. Clones this configuration object. Use alternative `clone(boolean)` method to reset properties that are specific to a given input, such as header names and selection of fields. Returns:CommonParserSettings<F extends Format> a copy of all configurations applied to the current instance. Annotations @Override

protected CommonParserSettings<F extends Format> clone()

Overrides com.univocity.parsers.common.CommonSettings.clone.

Doc from com.univocity.parsers.common.CommonSettings.clone.

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

Returns:CommonParserSettings<F extends Format>

a copy of all configurations applied to the current instance.

Annotations

@Override

configureFromAnnotations	back to summary
protected synchronized void configureFromAnnotations(Class<?> beanClass) Configures the parser based on the annotations provided in a given class Parameters beanClass:Class<?> the classes whose annotations will be processed to derive configurations for parsing

configureFromAnnotations

back to summary

protected synchronized void configureFromAnnotations(Class<?> beanClass)

Configures the parser based on the annotations provided in a given class

Parameters

beanClass:Class<?>: the classes whose annotations will be processed to derive configurations for parsing

getFieldSelector	back to summary
pack-priv FieldSelector getFieldSelector() Overrides com.univocity.parsers.common.CommonSettings.getFieldSelector. Returns the FieldSelector object, which handles selected fields. Returns:FieldSelector the FieldSelector object, which handles selected fields. Null if no field was selected/excluded Annotations @Override

getFieldSelector

back to summary

pack-priv FieldSelector getFieldSelector()

Overrides com.univocity.parsers.common.CommonSettings.getFieldSelector.

Returns the FieldSelector object, which handles selected fields.

Returns:FieldSelector

the FieldSelector object, which handles selected fields. Null if no field was selected/excluded

Annotations

@Override

getFieldSet	back to summary
pack-priv FieldSet<?> getFieldSet() Overrides com.univocity.parsers.common.CommonSettings.getFieldSet. Returns the set of selected fields, if any Returns:FieldSet<?> the set of selected fields. Null if no field was selected/excluded Annotations @Override

getFieldSet

back to summary

pack-priv FieldSet<?> getFieldSet()

Overrides com.univocity.parsers.common.CommonSettings.getFieldSet.

Returns the set of selected fields, if any

Returns:FieldSet<?>

the set of selected fields. Null if no field was selected/excluded

Annotations

@Override

getInputAnalysisProcesses back to summary

getInputAnalysisProcesses	back to summary
public List<InputAnalysisProcess> getInputAnalysisProcesses() Returns the sequence of `InputAnalysisProcess` to be used for analyzing the input buffer and potentially discover configuration options such as column separators is CSV, data formats, etc. Each process will be execute only once. Returns:List<InputAnalysisProcess> the list of custom processes to analyze the contents of the first input buffer loaded when the parsing starts.

public List<InputAnalysisProcess> getInputAnalysisProcesses()

Returns the sequence of InputAnalysisProcess to be used for analyzing the input buffer and potentially discover configuration options such as column separators is CSV, data formats, etc. Each process will be execute only once.

Returns:List<InputAnalysisProcess>: the list of custom processes to analyze the contents of the first input buffer loaded when the parsing starts.

getInputBufferSize	back to summary
public int getInputBufferSize() Informs the number of characters held by the parser's buffer when processing the input (defaults to 1024*1024 characters). Returns:int the number of characters held by the parser's buffer when processing the input

getInputBufferSize

back to summary

public int getInputBufferSize()

Informs the number of characters held by the parser's buffer when processing the input (defaults to 1024*1024 characters).

Returns:int: the number of characters held by the parser's buffer when processing the input

getNumberOfRecordsToRead	back to summary
public long getNumberOfRecordsToRead() The number of valid records to be parsed before the process is stopped. A negative value indicates there's no limit (defaults to -1). Returns:long the number of records to read before stopping the parsing process.

getNumberOfRecordsToRead

back to summary

public long getNumberOfRecordsToRead()

The number of valid records to be parsed before the process is stopped. A negative value indicates there's no limit (defaults to -1).

Returns:long: the number of records to read before stopping the parsing process.

getNumberOfRowsToSkip	back to summary
public final long getNumberOfRowsToSkip() Returns the number of rows to skip from the input before the parser can begin to execute. Returns:long number of rows to skip before parsing

getNumberOfRowsToSkip

back to summary

public final long getNumberOfRowsToSkip()

Returns the number of rows to skip from the input before the parser can begin to execute.

Returns:long: number of rows to skip before parsing

getProcessor back to summary

getProcessor	back to summary
public <T extends Context> Processor<T> getProcessor() Returns the callback implementation of the interface `Processor` which handles the lifecycle of the parsing process and processes each record extracted from the input Parameters <T> the context type supported by the parser implementation. Returns:Processor<T> Returns the `Processor` used by the parser to handle each record See Also `AbstractObjectProcessor`, `AbstractObjectListProcessor`, `AbstractMasterDetailProcessor`, `AbstractMasterDetailListProcessor`, `AbstractBeanProcessor`, `AbstractBeanListProcessor`

public <T extends Context> Processor<T> getProcessor()

Returns the callback implementation of the interface Processor which handles the lifecycle of the parsing process and processes each record extracted from the input

Parameters

<T>: the context type supported by the parser implementation.

Returns:Processor<T>

Returns the Processor used by the parser to handle each record

getReadInputOnSeparateThread back to summary

getReadInputOnSeparateThread	back to summary
public boolean getReadInputOnSeparateThread() Indicates whether or not a separate thread will be used to read characters from the input while parsing (defaults true if the number of available processors at runtime is greater than 1) When enabled, a reading thread (in `com.univocity.parsers.common.input.concurrent.ConcurrentCharInputReader`) will be started and load characters from the input, while the parser is processing its input buffer. This yields better performance, especially when reading from big input (greater than 100 mb) When disabled, the parsing process will briefly pause so the buffer can be replenished every time it is exhausted (in `DefaultCharInputReader` it is not as bad or slow as it sounds, and can even be (slightly) more efficient if your input is small) Returns:boolean true if the input should be read on a separate thread, false otherwise

public boolean getReadInputOnSeparateThread()

Indicates whether or not a separate thread will be used to read characters from the input while parsing (defaults true if the number of available processors at runtime is greater than 1)

When enabled, a reading thread (in com.univocity.parsers.common.input.concurrent.ConcurrentCharInputReader) will be started and load characters from the input, while the parser is processing its input buffer. This yields better performance, especially when reading from big input (greater than 100 mb)

When disabled, the parsing process will briefly pause so the buffer can be replenished every time it is exhausted (in DefaultCharInputReader it is not as bad or slow as it sounds, and can even be (slightly) more efficient if your input is small)

Returns:boolean: true if the input should be read on a separate thread, false otherwise

getRowProcessor back to summary

getRowProcessor	back to summary
public RowProcessor getRowProcessor() Deprecated Use the `getProcessor()` method as it allows format-specific processors to be built to work with different implementations of `Context`. Implementations based on `RowProcessor` allow only parsers who provide a `ParsingContext` to be used. Returns the callback implementation of the interface `RowProcessor` which handles the lifecycle of the parsing process and processes each record extracted from the input Returns:RowProcessor Returns the RowProcessor used by the parser to handle each record Annotations @Deprecated See Also `com.univocity.parsers.common.processor.ObjectRowProcessor`, `com.univocity.parsers.common.processor.ObjectRowListProcessor`, `com.univocity.parsers.common.processor.MasterDetailProcessor`, `com.univocity.parsers.common.processor.MasterDetailListProcessor`, `com.univocity.parsers.common.processor.BeanProcessor`, `com.univocity.parsers.common.processor.BeanListProcessor`

public RowProcessor getRowProcessor()

Deprecated

Use the getProcessor() method as it allows format-specific processors to be built to work with different implementations of Context. Implementations based on RowProcessor allow only parsers who provide a ParsingContext to be used.

Returns the callback implementation of the interface RowProcessor which handles the lifecycle of the parsing process and processes each record extracted from the input

Returns:RowProcessor

Returns the RowProcessor used by the parser to handle each record

Annotations

@Deprecated

isAutoClosingEnabled back to summary

isAutoClosingEnabled	back to summary
public boolean isAutoClosingEnabled() Indicates whether automatic closing of the input (reader, stream, etc) is enabled. If `true`, the parser will always close the input automatically when all records have been parsed or when an error occurs. Defaults to `true` Returns:boolean flag indicating whether automatic input closing is enabled.

public boolean isAutoClosingEnabled()

Indicates whether automatic closing of the input (reader, stream, etc) is enabled. If true, the parser will always close the input automatically when all records have been parsed or when an error occurs. Defaults to true

Returns:boolean: flag indicating whether automatic input closing is enabled.

isColumnReorderingEnabled back to summary

isColumnReorderingEnabled	back to summary
public boolean isColumnReorderingEnabled() Indicates whether fields selected using the field selection methods (defined by the parent class `CommonSettings`) should be reordered (defaults to true). When disabled, each parsed record will contain values for all columns, in the order they occur in the input. Fields which were not selected will not be parsed but and the record will contain empty values. When enabled, each parsed record will contain values only for the selected columns. The values will be ordered according to the selection. Returns:boolean true if the selected fields should be reordered and returned by the parser, false otherwise

public boolean isColumnReorderingEnabled()

Indicates whether fields selected using the field selection methods (defined by the parent class CommonSettings) should be reordered (defaults to true).

When disabled, each parsed record will contain values for all columns, in the order they occur in the input. Fields which were not selected will not be parsed but and the record will contain empty values.

When enabled, each parsed record will contain values only for the selected columns. The values will be ordered according to the selection.

Returns:boolean: true if the selected fields should be reordered and returned by the parser, false otherwise

isCommentCollectionEnabled back to summary

isCommentCollectionEnabled	back to summary
public boolean isCommentCollectionEnabled() Indicates that comments found in the input must be collected (disabled by default). If enabled, comment lines will be stored by the parser and made available via `AbstractParser.getContext().comments()` and `AbstractParser.getContext().lastComment()` Returns:boolean a flag indicating whether or not to enable collection of comments.

public boolean isCommentCollectionEnabled()

Indicates that comments found in the input must be collected (disabled by default). If enabled, comment lines will be stored by the parser and made available via AbstractParser.getContext().comments() and AbstractParser.getContext().lastComment()

Returns:boolean: a flag indicating whether or not to enable collection of comments.

isCommentProcessingEnabled back to summary

isCommentProcessingEnabled	back to summary
public boolean isCommentProcessingEnabled() Indicates whether code will check for comment line in the data file is enabled. If `true`, the parser will always check for the comment line default value for comment check is # Defaults to `true` Returns:boolean flag indicating whether parser will check for the comment line If disabled/false then parser wont treat any line as comment line including default(#) this condition will supersede the comment character(#)

public boolean isCommentProcessingEnabled()

Indicates whether code will check for comment line in the data file is enabled. If true, the parser will always check for the comment line default value for comment check is # Defaults to true

Returns:boolean: flag indicating whether parser will check for the comment line If disabled/false then parser wont treat any line as comment line including default(#) this condition will supersede the comment character(#)

isHeaderExtractionEnabled	back to summary
public boolean isHeaderExtractionEnabled() Indicates whether or not the first valid record parsed from the input should be considered as the row containing the names of each column Returns:boolean true if the first valid record parsed from the input should be considered as the row containing the names of each column, false otherwise

isHeaderExtractionEnabled

back to summary

public boolean isHeaderExtractionEnabled()

Indicates whether or not the first valid record parsed from the input should be considered as the row containing the names of each column

Returns:boolean: true if the first valid record parsed from the input should be considered as the row containing the names of each column, false otherwise

isLineSeparatorDetectionEnabled back to summary

isLineSeparatorDetectionEnabled	back to summary
public final boolean isLineSeparatorDetectionEnabled() Indicates whether the parser should detect the line separator automatically. Returns:boolean `true` if the first line of the input should be used to search for common line separator sequences (the matching sequence will be used as the line separator for parsing). Otherwise `false`.

public final boolean isLineSeparatorDetectionEnabled()

Indicates whether the parser should detect the line separator automatically.

Returns:boolean: true if the first line of the input should be used to search for common line separator sequences (the matching sequence will be used as the line separator for parsing). Otherwise false.

newCharAppender	back to summary
protected CharAppender newCharAppender() Returns an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent a null value (when the String parsed from the input is empty) Returns:CharAppender an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent a null value (when the String parsed from the input is empty)

newCharAppender

back to summary

protected CharAppender newCharAppender()

Returns an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent a null value (when the String parsed from the input is empty)

Returns:CharAppender: an instance of CharAppender with the configured limit of maximum characters per column and the default value used to represent a null value (when the String parsed from the input is empty)

newCharInputReader back to summary

newCharInputReader	back to summary
protected CharInputReader newCharInputReader(int whitespaceRangeStart) An implementation of `CharInputReader` which loads the parser buffer in parallel or sequentially, as defined by the readInputOnSeparateThread property Parameters whitespaceRangeStart:int starting range of characters considered to be whitespace. Returns:CharInputReader The input reader as chosen with the readInputOnSeparateThread property.

protected CharInputReader newCharInputReader(int whitespaceRangeStart)

An implementation of CharInputReader which loads the parser buffer in parallel or sequentially, as defined by the readInputOnSeparateThread property

Parameters

whitespaceRangeStart:int: starting range of characters considered to be whitespace.

Returns:CharInputReader

The input reader as chosen with the readInputOnSeparateThread property.

preventReordering	back to summary
private boolean preventReordering()

runAutomaticConfiguration	back to summary
pack-priv final void runAutomaticConfiguration() Overrides com.univocity.parsers.common.CommonSettings.runAutomaticConfiguration. Annotations @Override

runAutomaticConfiguration

back to summary

pack-priv final void runAutomaticConfiguration()

Overrides com.univocity.parsers.common.CommonSettings.runAutomaticConfiguration.

Annotations

@Override

setAutoClosingEnabled back to summary

setAutoClosingEnabled	back to summary
public void setAutoClosingEnabled(boolean autoClosingEnabled) Configures whether the parser should always close the input (reader, stream, etc) automatically when all records have been parsed or when an error occurs. Defaults to `true` Parameters autoClosingEnabled:boolean flag determining whether automatic input closing should be enabled.

public void setAutoClosingEnabled(boolean autoClosingEnabled)

Configures whether the parser should always close the input (reader, stream, etc) automatically when all records have been parsed or when an error occurs. Defaults to true

Parameters

autoClosingEnabled:boolean: flag determining whether automatic input closing should be enabled.

setColumnReorderingEnabled back to summary

setColumnReorderingEnabled	back to summary
public void setColumnReorderingEnabled(boolean columnReorderingEnabled) Defines whether fields selected using the field selection methods (defined by the parent class `CommonSettings`) should be reordered (defaults to true). When disabled, each parsed record will contain values for all columns, in the order they occur in the input. Fields which were not selected will not be parsed but the record will contain empty values. When enabled, each parsed record will contain values only for the selected columns. The values will be ordered according to the selection. Parameters columnReorderingEnabled:boolean the flag indicating whether or not selected fields should be reordered and returned by the parser

public void setColumnReorderingEnabled(boolean columnReorderingEnabled)

Defines whether fields selected using the field selection methods (defined by the parent class CommonSettings) should be reordered (defaults to true).

When disabled, each parsed record will contain values for all columns, in the order they occur in the input. Fields which were not selected will not be parsed but the record will contain empty values.

When enabled, each parsed record will contain values only for the selected columns. The values will be ordered according to the selection.

Parameters

columnReorderingEnabled:boolean: the flag indicating whether or not selected fields should be reordered and returned by the parser

setCommentCollectionEnabled back to summary

setCommentCollectionEnabled	back to summary
public void setCommentCollectionEnabled(boolean commentCollectionEnabled) Enables collection of comments found in the input (disabled by default). If enabled, comment lines will be stored by the parser and made available via `AbstractParser.getContext().comments()` and `AbstractParser.getContext().lastComment()` Parameters commentCollectionEnabled:boolean flag indicating whether or not to enable collection of comments.

public void setCommentCollectionEnabled(boolean commentCollectionEnabled)

Enables collection of comments found in the input (disabled by default). If enabled, comment lines will be stored by the parser and made available via AbstractParser.getContext().comments() and AbstractParser.getContext().lastComment()

Parameters

commentCollectionEnabled:boolean: flag indicating whether or not to enable collection of comments.

setCommentProcessingEnabled back to summary

setCommentProcessingEnabled	back to summary
public void setCommentProcessingEnabled(boolean commentProcessingEnabled) Configures whether the parser will check for the comment line in the file Defaults to `true` Parameters commentProcessingEnabled:boolean flag determining whether comment line check should be performed If disabled/false then parser wont treat any line as comment line including default(#) this condition will supersede the comment character(#)

public void setCommentProcessingEnabled(boolean commentProcessingEnabled)

Configures whether the parser will check for the comment line in the file Defaults to true

Parameters

commentProcessingEnabled:boolean: flag determining whether comment line check should be performed If disabled/false then parser wont treat any line as comment line including default(#) this condition will supersede the comment character(#)

setHeaderExtractionEnabled	back to summary
public void setHeaderExtractionEnabled(boolean headerExtractionEnabled) Defines whether or not the first valid record parsed from the input should be considered as the row containing the names of each column Parameters headerExtractionEnabled:boolean a flag indicating whether the first valid record parsed from the input should be considered as the row containing the names of each column

setHeaderExtractionEnabled

back to summary

public void setHeaderExtractionEnabled(boolean headerExtractionEnabled)

Defines whether or not the first valid record parsed from the input should be considered as the row containing the names of each column

Parameters

headerExtractionEnabled:boolean: a flag indicating whether the first valid record parsed from the input should be considered as the row containing the names of each column

setInputBufferSize	back to summary
public void setInputBufferSize(int inputBufferSize) Defines the number of characters held by the parser's buffer when processing the input (defaults to 1024*1024 characters). Parameters inputBufferSize:int the new input buffer size (in number of characters)

setInputBufferSize

back to summary

public void setInputBufferSize(int inputBufferSize)

Defines the number of characters held by the parser's buffer when processing the input (defaults to 1024*1024 characters).

Parameters

inputBufferSize:int: the new input buffer size (in number of characters)

setLineSeparatorDetectionEnabled	back to summary
public final void setLineSeparatorDetectionEnabled(boolean lineSeparatorDetectionEnabled) Defines whether the parser should detect the line separator automatically. Parameters lineSeparatorDetectionEnabled:boolean a flag indicating whether the first line of the input should be used to search for common line separator sequences (the matching sequence will be used as the line separator for parsing).

setLineSeparatorDetectionEnabled

back to summary

public final void setLineSeparatorDetectionEnabled(boolean lineSeparatorDetectionEnabled)

Defines whether the parser should detect the line separator automatically.

Parameters

lineSeparatorDetectionEnabled:boolean: a flag indicating whether the first line of the input should be used to search for common line separator sequences (the matching sequence will be used as the line separator for parsing).

setNumberOfRecordsToRead	back to summary
public void setNumberOfRecordsToRead(long numberOfRecordsToRead) Defines the number of valid records to be parsed before the process is stopped. A negative value indicates there's no limit (defaults to -1). Parameters numberOfRecordsToRead:long the number of records to read before stopping the parsing process.

setNumberOfRecordsToRead

back to summary

public void setNumberOfRecordsToRead(long numberOfRecordsToRead)

Defines the number of valid records to be parsed before the process is stopped. A negative value indicates there's no limit (defaults to -1).

Parameters

numberOfRecordsToRead:long: the number of records to read before stopping the parsing process.

setNumberOfRowsToSkip	back to summary
public final void setNumberOfRowsToSkip(long numberOfRowsToSkip) Defines a number of rows to skip from the input before the parser can begin to execute. Parameters numberOfRowsToSkip:long number of rows to skip before parsing

setNumberOfRowsToSkip

back to summary

public final void setNumberOfRowsToSkip(long numberOfRowsToSkip)

Defines a number of rows to skip from the input before the parser can begin to execute.

Parameters

numberOfRowsToSkip:long: number of rows to skip before parsing

setProcessor back to summary

public void setProcessor(Processor<? extends Context> processor)

Defines the callback implementation of the interface Processor which handles the lifecycle of the parsing process and processes each record extracted from the input

Parameters

processor:Processor<? extends Context>: the Processor instance which should used by the parser to handle each record

setReadInputOnSeparateThread back to summary

public void setReadInputOnSeparateThread(boolean readInputOnSeparateThread)

Defines whether or not a separate thread will be used to read characters from the input while parsing (defaults true if the number of available processors at runtime is greater than 1)

Parameters

readInputOnSeparateThread:boolean: the flag indicating whether or not the input should be read on a separate thread

setRowProcessor back to summary

public void setRowProcessor(RowProcessor processor)

Deprecated

Use the setProcessor(Processor) method as it allows format-specific processors to be built to work with different implementations of Context. Implementations based on RowProcessor allow only parsers who provide a ParsingContext to be used.

Defines the callback implementation of the interface RowProcessor which handles the lifecycle of the parsing process and processes each record extracted from the input

Parameters

processor:RowProcessor: the RowProcessor instance which should used by the parser to handle each record

Annotations

@Deprecated

See Also

public abstract Class CommonParserSettings<F extends Format>

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail