Package org.basex.build.csv

Class CsvOptions

java.lang.Object

org.basex.util.options.Options

org.basex.build.csv.CsvOptions

All Implemented Interfaces:

Iterable<Option<?>>

Direct Known Subclasses:

CsvParserOptions

public class CsvOptions
extends Options

Options for parsing and serializing CSV data.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	CsvOptions.CsvFormat	CSV formats.
static class	CsvOptions.CsvSep	CSV separators.

Nested classes/interfaces inherited from class org.basex.util.options.Options

Options.YesNo, Options.YesNoOmit

Field Summary

Fields

Modifier and Type	Field	Description
static BooleanOption	BACKSLASHES	Option: backslash flag .
static EnumOption<CsvOptions.CsvFormat>	FORMAT	Option: format.
static BooleanOption	HEADER	Option: header line.
static BooleanOption	LAX	Option: lax conversion of strings to QNames.
static BooleanOption	QUOTES	Option: parse quotes.
static StringOption	SEPARATOR	Option: column separator.

Constructor Summary

Constructors

Constructor	Description
CsvOptions()	Default constructor.

Method Summary

Modifier and Type	Method	Description
void	assign(String name, String value)	Assigns a value after casting it to the correct type.
void	assign(Item name, Value value, QueryError error, InputInfo info)	Assigns a value after casting it to the correct type.
int	separator()	Returns the separator character or -1 if character is invalid.

Methods inherited from class org.basex.util.options.Options

allowed, assign, assign, assign, assign, contains, free, get, get, get, get, get, get, get, get, get, get, invert, iterator, names, option, put, set, set, set, set, set, set, set, set, setSystem, similar, similar, toMap, toMap, toString, write

Methods inherited from class java.lang.Object

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

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

SEPARATOR

public static final StringOption SEPARATOR

Option: column separator.

FORMAT

public static final EnumOption<CsvOptions.CsvFormat> FORMAT

Option: format.

HEADER

public static final BooleanOption HEADER

Option: header line.

BACKSLASHES

public static final BooleanOption BACKSLASHES

Option: backslash flag .

LAX

public static final BooleanOption LAX

Option: lax conversion of strings to QNames.

QUOTES

public static final BooleanOption QUOTES

Option: parse quotes.

Constructor Detail

CsvOptions

public CsvOptions()

Default constructor.

Method Detail

assign

public void assign(String name,
                   String value)
            throws BaseXException

Description copied from class: Options

Assigns a value after casting it to the correct type. If the option is unknown, it will be added as free option.

Overrides:

assign in class Options

Parameters:

name - name of option

value - value

Throws:

BaseXException - database exception

assign

public void assign(Item name,
                   Value value,
                   QueryError error,
                   InputInfo info)
            throws QueryException

Description copied from class: Options

Assigns a value after casting it to the correct type. If the option is unknown, it will be added as free option.

Overrides:

assign in class Options

Parameters:

name - name of option

value - value to be assigned

error - error to be raised if option is unknown (can be null)

info - input info (can be null)

Throws:

QueryException - query exception

separator

public int separator()

Returns the separator character or -1 if character is invalid.

Returns:

separator