org.thales.punch.libraries.punchlang.operator

Class ToKvOperator

java.lang.Object

org.thales.punch.libraries.punchlang.operator.ToKvOperator

public class ToKvOperator
extends Object

The ToKvOperator operator transforms a Json document into a flattened String made of key/value pairs. Say you have a Json document as follows:

 { "top" : { "a"=1, "b"="hello world"}, "c"=[1,2,3] }
 

stored in some Tuple, say the Tuple input. If you run :

 
        String result = toKv().on(input);
 
 

it produces a single String containing:

 
        top.a="1" top.b="hello world" c="[1,2,3]"
 

Constructor Summary

Constructors

Constructor and Description
ToKvOperator() Create a flatten operator.

Method Summary

Modifier and Type	Method and Description
ToKvOperator	fieldSplit(String delimiter) Reset the String used to delimit key-value pairs.
ToKvOperator	nestedSeparator(String separator) Set the string to be used to separate nested properties.
String	on(Tuple input) Make the operator work on an input Tuple.
ToKvOperator	valueSplit(String delimiter) Reset the String used to delimit keys from values.

Methods inherited from class java.lang.Object

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

Constructor Detail

ToKvOperator

public ToKvOperator()

Create a flatten operator.

Method Detail

on

public String 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

valueSplit

public ToKvOperator valueSplit(String delimiter)

Reset the String used to delimit keys from values.

Parameters:

delimiter - the new delimiter, it must be a valid regex.

Returns:

this operator

fieldSplit

public ToKvOperator fieldSplit(String delimiter)

Reset the String used to delimit key-value pairs.

Parameters:

delimiter - the new delimiter, it must be a valid regex.

Returns:

this operator

nestedSeparator

public ToKvOperator nestedSeparator(String separator)

Set the string to be used to separate nested properties. By default a "." is used.

Parameters:

separator - the separator you want.

Returns:

this operator