org.apache.flink.api.java.record.io

Class CsvOutputFormat.AbstractConfigBuilder<T>

java.lang.Object

org.apache.flink.api.common.io.FileOutputFormat.AbstractConfigBuilder<T>

org.apache.flink.api.java.record.io.CsvOutputFormat.AbstractConfigBuilder<T>

Direct Known Subclasses:

CsvOutputFormat.ConfigBuilder

Enclosing class:

CsvOutputFormat

protected abstract static class CsvOutputFormat.AbstractConfigBuilder<T>
extends FileOutputFormat.AbstractConfigBuilder<T>

Abstract builder used to set parameters to the input format's configuration in a fluent way.

Field Summary

Fields inherited from class org.apache.flink.api.common.io.FileOutputFormat.AbstractConfigBuilder

config

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	CsvOutputFormat.AbstractConfigBuilder(Configuration config) Creates a new builder for the given configuration.

Method Summary

Methods

Modifier and Type	Method and Description
T	field(Class<? extends Value> type, int recordPosition) Adds a field of the record to be serialized to the output.
T	fieldDelimiter(char delimiter) Sets the delimiter that delimits the individual fields in the records textual output representation.
T	lenient(boolean lenient) Sets the leniency for the serializer.
T	recordDelimiter(char delimiter) Sets the delimiter to be a single character, namely the given one.
T	recordDelimiter(String delimiter) Sets the delimiter to be the given string.
T	recordDelimiter(String delimiter, String charsetName) Sets the delimiter to be the given string.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvOutputFormat.AbstractConfigBuilder

protected CsvOutputFormat.AbstractConfigBuilder(Configuration config)

Creates a new builder for the given configuration.

Parameters:

config - The configuration into which the parameters will be written.

Method Detail

recordDelimiter

public T recordDelimiter(char delimiter)

Sets the delimiter to be a single character, namely the given one. The character must be within the value range 0 to 127.

Parameters:

delimiter - The delimiter character.

Returns:

The builder itself.

recordDelimiter

public T recordDelimiter(String delimiter)

Sets the delimiter to be the given string. The string will be converted to bytes for more efficient comparison during input parsing. The conversion will be done using the platforms default charset.

Parameters:

delimiter - The delimiter string.

Returns:

The builder itself.

recordDelimiter

public T recordDelimiter(String delimiter,
                String charsetName)

Sets the delimiter to be the given string. The string will be converted to bytes for more efficient comparison during input parsing. The conversion will be done using the charset with the given name. The charset must be available on the processing nodes, otherwise an exception will be raised at runtime.

Parameters:

delimiter - The delimiter string.

charsetName - The name of the encoding character set.

Returns:

The builder itself.

fieldDelimiter

public T fieldDelimiter(char delimiter)

Sets the delimiter that delimits the individual fields in the records textual output representation.

Parameters:

delimiter - The character to be used as a field delimiter.

Returns:

The builder itself.

field

public T field(Class<? extends Value> type,
      int recordPosition)

Adds a field of the record to be serialized to the output. The field at the given position will be interpreted as the type represented by the given class. The types Object.toString() method will be invoked to create a textual representation.

Parameters:

type - The type of the field.

recordPosition - The position in the record.

Returns:

The builder itself.

lenient

public T lenient(boolean lenient)

Sets the leniency for the serializer. A lenient serializer simply skips missing fields and null fields in the record, while a non lenient one throws an exception.

Parameters:

lenient - True, if the serializer should be lenient, false otherwise.

Returns:

The builder itself.