org.neo4j.csv.reader

Interface Configuration

All Known Implementing Classes:

Configuration.Default, Configuration.Overridden

public interface Configuration

Configuration options around reading CSV data, or similar.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	Configuration.Default
static class	Configuration.Overridden

Field Summary

Fields

Modifier and Type	Field and Description
static Configuration	DEFAULT
static boolean	DEFAULT_LEGACY_STYLE_QUOTING TODO: Our intention is to flip this to false (which means to comply with RFC4180) at some point because of how it better complies with common expectancy of behavior.
static int	KB
static int	MB

Method Summary

Modifier and Type	Method and Description
int	bufferSize() Data buffer size.
boolean	emptyQuotedStringsAsNull()
default boolean	legacyStyleQuoting() Adds a default implementation returning DEFAULT_LEGACY_STYLE_QUOTING, this to not requiring any change to other classes using this interface.
boolean	multilineFields() Whether or not fields are allowed to have newline characters in them, i.e.
char	quotationCharacter() Character to regard as quotes.
boolean	trimStrings() Whether or not strings should be trimmed for whitespaces.

Field Detail

DEFAULT_LEGACY_STYLE_QUOTING

static final boolean DEFAULT_LEGACY_STYLE_QUOTING

TODO: Our intention is to flip this to false (which means to comply with RFC4180) at some point because of how it better complies with common expectancy of behavior. It may be least disruptive to do this when changing major version of the product.

See Also:

Constant Field Values

KB

static final int KB

See Also:

Constant Field Values

MB

static final int MB

See Also:

Constant Field Values

DEFAULT

static final Configuration DEFAULT

Method Detail

quotationCharacter

char quotationCharacter()

Character to regard as quotes. Quoted values can contain newline characters and even delimiters.

bufferSize

int bufferSize()

Data buffer size.

multilineFields

boolean multilineFields()

Whether or not fields are allowed to have newline characters in them, i.e. span multiple lines.

trimStrings

boolean trimStrings()

Whether or not strings should be trimmed for whitespaces.

emptyQuotedStringsAsNull

boolean emptyQuotedStringsAsNull()

Returns:

true for treating empty strings, i.e. "" as null, instead of an empty string.

legacyStyleQuoting

default boolean legacyStyleQuoting()

Adds a default implementation returning DEFAULT_LEGACY_STYLE_QUOTING, this to not requiring any change to other classes using this interface.

Returns:

whether or not the parsing will interpret \" (see quotationCharacter()) as an inner quote. Reason why this is configurable is that this interpretation conflicts with "standard" RFC for CSV parsing, see https://tools.ietf.org/html/rfc4180. This also makes it impossible to enter some combinations of characters, e.g. """abc\""", when expecting "abc\".