com.univocity.parsers.common
Interface Context

All Known Subinterfaces:

ParsingContext

All Known Implementing Classes:

ContextSnapshot, ContextWrapper, DefaultContext, DefaultParsingContext, ParsingContextSnapshot, ParsingContextWrapper

public interface Context

Basic context information used internally by instances of Processor and Record.

Author:

uniVocity Software Pty Ltd - dev@univocity.com

See Also:

DefaultContext, ParsingContext, DefaultParsingContext

Method Summary

boolean	columnsReordered() Indicates whether selected fields are being reordered.
int	currentColumn() Returns the column index of the record being processed.
long	currentRecord() Returns the index of the last valid record parsed from the input
int	errorContentLength() Returns the length limit of parsed contents appearing in exception messages when an error occurs
int[]	extractedFieldIndexes() Returns the indexes of each field extracted from the input when fields are selected.
String[]	headers() Returns the file headers that identify each parsed record.
int	indexOf(Enum<?> header) Returns the position of a header (0 based).
int	indexOf(String header) Returns the position of a header (0 based).
boolean	isStopped() Identifies whether the parser is running.
String[]	selectedHeaders() Returns the sequence of headers that have been selected.
void	stop() Stops the parsing process.

Method Detail

headers

String[] headers()

Returns the file headers that identify each parsed record.

Returns:

the headers used to identify each record parsed from the input.

selectedHeaders

String[] selectedHeaders()

Returns the sequence of headers that have been selected. If no selection has been made, all available headers will be returned, producing the same output as a call to method headers().

Returns:

the sequence of selected headers, or all headers if no selection has been made.

extractedFieldIndexes

int[] extractedFieldIndexes()

Returns the indexes of each field extracted from the input when fields are selected.

The indexes are relative to their original position in the input.

For example, if the input has the fields "A, B, C, D", and the selected fields are "A, D", then the extracted field indexes will return [0, 3]

If no fields were selected, then this method will return null. This means all fields are being parsed.

Returns:

The indexes of each selected field; null if no fields were selected.

See Also:

CommonSettings

columnsReordered

boolean columnsReordered()

Indicates whether selected fields are being reordered.

If columns are reordered, each parsed record will contain values only for the selected fields, as specified by extractedFieldIndexes()

Returns:

true if the parsed records are being reordered by the parser, false otherwise

See Also:

CommonParserSettings, CommonSettings

indexOf

int indexOf(String header)

Returns the position of a header (0 based).

Parameters:

header - the header whose position will be returned

Returns:

the position of the given header, or -1 if it could not be found.

indexOf

int indexOf(Enum<?> header)

Returns the position of a header (0 based).

Parameters:

header - the header whose position will be returned

Returns:

the position of the given header, or -1 if it could not be found.

currentColumn

int currentColumn()

Returns the column index of the record being processed.

Returns:

the column index of the record being processed.

currentRecord

long currentRecord()

Returns the index of the last valid record parsed from the input

Returns:

the index of the last valid record parsed from the input

stop

void stop()

Stops the parsing process. Any open resources in use by the parser are closed automatically.

isStopped

boolean isStopped()

Identifies whether the parser is running.

Returns:

true if the parser is stopped, false otherwise.

errorContentLength

int errorContentLength()

Returns the length limit of parsed contents appearing in exception messages when an error occurs

If 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 content.

defaults to -1 (no limit)

.

Returns:

the maximum length of the data content to display in exception messages