water.parser

Class BinaryParserProvider

java.lang.Object

water.parser.ParserProvider

water.parser.BinaryParserProvider

public abstract class BinaryParserProvider
extends ParserProvider

Base class for Binary format parsers that implements 2-phase ParseSetup.

Constructor Summary

Constructors

Constructor and Description
BinaryParserProvider()

Method Summary

Modifier and Type	Method and Description
abstract ParseSetup	guessFinalSetup(ByteVec v, byte[] bits, ParseSetup ps) Finalizes ParseSetup created by guessInitSetup using data read from a given ByteVec/bits.
abstract ParseSetup	guessInitSetup(ByteVec v, byte[] bits, ParseSetup userSetup) Constructs initial ParseSetup from a given user setup Any exception thrown by this method will signal that this ParserProvider doesn't support the input data.
ParseSetup	guessSetup(ByteVec v, byte[] bits, byte sep, int ncols, boolean singleQuotes, int checkHeader, java.lang.String[] columnNames, byte[] columnTypes, java.lang.String[][] domains, java.lang.String[][] naStrings) Deprecated.

Methods inherited from class water.parser.ParserProvider

createParser, createParserSetup, guessSetup_impl, guessSetup, info, setupLocal

Methods inherited from class java.lang.Object

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

Constructor Detail

BinaryParserProvider

public BinaryParserProvider()

Method Detail

guessInitSetup

public abstract ParseSetup guessInitSetup(ByteVec v,
                                          byte[] bits,
                                          ParseSetup userSetup)

Constructs initial ParseSetup from a given user setup Any exception thrown by this method will signal that this ParserProvider doesn't support the input data. Parsers of data formats that provide metadata (eg. a binary file formats like Parquet) should use the file metadata to identify the parse type and possibly other properties of the ParseSetup that can be determined just from the metadata itself. The goal should be perform the least amount of operations to correctly determine the ParseType (any exception means - format is not supported!). Note: Some file formats like CSV don't provide any metadata. In that case this method can return the final ParseSetup.

Overrides:

guessInitSetup in class ParserProvider

Parameters:

v - optional ByteVec

bits - first bytes of the file

userSetup - user specified setup

Returns:

null if this Provider cannot provide a parser for this file, otherwise an instance of ParseSetup with correct setting of ParseSetup._parse_type

guessFinalSetup

public abstract ParseSetup guessFinalSetup(ByteVec v,
                                           byte[] bits,
                                           ParseSetup ps)

Finalizes ParseSetup created by guessInitSetup using data read from a given ByteVec/bits.

Overrides:

guessFinalSetup in class ParserProvider

Parameters:

v - optional ByteVec

bits - first bytes of the file

ps - parse setup as created by guessInitSetup

Returns:

fully initialized ParseSetup

guessSetup

@Deprecated
public final ParseSetup guessSetup(ByteVec v,
                                               byte[] bits,
                                               byte sep,
                                               int ncols,
                                               boolean singleQuotes,
                                               int checkHeader,
                                               java.lang.String[] columnNames,
                                               byte[] columnTypes,
                                               java.lang.String[][] domains,
                                               java.lang.String[][] naStrings)

Deprecated.

Description copied from class: ParserProvider

Returns parser setup of throws exception if input is not recognized

Overrides:

guessSetup in class ParserProvider