CsvOperator (Punch Punch Language Runtime Library 6.4.5-SNAPSHOT API)

java.lang.Object
- org.thales.punch.libraries.punchlang.operator.CsvOperator

```
public class CsvOperator
extends Object
```
The csv operator transform sequence of values separated by some delimiter into a key value map. Say you have "1;2;3", executing
```
 
        csv("one", "two", "three").on("1;2;3").into([result]);
 
 
```
produces
```
 
        result = {"one" : "1", "two" : "2", "three" : "3"}
 
```
If you provide no or not enough field names, field names will be automatically added. I.e
```
  csv("a", "b").on("abc;def;hij").into([result]);
 
```
produces
```
  result = {"a" : "abc", "b" : "def", "field2" : "hij"}
 
```
You can provide the separator as a char, it will be escaped before being used as regex pattern for the split. Use it if your separator is a regexp special character.

Constructor Summary

Constructors
Constructor and Description
`CsvOperator(List<String> fieldNames)` Create a csv operator with a list of field names.
`CsvOperator(String... fieldNames)` Create a csv operator with a list of field names.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`CsvOperator`	`debug()` Turn debugging to true.
`CsvOperator`	`delim(char delimiter)` Set the separator.
`CsvOperator`	`delim(String delimiter)` Set the default separator.
`CsvOperator`	`delim(String delimiter, boolean isRegexDelimiter)` Set the default separator and the separator type (regex or string).
`CsvOperator`	`escapeCharacter(char escapeCharacter)` Allows to escape quote delimiters.
`CsvOperator`	`escapeCharacter(String escapeCharacter)` Allows to escape quote delimiters.
`CsvOperator`	`escapeDelimiters(String quoteDelimiters)` Alias for quoteDelimiters.
`CsvOperator`	`inferTypes()` Make the csv operator generate typed results.
`boolean`	`into(Tuple tuple)` Fire the operator and put the result inside a destination tuple
`CsvOperator`	`keepEmpty()` Use this method to make the CSV operator keep empty values, if any, in your
`CsvOperator`	`on(String input)` Make the operator work on an input String
`CsvOperator`	`on(Tuple input)` Make the operator work on an input Tuple.
`CsvOperator`	`quoteDelimiters(String quoteDelimiters)` Allows to specify quote delimiters.
`CsvOperator`	`separator(char delimiter)` Set the separator.
`CsvOperator`	`separator(String delimiter)` Set the default separator.
`CsvOperator`	`trim()` Trim the values, removing any leading or ending white spaces.
`CsvOperator`	`trimQuotes(boolean b)` If true (the default) make the Csv operator remove leading or trailing quotes or single quotes.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - CsvOperator
```
public CsvOperator(String... fieldNames)
```
    Create a csv operator with a list of field names. The csv operator will use them in order. If you give too many fields name, some will not be used. If you give not enough of them, the missing names will be automatically generated.
    
    Parameters:
    
    fieldNames - an ordered array of field names.
  - CsvOperator
```
public CsvOperator(List<String> fieldNames)
```
    Create a csv operator with a list of field names. This variant accepts a list instead of an array.
    
    Parameters:
    
    fieldNames - an ordered list of field names.
- Method Detail
  - escapeDelimiters
```
public CsvOperator escapeDelimiters(String quoteDelimiters)
```
    Alias for quoteDelimiters. Deprecated, use quoteDelimiters() instead.
    
    Parameters:
    
    quoteDelimiters - the quoting delimiters
    
    Returns:
    
    this CsvOperator
  - quoteDelimiters
```
public CsvOperator quoteDelimiters(String quoteDelimiters)
```
    Allows to specify quote delimiters. Any delimiter field separator present in a quote is ignored and a new field is not created. By default quoting is performed between double-quotes. If you want it to be also applied between simple-quotes use csv().withQuoteCharacters("\"'"). To disable quoting altogether, use csv().escapeDelimiters("").
    
    Parameters:
    
    quoteDelimiters - the quoting delimiters
    
    Returns:
    
    this CsvOperator
  - escapeCharacter
```
public CsvOperator escapeCharacter(char escapeCharacter)
```
    Allows to escape quote delimiters. If a quote delimiter is preceded by this escapeCharacter, no quote is created or closed.
    
    Parameters:
    
    escapeCharacter - Character to use.
    
    Returns:
    
    this CsvOperator
  - escapeCharacter
```
public CsvOperator escapeCharacter(String escapeCharacter)
```
    Allows to escape quote delimiters. If a quote delimiter is preceded by this escapeCharacter, no quote is created or closed.
    
    Parameters:
    
    escapeCharacter - Character to use. First character only is taken.
    
    Returns:
    
    this CsvOperator
  - inferTypes
```
public CsvOperator inferTypes()
```
    Make the csv operator generate typed results. Instead of String values, you will have longs, double, boolean, or Strings.
    
    Returns:
    
    this operator
  - trimQuotes
```
public CsvOperator trimQuotes(boolean b)
```
    If true (the default) make the Csv operator remove leading or trailing quotes or single quotes.
    
    Parameters:
    
    b - the boolean value you need
    
    Returns:
    
    this operator
  - keepEmpty
```
public CsvOperator keepEmpty()
```
    Use this method to make the CSV operator keep empty values, if any, in your
    
    Returns:
    
    this operator
  - trim
```
public CsvOperator trim()
```
    Trim the values, removing any leading or ending white spaces.
    
    Returns:
    
    this operator
  - debug
```
public CsvOperator debug()
```
    Turn debugging to true. This prints to standard output some useful information about the way the input String is truncated and split by the CSV operator. Do not use in production.
    
    Returns:
    
    this operator
  - delim
```
public CsvOperator delim(String delimiter)
```
    Set the default separator. This method expects a regex.
    
    Parameters:
    
    delimiter - the new delimiter
    
    Returns:
    
    this operator
  - delim
```
public CsvOperator delim(String delimiter,
                         boolean isRegexDelimiter)
```
    Set the default separator and the separator type (regex or string).
    
    Parameters:
    
    delimiter - the new delimiter
    
    isRegexDelimiter - true if delimiter must be interpreted as regex otherwise string. Default is true.
    
    Returns:
    
    this operator
  - separator
```
public CsvOperator separator(String delimiter)
```
    Set the default separator. This method expects a regex. This method was added for easier compatibility with logstash syntax.
    
    Parameters:
    
    delimiter - the new delimiter
    
    Returns:
    
    this operator
  - delim
```
public CsvOperator delim(char delimiter)
```
    Set the separator. This method automatically escapes the separator.
    
    Parameters:
    
    delimiter - the new delimiter
    
    Returns:
    
    this operator
  - separator
```
public CsvOperator separator(char delimiter)
```
    Set the separator. This method automatically escapes the separator.
    
    Parameters:
    
    delimiter - the new delimiter
    
    Returns:
    
    this operator
  - on
```
public CsvOperator on(String input)
```
    Make the operator work on an input String
    
    Parameters:
    
    input - the input String
    
    Returns:
    
    this operator
  - on
```
public CsvOperator on(Tuple input)
```
    Make the operator work on an input Tuple. The Tuple must contain a String leaf value.
    
    Parameters:
    
    input - the input Tuple
    
    Returns:
    
    this operator
  - into
```
public boolean into(Tuple tuple)
```
    Fire the operator and put the result inside a destination tuple
    
    Parameters:
    
    tuple - the destination tuple
    
    Returns:
    
    true if some key-value was extracted.

Class CsvOperator

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

CsvOperator

CsvOperator

Method Detail

escapeDelimiters

quoteDelimiters

escapeCharacter

escapeCharacter

inferTypes

trimQuotes

keepEmpty

trim

debug

delim

delim

separator

delim

separator

on

on

into