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

java.lang.Object
- org.thales.punch.libraries.punchlang.api.TupleFactory

public final class TupleFactory
extends Object

Use this class to create and convert punch tuples.

Create a tuple From String


     String input = "{ \"name\" : \"bob\" }";
     Object parser = TupleFactory.getJsonParser();
     Tuple tuple = TupleFactory.getTupleFromJson(input, parser);

Create an empty tuple


     Tuple tuple = TupleFactory.getNewTuple(fromJson);

Set some leaf or inner value


     // Assign a leaf value, i,e, the tuple contains a Json element
     tuple.set("aValue");

     // Assign an inner property value
     tuple.get("user").get("name").set("bob");

     // Assign array elements
     tuple.append(1).append(2).append(3);

     // Assign Set elements
     tuple.add(1).add(2).add(3);

Get a json from tuple


     String toJson = TupleFactory.getJsonFromTuple(tuple);

Author:: dimi

Method Summary

All Methods Static Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`static org.apache.avro.generic.GenericRecord`	`getAvroRecord(org.apache.avro.Schema schema, Tuple tuple)` Tuple to avro conversion method
`static String`	`getJsonFromTuple(Tuple tuple)` Get a valid Json representation from a tuple.
`static String`	`getJsonFromTuple(Tuple tuple, Object mapper)` Get a valid Json representation from a tuple.
`static Object`	`getJsonObjectMapper()` Get a json object mapper.
`static Object`	`getJsonParser()` Get a json parser.
`static Tuple`	`getLeafTuple(Object o)` Return a new leaf tuple.
`static Tuple`	`getNewTuple()` Use this method to create a new empty tuples.
`static Tuple`	`getNewTuple(Object value)` Use this method to create a non empty root tuple.
`static Object`	`getObjectMapper(boolean legacy)` Deprecated. use getJsonObjectMapper(). Will be removed later. Only keep for compatibility with existing parsers
`static Tuple`	`getTupleFromCsv(String content, String hashKey, String delimiter, boolean inferTypes, boolean hasHeader, boolean lowerCaseKeys)` Build a punch tuple from a CSV file content.
`static Tuple`	`getTupleFromCsv(String s, String hashKey, String delimiter, List<String> columnNames, boolean inferTypes, boolean lowerCaseKeys)` Build a punch tuple from a CSV file content.
`static Tuple`	`getTupleFromJson(Object mapper, String fromJson)` Deprecated. use getTupleFromJson(String fromJson, Object mapper). Will be removed later. Only keep for compatibility with existing parsers
`static Tuple`	`getTupleFromJson(String s)` Retrieve a tuple from a valid Json String.
`static Tuple`	`getTupleFromJson(String s, Object jsonMapper)`
`static Tuple`	`getTupleFromList(List<Object> input)`
`static Tuple`	`getTupleFromMap(Map map)` Get a tuple from a map.
`static Object`	`toPunchLeafValue(Object v)` The punch tuple type can be filled with various values.

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

- Method Detail
  - getLeafTuple
```
public static Tuple getLeafTuple(Object o)
```
    Return a new leaf tuple. I.e.
    
    Parameters:
    
    o -
    
    Returns:
    
    the leaf tuple
  - getTupleFromJson
```
public static Tuple getTupleFromJson(String s)
```
    Retrieve a tuple from a valid Json String. Prefer the method with a mapper to avoid recreating a mapper at each call.
    In addition using a mapper you can control ascii escaping.
    
    Parameters:
    
    s - the input string
    
    Returns:
    
    a punch tuple
    
    Throws:
    
    PunchRuntimeException
  - getTupleFromJson
```
public static Tuple getTupleFromJson(String s,
                                     Object jsonMapper)
```
    Parameters:
    
    s -
    
    jsonMapper - the json mapper you got previously using getJsonMapper();
    
    Returns:
  - getTupleFromMap
```
public static Tuple getTupleFromMap(Map map)
```
    Get a tuple from a map.
    
    Parameters:
    
    map - the input map
    
    Returns:
    
    a tuple
  - getJsonFromTuple
```
public static String getJsonFromTuple(Tuple tuple)
```
    Get a valid Json representation from a tuple. If the tuple is completely empty, an empty String is returned.
    
    Parameters:
    
    tuple - the target tuple
    
    Returns:
    
    a valid Json representation
  - getJsonFromTuple
```
public static String getJsonFromTuple(Tuple tuple,
                                      Object mapper)
```
    Get a valid Json representation from a tuple. If the tuple is completely empty, an empty String is returned.
    
    Parameters:
    
    tuple - the target tuple
    
    Returns:
    
    a valid Json representation
  - getTupleFromList
```
public static Tuple getTupleFromList(List<Object> input)
```
    Parameters:
    
    input - a list of json compatible objects
    
    Returns:
    
    a tuple
  - getNewTuple
```
public static Tuple getNewTuple()
```
    Use this method to create a new empty tuples. An empty tuple will return false to method Tuple.exists() and true to Tuple.isEmpty().
    An empty tuple is also a root tuple. I.e. it returns true to Tuple.isRoot().
    
    Returns:
    
    a new empty tuple
  - getNewTuple
```
public static Tuple getNewTuple(Object value)
```
    Use this method to create a non empty root tuple. I.e. it returns true to Tuple.isRoot().
    
    Parameters:
    
    value - the value to assign
    
    Returns:
    
    the new tuple
  - getAvroRecord
```
public static org.apache.avro.generic.GenericRecord getAvroRecord(org.apache.avro.Schema schema,
                                                                  Tuple tuple)
```
    Tuple to avro conversion method
    
    Parameters:
    
    schema - the avro schema
    
    tuple - the input tuple
    
    Returns:
    
    a corresponding avro generic record.
  - getTupleFromCsv
```
public static Tuple getTupleFromCsv(String s,
                                    String hashKey,
                                    String delimiter,
                                    List<String> columnNames,
                                    boolean inferTypes,
                                    boolean lowerCaseKeys)
```
    Build a punch tuple from a CSV file content. This variant requires you to provide the column names.
    
    Parameters:
    
    s - the input CSV string. This is supposed to be one or several lines separated by the carriage return character.
    
    hashKey - the name of the item to be used as hash key. Use null if you simply need an array with all elements.
    
    delimiter - the delimiter to be used
    
    columnNames - the column names
    
    inferTypes - true to infer the types.
    
    lowerCaseKeys - true to make all keys lower cases.
    
    Returns:
    
    the resulting tuple. It is a map tuple the hashKey is considered unique.
  - getTupleFromCsv
```
public static Tuple getTupleFromCsv(String content,
                                    String hashKey,
                                    String delimiter,
                                    boolean inferTypes,
                                    boolean hasHeader,
                                    boolean lowerCaseKeys)
```
    Build a punch tuple from a CSV file content. This variant extracts the column names from the first line.
    
    Parameters:
    
    content - the input CSV string. This is supposed to be one or several lines separated by the carriage return character.
    
    hashKey - the name of the item to be used as hash key. Use null if you simply need an array with all elements.
    
    delimiter - the delimiter to be used
    
    inferTypes - true to infer the inner types, this takes twice as CPU
    
    hasHeader - true if the content includes a first header line with column names
    
    lowerCaseKeys - true to make all keys lower cases.
    
    Returns:
    
    the resulting tuple. It is a map tuple the hashKey is considered unique.
  - toPunchLeafValue
```
public static Object toPunchLeafValue(Object v)
```
    The punch tuple type can be filled with various values. You can fill in jackson node types (BaseJsonNode, ObjectNode, etc..) or regular java types. This method convert these into the standard json compatible primitive types used in the punch language.
    Typically ints or shorts become long. etc..
    If you pass in a composit type, it will be returned as is.
    
    Parameters:
    
    v - an object
    
    Returns:
    
    the corresponding json primitive type object
  - getJsonParser
```
public static Object getJsonParser()
```
    Get a json parser. Use it whenever you are in a single thread pattern. so as to avoid recreating it at each call.
    This is only required if you extensively use the getTupleFromJson(java.lang.String) method.
    
    Returns:
    
    a new json object mapper.
  - getJsonObjectMapper
```
public static Object getJsonObjectMapper()
```
    Get a json object mapper. Use it whenever you are in a single thread pattern. so as to avoid recreating it at each call.
    This is only required if you extensively use the getJsonFromTuple(Tuple, Object) method.
    
    Returns:
    
    a new json object mapper.
  - getObjectMapper
```
public static Object getObjectMapper(boolean legacy)
```
    Deprecated. use getJsonObjectMapper(). Will be removed later. Only keep for compatibility with existing parsers
    
    Parameters:
    
    legacy - no used. only for compatibility
    
    Returns:
  - getTupleFromJson
```
public static Tuple getTupleFromJson(Object mapper,
                                     String fromJson)
```
    Deprecated. use getTupleFromJson(String fromJson, Object mapper). Will be removed later. Only keep for compatibility with existing parsers
    
    Parameters:
    
    mapper -
    
    fromJson -
    
    Returns:

Class TupleFactory

Create a tuple From String

Create an empty tuple

Set some leaf or inner value

Get a json from tuple

Method Summary

Methods inherited from class java.lang.Object

Method Detail

getLeafTuple

getTupleFromJson

getTupleFromJson

getTupleFromMap

getJsonFromTuple

getJsonFromTuple

getTupleFromList

getNewTuple

getNewTuple

getAvroRecord

getTupleFromCsv

getTupleFromCsv

toPunchLeafValue

getJsonParser

getJsonObjectMapper

getObjectMapper

getTupleFromJson