org.thales.punch.libraries.punchlang.resource.decoders

Class CsvToTuple

java.lang.Object

org.thales.punch.libraries.punchlang.resource.decoders.CsvToTuple

All Implemented Interfaces:

IResourceBuilder

public class CsvToTuple
extends Object
implements IResourceBuilder

This decoder converts a JSON String to a Tuple. Additional settings can be provided :

• hash_key : The name of the column to be used as hash key for each item. Results will be a key value map. Use null if you simply need an array with all elements. Default null.
• separator : The field separator. Default ",".
• infer_type : If true, types will be cast automatically to the correct types. If false, strings literal are returned. Default false.
• lower_case_keys : If true, column names will be cast to lower case string. If false, column keep their format. Default false.
• has_header : If true, first line is used to provide column names and not processed. If false, columns are named following the pattern "field0", "field1", "field2"... Default false.
• columns : Columns names as list of string. If empty, columns are named following the pattern "field0", "field1", "field2"... If "has_header" is set to true, this setting is ignored and the header option is taken for column names. Default empty.

Nested Class Summary

Nested classes/interfaces inherited from interface org.thales.punch.libraries.punchlang.api.IResourceBuilder

IResourceBuilder.CompactionType

Constructor Summary

Constructors

Constructor and Description
CsvToTuple()

Method Summary

Modifier and Type	Method and Description
Tuple	onEnd() Callback that tells you the scan is done.
void	onStart() Callback to tell you you are about to receive new lines.
void	onStream(Reader reader) Callback for you to stream the remote resource file.
void	prepare(org.thales.punch.settings.api.ISettingsMap settings) An optional callback to prepare you builder with additional parameters.

Methods inherited from class java.lang.Object

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

Constructor Detail

CsvToTuple

public CsvToTuple()

Method Detail

prepare

public void prepare(org.thales.punch.settings.api.ISettingsMap settings)

Description copied from interface: IResourceBuilder

An optional callback to prepare you builder with additional parameters.

Specified by:

prepare in interface IResourceBuilder

onStart

public void onStart()

Description copied from interface: IResourceBuilder

Callback to tell you you are about to receive new lines.

Specified by:

onStart in interface IResourceBuilder

onStream

public void onStream(Reader reader)
              throws IOException

Description copied from interface: IResourceBuilder

Callback for you to stream the remote resource file.

Specified by:

onStream in interface IResourceBuilder

Parameters:

reader - the input stream to consume the resource file

Throws:

IOException - in case of IO error

onEnd

public Tuple onEnd()

Description copied from interface: IResourceBuilder

Callback that tells you the scan is done. You can safely terminate and return the building of your resource.

You should typically free any temporary storage, if any, used to build your resource.

Specified by:

onEnd in interface IResourceBuilder

Returns:

the built resource.