Module org.simpleflatmapper.lightningcsv

Package org.simpleflatmapper.lightningcsv

Class CsvParser.AbstractDSL<D extends CsvParser.AbstractDSL<D>>

java.lang.Object

org.simpleflatmapper.lightningcsv.CsvParser.AbstractDSL<D>

Direct Known Subclasses:

CsvParser.DSL, CsvParser.DSLYamlComment

Enclosing class:

CsvParser

public abstract static class CsvParser.AbstractDSL<D extends CsvParser.AbstractDSL<D>>
extends Object

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
protected static enum	CsvParser.AbstractDSL.StringPostProcessing

Field Summary

Fields

Modifier and Type	Field	Description
protected final int	bufferSize
protected final org.simpleflatmapper.util.Function<? super CellConsumer,? extends CellConsumer>	cellConsumerWrapper
protected final char	escapeChar
protected final int	limit
protected final int	maxBufferSize
protected final boolean	parallelReader
protected final char	quoteChar
protected final char	separatorChar
protected final int	skip
protected final boolean	specialisedCharConsumer
protected final CsvParser.AbstractDSL.StringPostProcessing	stringPostProcessing
protected final boolean	yamlComment

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractDSL()
protected	AbstractDSL(char separatorChar, char quoteChar, char escapeChar, int bufferSize, int skip, int limit, int maxBufferSize, CsvParser.AbstractDSL.StringPostProcessing stringPostProcessing, org.simpleflatmapper.util.Function<? super CellConsumer,? extends CellConsumer> cellConsumerWrapper, boolean yamlComment, boolean parallelReader, boolean specialisedCharConsumer)

Method Summary

Modifier and Type	Method	Description
final int	bufferSize()
D	bufferSize(int size)	set the size of the char buffer to read from.
protected CharBuffer	charBuffer(char[] content, int from, int to)
protected CharBuffer	charBuffer(Reader reader)
protected CharBuffer	charBuffer(CharSequence content)
protected CharBuffer	charBuffer(String content)
protected final AbstractCharConsumer	charConsumer(CharBuffer charBuffer)
D	disableSpecialisedCharConsumer()
D	escape(char c)	set the quote character.
final <H extends org.simpleflatmapper.util.CheckedConsumer<String[]>> H	forEach(File file, H consumer)
final <H extends org.simpleflatmapper.util.CheckedConsumer<String[]>> H	forEach(Reader reader, H consumer)
final <H extends org.simpleflatmapper.util.CheckedConsumer<String[]>> H	forEach(CharSequence content, H consumer)
final <H extends org.simpleflatmapper.util.CheckedConsumer<String[]>> H	forEach(String content, H consumer)
protected CellPreProcessor	getCellTransformer(TextFormat textFormat, CsvParser.AbstractDSL.StringPostProcessing stringPostProcessing)
protected TextFormat	getTextFormat()
protected CellPreProcessor	getUnescapeCellTransformer(TextFormat textFormat)
final org.simpleflatmapper.util.CloseableIterator<String[]>	iterator(File file)
final Iterator<String[]>	iterator(Reader reader)
final Iterator<String[]>	iterator(CharSequence content)
final Iterator<String[]>	iterator(String content)
final int	limit()
D	limit(int limit)	set the number of row to process.
final int	maxBufferSize()
D	maxBufferSize(int maxBufferSize)	set the maximum size of the content the parser will handle before failing to avoid OOM.
protected abstract D	newDSL(char separatorChar, char quoteChar, char escapeChar, int bufferSize, int skip, int limit, int maxBufferSize, CsvParser.AbstractDSL.StringPostProcessing stringPostProcessing, org.simpleflatmapper.util.Function<? super CellConsumer,? extends CellConsumer> cellConsumerWrapper, boolean yamlComment, boolean parallelReader, boolean specialisedCharConsumer)
D	parallelReader()	on parsing from a reader the Reader will be fetched from a another thread.
final <CC extends CellConsumer> CC	parse(File file, CC cellConsumer)
final <CC extends CellConsumer> CC	parse(Reader reader, CC cellConsumer)	Parse the content from the reader as a csv and call back the cellConsumer with the cell values.
final <CC extends CellConsumer> CC	parse(CharSequence content, CC cellConsumer)
final <CC extends CellConsumer> CC	parse(String content, CC cellConsumer)
final char	quote()
D	quote(char c)	set the quote character.
final CsvReader	reader(char[] chars, int from, int to)
final CloseableCsvReader	reader(File file)
final CsvReader	reader(Reader reader)	Create a CsvReader and the specified reader.
final CsvReader	reader(CharSequence content)
final CsvReader	reader(String content)
final org.simpleflatmapper.util.CloseableIterator<Row>	rowIterator(File file)
final Iterator<Row>	rowIterator(Reader reader)
final Iterator<Row>	rowIterator(CharSequence content)
final Iterator<Row>	rowIterator(String content)
final <R> R	rowStream(File file, Function<Stream<Row>,R> function)
final Stream<Row>	rowStream(Reader reader)
final Stream<Row>	rowStream(CharSequence content)
final Stream<Row>	rowStream(String content)
final char	separator()
D	separator(char c)	set the separator character.
D	serialReader()	deactivate the parallelReader.
final int	skip()
D	skip(int skip)	set the number of line to skip.
final Stream<String[]>	stream(File file)	Deprecated.
final <R> R	stream(File file, Function<Stream<String[]>,R> function)
final Stream<String[]>	stream(Reader reader)
final Stream<String[]>	stream(CharSequence content)
final Stream<String[]>	stream(String content)

Methods inherited from class java.lang.Object

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

Field Details

separatorChar

protected final char separatorChar

quoteChar

protected final char quoteChar

escapeChar

protected final char escapeChar

bufferSize

protected final int bufferSize

skip

protected final int skip

limit

protected final int limit

maxBufferSize

protected final int maxBufferSize

stringPostProcessing

protected final CsvParser.AbstractDSL.StringPostProcessing stringPostProcessing

cellConsumerWrapper

protected final org.simpleflatmapper.util.Function<? super CellConsumer,? extends CellConsumer> cellConsumerWrapper

yamlComment

protected final boolean yamlComment

parallelReader

protected final boolean parallelReader

specialisedCharConsumer

protected final boolean specialisedCharConsumer

Constructor Details

AbstractDSL

protected AbstractDSL()

AbstractDSL

protected AbstractDSL(char separatorChar,
 char quoteChar,
 char escapeChar,
 int bufferSize,
 int skip,
 int limit,
 int maxBufferSize,
 CsvParser.AbstractDSL.StringPostProcessing stringPostProcessing,
 org.simpleflatmapper.util.Function<? super CellConsumer,? extends CellConsumer> cellConsumerWrapper,
 boolean yamlComment,
 boolean parallelReader,
 boolean specialisedCharConsumer)

Method Details

parse

public final <CC extends CellConsumer> CC parse(Reader reader,
 CC cellConsumer)
                                         throws IOException

Parse the content from the reader as a csv and call back the cellConsumer with the cell values.

Type Parameters:

CC - the type of the cell consumer

Parameters:

reader - the reader

cellConsumer - the callback object for each cell value

Returns:

cellConsumer

Throws:

IOException - if and error occurs in the reader

parse

public final <CC extends CellConsumer> CC parse(String content,
 CC cellConsumer)
                                         throws IOException

Throws:

IOException

parse

public final <CC extends CellConsumer> CC parse(CharSequence content,
 CC cellConsumer)
                                         throws IOException

Throws:

IOException

parse

public final <CC extends CellConsumer> CC parse(File file,
 CC cellConsumer)
                                         throws IOException

Throws:

IOException

reader

public final CsvReader reader(Reader reader)
                       throws IOException

Create a CsvReader and the specified reader. Will skip the number of specified rows.

Parameters:

reader - the content

Returns:

a CsvReader on the reader.

Throws:

IOException - if an io error occurs

reader

public final CsvReader reader(CharSequence content)
                       throws IOException

Throws:

IOException

reader

public final CsvReader reader(String content)
                       throws IOException

Throws:

IOException

reader

public final CsvReader reader(char[] chars,
 int from,
 int to)
                       throws IOException

Throws:

IOException

charBuffer

protected CharBuffer charBuffer(Reader reader)
                         throws IOException

Throws:

IOException

charBuffer

protected CharBuffer charBuffer(CharSequence content)
                         throws IOException

Throws:

IOException

charBuffer

protected CharBuffer charBuffer(String content)
                         throws IOException

Throws:

IOException

charBuffer

protected CharBuffer charBuffer(char[] content,
 int from,
 int to)
                         throws IOException

Throws:

IOException

reader

public final CloseableCsvReader reader(File file)
                                throws IOException

Throws:

IOException

iterator

public final Iterator<String[]> iterator(Reader reader)
                                  throws IOException

Throws:

IOException

iterator

public final Iterator<String[]> iterator(CharSequence content)
                                  throws IOException

Throws:

IOException

iterator

public final Iterator<String[]> iterator(String content)
                                  throws IOException

Throws:

IOException

iterator

public final org.simpleflatmapper.util.CloseableIterator<String[]> iterator(File file)
                                                                     throws IOException

Throws:

IOException

rowIterator

public final Iterator<Row> rowIterator(Reader reader)
                                throws IOException

Throws:

IOException

rowIterator

public final Iterator<Row> rowIterator(CharSequence content)
                                throws IOException

Throws:

IOException

rowIterator

public final Iterator<Row> rowIterator(String content)
                                throws IOException

Throws:

IOException

rowIterator

public final org.simpleflatmapper.util.CloseableIterator<Row> rowIterator(File file)
                                                                   throws IOException

Throws:

IOException

forEach

public final <H extends org.simpleflatmapper.util.CheckedConsumer<String[]>>
H forEach(Reader reader,
 H consumer)
   throws IOException

Throws:

IOException

forEach

public final <H extends org.simpleflatmapper.util.CheckedConsumer<String[]>>
H forEach(CharSequence content,
 H consumer)
   throws IOException

Throws:

IOException

forEach

public final <H extends org.simpleflatmapper.util.CheckedConsumer<String[]>>
H forEach(String content,
 H consumer)
   throws IOException

Throws:

IOException

forEach

public final <H extends org.simpleflatmapper.util.CheckedConsumer<String[]>>
H forEach(File file,
 H consumer)
   throws IOException

Throws:

IOException

stream

public final Stream<String[]> stream(Reader reader)
                              throws IOException

Throws:

IOException

stream

public final Stream<String[]> stream(CharSequence content)
                              throws IOException

Throws:

IOException

stream

public final Stream<String[]> stream(String content)
                              throws IOException

Throws:

IOException

rowStream

public final Stream<Row> rowStream(Reader reader)
                            throws IOException

Throws:

IOException

rowStream

public final Stream<Row> rowStream(CharSequence content)
                            throws IOException

Throws:

IOException

rowStream

public final Stream<Row> rowStream(String content)
                            throws IOException

Throws:

IOException

stream

@Deprecated
public final Stream<String[]> stream(File file)
                              throws IOException

Deprecated.

Use @see AbstractDSL#stream(File, Function).

Parameters:

file - the file

Returns:

a stream of String[]

Throws:

IOException

stream

public final <R> R stream(File file,
 Function<Stream<String[]>,R> function)
                   throws IOException

Throws:

IOException

rowStream

public final <R> R rowStream(File file,
 Function<Stream<Row>,R> function)
                      throws IOException

Throws:

IOException

charConsumer

protected final AbstractCharConsumer charConsumer(CharBuffer charBuffer)

getTextFormat

protected TextFormat getTextFormat()

getCellTransformer

protected CellPreProcessor getCellTransformer(TextFormat textFormat,
 CsvParser.AbstractDSL.StringPostProcessing stringPostProcessing)

getUnescapeCellTransformer

protected CellPreProcessor getUnescapeCellTransformer(TextFormat textFormat)

maxBufferSize

public final int maxBufferSize()

bufferSize

public final int bufferSize()

limit

public final int limit()

skip

public final int skip()

separator

public final char separator()

quote

public final char quote()

separator

public D separator(char c)

set the separator character. the default value is ','.

Parameters:

c - the new separator character

Returns:

this

quote

public D quote(char c)

set the quote character. the default value is '"'.

Parameters:

c - the quote character

Returns:

this

escape

public D escape(char c)

set the quote character. the default value is '"'.

Parameters:

c - the quote character

Returns:

this

bufferSize

public D bufferSize(int size)

set the size of the char buffer to read from.

Parameters:

size - the size in bytes

Returns:

this

skip

public D skip(int skip)

set the number of line to skip.

Parameters:

skip - number of line to skip.

Returns:

this

limit

public D limit(int limit)

set the number of row to process. limit does not affect stream or iterator.

Parameters:

limit - number of row to process

Returns:

this

parallelReader

public D parallelReader()

on parsing from a reader the Reader will be fetched from a another thread. Use only if you have spare cores and the file is big enough.

On java 8 and over it will use the ForkJoinPool by default if the number of core is greater than 1, otherwise it will create a new Thread every time.

On java 6 and 7 it will create a shared ExecutorService with the number of threads set to the number of cores if it is greater than 1, otherwise it will create a new Thread every time.

If you wish to customize the org.simpleflatmapper.util.ParallelReader further for example to specify which Executor to user or the size of the ring buffer or read buffer you will need to wrap the Reader manually.

Returns:

this

serialReader

public D serialReader()

deactivate the parallelReader.

Returns:

this

disableSpecialisedCharConsumer

public D disableSpecialisedCharConsumer()

maxBufferSize

public D maxBufferSize(int maxBufferSize)

set the maximum size of the content the parser will handle before failing to avoid OOM.

Parameters:

maxBufferSize - the maximum size the buffer will grow, default 8M

Returns:

this

newDSL

protected abstract D newDSL(char separatorChar,
 char quoteChar,
 char escapeChar,
 int bufferSize,
 int skip,
 int limit,
 int maxBufferSize,
 CsvParser.AbstractDSL.StringPostProcessing stringPostProcessing,
 org.simpleflatmapper.util.Function<? super CellConsumer,? extends CellConsumer> cellConsumerWrapper,
 boolean yamlComment,
 boolean parallelReader,
 boolean specialisedCharConsumer)