one.microstream.util.xcsv

Class XCSV

java.lang.Object

one.microstream.util.xcsv.XCSV

public final class XCSV
extends Object

An extended CSV format ("XCSV") with the following traits:

• Allows an arbitrary separator value (interpreting "CSV" as "character separated values" instead of "comma separated values"), with a TAB ascii character as the default separator since that character has been designed exactely for that purpose and is superior to any other character for that task.
• Optionally contains a header line defining all control characters
• Contains an optional second header line defining/hinting the data type of the column
• Allows single line and multi line comments
• Allows multiple tables of different structure ("segments") in one file

In short: this is the ultimate textual data format for tabular data regarding efficiency and readability.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XCSV.ValueSeparatorWeight

Method Summary

Modifier and Type	Method and Description
static XCsvAssembler.Builder<VarString>	AssemblerBuilder()
static <T> void	assembleRow(XCsvAssembler assembler, XCsvRowAssembler<T> rowAssembler, XIterable<? extends T> row)
static <T> void	assembleRows(XCsvAssembler assembler, XCsvRowAssembler<T> rowAssembler, XIterable<? extends T> rows)
static String	assembleString(StringTable stringTable)
static String	assembleString(StringTable stringTable, XCsvConfiguration configuration)
static VarString	assembleString(VarString vs, StringTable st)
static VarString	assembleString(VarString vs, StringTable st, XCsvConfiguration csvConfiguration)
static int	calculateEstimatedCharCount(long rowCount)
static XCsvConfiguration.Builder	ConfigurationBuilder()
static XCsvConfiguration	configurationDefault()
static int	estimatedCharCountPerRow()
static char[]	getValidValueSeparators()
static boolean	isValidValueSeparator(char c)
static StringTable	parse(_charArrayRange rawData)
static StringTable	parse(_charArrayRange rawData, char valueSeparator)
static StringTable	parse(_charArrayRange rawData, XCsvConfiguration csvConfiguration)
static StringTable	parse(_charArrayRange rawData, XCsvConfiguration csvConfiguration, XCsvDataType dataType)
static StringTable	parse(_charArrayRange rawData, XCsvDataType dataType)
static StringTable	parse(String rawData)
static StringTable	parse(String rawData, char valueSeparator)
static StringTable	parse(String rawData, XCsvConfiguration configuration)
static StringTable	parse(String rawData, XCsvConfiguration configuration, XCsvDataType dataType)
static StringTable	parse(String rawData, XCsvDataType dataType)
static StringTable	readFromFile(Path file)
static StringTable	readFromFile(Path file, char valueSeparator)
static StringTable	readFromFile(Path file, XCsvConfiguration xcsvConfiguration)
static StringTable	readFromFile(Path file, XCsvDataType dataType)
static char	validateValueSeparator(char c)
static XCSV.ValueSeparatorWeight	ValueSeparatorWeight(char valueSeparator, double weight)

Methods inherited from class java.lang.Object

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

Method Detail

ValueSeparatorWeight

public static XCSV.ValueSeparatorWeight ValueSeparatorWeight(char valueSeparator,
                                                             double weight)

getValidValueSeparators

public static final char[] getValidValueSeparators()

configurationDefault

public static final XCsvConfiguration configurationDefault()

ConfigurationBuilder

public static final XCsvConfiguration.Builder ConfigurationBuilder()

AssemblerBuilder

public static final XCsvAssembler.Builder<VarString> AssemblerBuilder()

isValidValueSeparator

public static boolean isValidValueSeparator(char c)

validateValueSeparator

public static char validateValueSeparator(char c)

assembleRow

public static final <T> void assembleRow(XCsvAssembler assembler,
                                         XCsvRowAssembler<T> rowAssembler,
                                         XIterable<? extends T> row)

assembleRows

public static final <T> void assembleRows(XCsvAssembler assembler,
                                          XCsvRowAssembler<T> rowAssembler,
                                          XIterable<? extends T> rows)

parse

public static StringTable parse(String rawData)

parse

public static StringTable parse(String rawData,
                                char valueSeparator)

parse

public static StringTable parse(String rawData,
                                XCsvDataType dataType)

parse

public static StringTable parse(String rawData,
                                XCsvConfiguration configuration)

parse

public static StringTable parse(String rawData,
                                XCsvConfiguration configuration,
                                XCsvDataType dataType)

assembleString

public static String assembleString(StringTable stringTable)

assembleString

public static String assembleString(StringTable stringTable,
                                    XCsvConfiguration configuration)

parse

public static StringTable parse(_charArrayRange rawData)

parse

public static StringTable parse(_charArrayRange rawData,
                                XCsvDataType dataType)

parse

public static StringTable parse(_charArrayRange rawData,
                                char valueSeparator)

parse

public static StringTable parse(_charArrayRange rawData,
                                XCsvConfiguration csvConfiguration)

parse

public static StringTable parse(_charArrayRange rawData,
                                XCsvConfiguration csvConfiguration,
                                XCsvDataType dataType)

estimatedCharCountPerRow

public static final int estimatedCharCountPerRow()

calculateEstimatedCharCount

public static final int calculateEstimatedCharCount(long rowCount)

assembleString

public static final VarString assembleString(VarString vs,
                                             StringTable st)

assembleString

public static final VarString assembleString(VarString vs,
                                             StringTable st,
                                             XCsvConfiguration csvConfiguration)

readFromFile

public static StringTable readFromFile(Path file)

readFromFile

public static StringTable readFromFile(Path file,
                                       XCsvDataType dataType)

readFromFile

public static StringTable readFromFile(Path file,
                                       char valueSeparator)

readFromFile

public static StringTable readFromFile(Path file,
                                       XCsvConfiguration xcsvConfiguration)