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

java.lang.Object
- org.thales.punch.libraries.punchlang.impl.AbstractTupleImpl
- - org.thales.punch.libraries.punchlang.impl.TupleImpl

All Implemented Interfaces:

Comparable<Tuple>, Tuple

Direct Known Subclasses:

ByteBufTuple, DnsTuple, GeoFeatureTuple, LazyInPlaceTuple, LazyTuple, LoggerTuple, PlainTuple, StormTuple
```
public class TupleImpl
extends AbstractTupleImpl
```
We group here a number of basic tuple operations.

Author:

dimi

Field Summary

Fields
Modifier and Type Field and Description

static Object nullValue
the null value is used to hold empty values.
- Fields inherited from class org.thales.punch.libraries.punchlang.impl.AbstractTupleImpl
  ancestor, content

Fields
Modifier and Type	Field and Description
`static Object`	`nullValue` the null value is used to hold empty values.

Constructor Summary

Constructors
Constructor and Description

TupleImpl(Object o, Ancestor ancestor)
Return an intermediary or leaf tuple.

Constructors
Constructor and Description
`TupleImpl(Object o, Ancestor ancestor)` Return an intermediary or leaf tuple.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`TupleImpl`	`add(Object value)` Add a tuple element into a set.
`TupleImpl`	`append(Object value)` Add a abject element at the end of an array.
`List<Tuple>`	`asArray()` Returns an ordered list of elements if the tuple is an array or a set.
`GeoFeatureTuple`	`asGeoShape()` Convert the Tuple in GeoFeatureTuple if the Tuple have the attributs : type and coordinates in content
`Set<Tuple>`	`asSet()` Returns a set of elements.
`int`	`compareTo(Tuple o)`
`int`	`compareTo(TupleImpl o)`
`boolean`	`contains(Object element)` This method behaves differently depending on the tuple type.
`String`	`decodeBase64()` Decode a string Tuple already in base64
`static Object`	`dtoPunchLeafValue(Object v)` When inserting leaf values into sets or arrays, we transform various types into the expected core punch types.
`String`	`dump()` Return a String representation of this tuple.
`Tuple`	`duplicate()` Clone a tuple.
`Tuple[]`	`elements()` Returns an array of elements.
`void`	`empty()` Make a tuple empty.
`String`	`encodeBase64()` Encode a string Tuple into a base64 String
`boolean`	`equals(Object obj)` Two tuples are equals if they are the same object or if they have the same leaf value.
`boolean`	`equalsOneOf(Tuple resource)` Check if this tuple contains a sub-string.
`boolean`	`exists()`
`Tuple`	`fromEscapedJson()` This method assumes your tuple holds a string leaf value.
`Tuple`	`get(String key)` Retrieve a child.
`Tuple`	`getByKey(String key)` Return a sub-tuple by key.
`Tuple`	`getElement()` This method returns a new empty array element.
`Tuple`	`getElement(int index)` Retrieve the ith item from this tuple.
`List<Entry>`	`getEntries()` Returns the list of inner property key/values.
`Iterator<Object>`	`getIterator()` This method only works on array tuples.
`Tuple`	`getSingleChild()` Return the single child of this tuple.
`Object`	`getValue()` This method is not visible to application.
`Collection<Tuple>`	`getValues()` Returns the collection of inner property values.
`boolean`	`isEmpty()` Check if a tuple contains some value.
`boolean`	`isLeaf()`
`String`	`leafAsString()` Return any leaf value as a String.
`Tuple`	`merge(Tuple b)` See mergeWith().
`Tuple`	`mergeWith(Tuple b)` Return a merge of two Tuples A and B recursively.
`Tuple`	`putAll(Map<String,Object> map)` Put all the provided tuple key values in this tuple.
`void`	`remove()` Remove the content of a tuple.
`TupleImpl`	`remove(String key)` Remove an inner child node.
`boolean`	`removeElement(Object value)` Remove a set or array element
`Tuple`	`replaceAllKeys(String regex, String replacement)` For each inner property Tuple contained in this tuple, replaces each substring occurence of its key that matches the given regular expression with the given replacement.
`Tuple`	`replaceAllKeyValues(String regex, String replacement)` Combines `Tuple.replaceAllKeys(java.lang.String, java.lang.String)` and `Tuple.replaceAllValues(java.lang.String, java.lang.String)` in one call.
`Tuple`	`select(String... keys)` Given a tuple, return a selection of one or several of its child.
`Tuple`	`set(Object value)` Set a new value to a tuple
`Tuple`	`set(String key, Object value)` Add a child object to a map tuple
`Tuple`	`setLeaf(Object o)` Deprecated.
`int`	`size()` Return the number of fields in this tuple.
`void`	`skip()` Skip a tuple value.
`Tuple[]`	`splitAsTupleArray(String regex)` Split this string into a Tuple array of the given regular expression.
`String`	`toAsciiJson()` Watchout, if you use this variant, any accent will be transformed into an ascii unicode representation.
`String`	`toEscapedJson()`
`String`	`toFlat()`
`String`	`toJson()` This method preserves non ascii characters.
`Map<String,Object>`	`toMap()` Convert a tuple to a Map.
`String`	`toString()` Return a String representation of the content of this tuple.
`TupleImpl`	`up()`

Methods inherited from class org.thales.punch.libraries.punchlang.impl.AbstractTupleImpl
asBoolean, asBytes, asCollection, asDouble, asDoubleArray, asFloat, asInt, asLong, asLongArray, asString, asString, asStringArray, attach, concat, containsOneOf, containsOneOf, cutPrefix, cutSuffix, endsWith, get, get, get, getAttachment, getCreateTrie, getDeep, getDeepEs, getKeys, getType, hasKey, indexOf, indexOf, indexOf, indexOf, isArray, isBooleanLeaf, isBytesLeaf, isDoubleLeaf, isEquals, isLongLeaf, isRoot, isSet, isStringLeaf, isTuple, length, matches, remove, replace, replaceAll, replaceAllValues, replaceFirst, split, startsWith, substring, substring, toArray, toLowerCase, toUpperCase, trim, tryBoolean, tryBoolean, tryBytes, tryBytes, tryDouble, tryDouble, tryIp, tryIp, tryIpv4, tryIpv4, tryIpv6, tryIpv6, tryLong, tryLong

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

- Field Detail
  - nullValue
```
public static final Object nullValue
```
    the null value is used to hold empty values.
- Constructor Detail
  - TupleImpl
```
public TupleImpl(Object o,
                 Ancestor ancestor)
```
    Return an intermediary or leaf tuple. It has a pointer to its direct ancestor.
    
    Parameters:
    
    o - the tuple content
    
    ancestor - the direct ancestor
- Method Detail
  - dtoPunchLeafValue
```
public static Object dtoPunchLeafValue(Object v)
```
    When inserting leaf values into sets or arrays, we transform various types into the expected core punch types.
    Typically ints or shorts become long. Jackson TextNode become strings, etc..
    
    Parameters:
    
    v - an object
    
    Returns:
    
    the json compatible object
  - getValue
```
public Object getValue()
```
    This method is not visible to application. It can only be used by the factory to efficiently convert the map to a Json String using the boon mapper.
    
    Returns:
    
    the map associated to this tuple.
  - set
```
public Tuple set(String key,
                 Object value)
```
    Add a child object to a map tuple
    
    Parameters:
    
    key - the new value key
    
    value - the new value
    
    Returns:
    
    this tuple
  - get
```
public Tuple get(String key)
```
    Retrieve a child. If the child node does not exists, an empty one is returned. The rationale is to allow executing:
```
   tuple.get("a").get("b|).get("c").set("hello");
 
```
    Without 'a' being there.
    Parameters:
    
    key - the target value key
    
    Returns:
    
    the child tuple
  - set
```
public Tuple set(Object value)
```
    Set a new value to a tuple
    
    Parameters:
    
    value - the value to set
    
    Returns:
    
    this tuple
  - remove
```
public void remove()
```
    Remove the content of a tuple. This has a recursive effect
  - remove
```
public TupleImpl remove(String key)
```
    Remove an inner child node.
    
    Parameters:
    
    key - the child key
    
    Returns:
    
    a TupleImpl detached from any parent
  - append
```
public TupleImpl append(Object value)
```
    Description copied from interface: Tuple
    
    Add a abject element at the end of an array. This method erases any non array content stored in the Tuple.
    
    Parameters:
    
    value - the element to append
    
    Returns:
    
    this tuple
  - add
```
public TupleImpl add(Object value)
```
    Description copied from interface: Tuple
    
    Add a tuple element into a set.
    As expected if you add several times the same element, it will be inserted only once.
    This method erases any previous value stored inside the tuple if it was not a set.
    
    Parameters:
    
    value - the Tuple you want to add
    
    Returns:
    
    this tuple
  - removeElement
```
public boolean removeElement(Object value)
```
    Remove a set or array element
    
    Parameters:
    
    value - the value to remove
    
    Returns:
    
    true only if the element was in the array or set.
  - empty
```
public void empty()
```
    Description copied from interface: Tuple
    
    Make a tuple empty. It only keeps its ancestor relationship.
  - exists
```
public boolean exists()
```
    Returns:
    
    true if this tuple contains something, i.e. at least a leaf value, an array, set or a map.
  - getElement
```
public Tuple getElement(int index)
```
    Description copied from interface: Tuple
    
    Retrieve the ith item from this tuple. This assumes this tuple contains an array.
    
    Parameters:
    
    index - the index of the element to retrieve
    
    Returns:
    
    the requested element
  - asArray
```
public List<Tuple> asArray()
```
    Description copied from interface: Tuple
    
    Returns an ordered list of elements if the tuple is an array or a set.
    Watch out, if the tuple is a set, the order will be random.
    
    Returns:
    
    the list of array elements
  - isEmpty
```
public boolean isEmpty()
```
    Description copied from interface: Tuple
    
    Check if a tuple contains some value.
    
    Returns:
    
    true if the tuple contains a leaf, map, set or array.
  - asSet
```
public Set<Tuple> asSet()
```
    Description copied from interface: Tuple
    
    Returns a set of elements. This assumes the tuple is set value.
    
    Returns:
    
    the list of set elements
  - setLeaf
```
@Deprecated
public Tuple setLeaf(Object o)
```
    Deprecated.
    
    Parameters:
    
    o - the leaf object
    
    Returns:
    
    null
  - contains
```
public boolean contains(Object element)
```
    Description copied from interface: Tuple
    
    This method behaves differently depending on the tuple type. If your tuple is a string leaf, it just behaves as a String.contains(CharSequence) call.
    If your tuple is a set it behaves as a Set.contains(Object) call. Watchout this method is inneficient for large sets.
    
    Parameters:
    
    element - the element
    
    Returns:
    
    true if the element is in the set, or if your substring is in the string leaf.
  - elements
```
public Tuple[] elements()
```
    Description copied from interface: Tuple
    
    Returns an array of elements. This works for array or set tuple.
    
    Returns:
    
    an array of elements as Tuple
  - getByKey
```
public Tuple getByKey(String key)
```
    Description copied from interface: Tuple
    
    Return a sub-tuple by key. This assumes the tuple is a map tuple. If it is not you will get a null answer.
    
    Parameters:
    
    key - the sub tuple key
    
    Returns:
    
    null if not there, or the requested sub tuple.
  - getValues
```
public Collection<Tuple> getValues()
```
    Description copied from interface: Tuple
    
    Returns the collection of inner property values. This requires a collection tuple.
    
    Returns:
    
    the list of values
  - getIterator
```
public Iterator<Object> getIterator()
```
    Description copied from interface: Tuple
    
    This method only works on array tuples. It returns an iterator.
    
    Returns:
    
    an iterator
  - getEntries
```
public List<Entry> getEntries()
```
    Description copied from interface: Tuple
    
    Returns the list of inner property key/values. This assumes the tuple is a map value.
    
    Returns:
    
    a list of entries.
  - getElement
```
public Tuple getElement()
```
    Description copied from interface: Tuple
    
    This method returns a new empty array element.
    
    Returns:
    
    an empty array element
  - toString
```
public String toString()
```
    Description copied from interface: Tuple
    
    Return a String representation of the content of this tuple. If your tuple contains a leaf value (String, a long double or boolean value) you will get that value simply converted as a String. For composite object, map or array, you get a toString representation. These are not JSON representations.
    Watchout : this method was originally documented as returning a JSON representation. If you need that use instead the or toAsciiJson() variants. If you are outside a punchlet, prefer the TupleFactory.getJsonFromTuple(Tuple) method and the likes.
    This method is completely different than Tuple.asString(). Use it to produce a Json.
    
    Specified by:
    
    toString in interface Tuple
    
    Overrides:
    
    toString in class Object
    
    Returns:
    
    the json-ified tuple
  - toJson
```
public String toJson()
```
    Description copied from interface: Tuple
    
    This method preserves non ascii characters.
    
    Returns:
    
    a valid Json representation of a tuple.
  - toFlat
```
public String toFlat()
```
    Returns:
    
    a key value flatten representation of your tuple
  - toAsciiJson
```
public String toAsciiJson()
```
    Description copied from interface: Tuple
    
    Watchout, if you use this variant, any accent will be transformed into an ascii unicode representation.
    
    Returns:
    
    valid full ascii Json representation of a tuple.
  - size
```
public int size()
```
    Description copied from interface: Tuple
    
    Return the number of fields in this tuple. This returns the number of element in a map, array or set tuple, 1 for a leaf tuple, and 0 if the tuple is empty.
    
    Returns:
    
    the size of the tuple.
  - compareTo
```
public int compareTo(Tuple o)
```
    Specified by:
    
    compareTo in interface Comparable<Tuple>
    
    Overrides:
    
    compareTo in class AbstractTupleImpl
  - compareTo
```
public int compareTo(TupleImpl o)
```
  - equals
```
public boolean equals(Object obj)
```
    Two tuples are equals if they are the same object or if they have the same leaf value. Otherwise, they're not.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    equal or not
  - isLeaf
```
public boolean isLeaf()
```
    Returns:
    
    true if this tuple contains a leaf value. i.e. a String Long Double Boolean
  - mergeWith
```
public Tuple mergeWith(Tuple b)
```
    Description copied from interface: Tuple
    
    Return a merge of two Tuples A and B recursively. It follows the following truth table:
    
    TypesA/B B Leaf B Array or Set B Map
    
    A Leaf B B B
    
    A Array or Set A Fusion A&B Exception
    
    A Map A Exception Recursive Merge on Keys
    
    Parameters:
    
    b - The Tuple to be merged.
    
    Returns:
    
    the Tuple merging both values.
  - merge
```
public Tuple merge(Tuple b)
```
    Description copied from interface: Tuple
    
    See mergeWith().
    
    Parameters:
    
    b - The Tuple to be merged.
    
    Returns:
    
    the Tuple merging both values.
  - leafAsString
```
public String leafAsString()
```
    Description copied from interface: Tuple
    
    Return any leaf value as a String. This method converts the leaf value to a string. It is different from the toString method in that no quotes are returned.
    
    Returns:
    
    the contained value as a String
  - getSingleChild
```
public Tuple getSingleChild()
```
    Description copied from interface: Tuple
    Return the single child of this tuple. This method only succeeds if this tuple contain a single sub-tuple.
    It is handy to deal with a very common punchplatform use case : receiving logs as single stream/field value. If you know that by configuration you can only receive a root tuple from a Storm PunchBolt as a single valued [streamId][fieldId] tuple, then you can simply write :
```
 
        tuple = root.getSingleChild().getSingleChild();
 
 
```
    Returns:
    
    the single child tuple.
  - splitAsTupleArray
```
public Tuple[] splitAsTupleArray(String regex)
```
    Description copied from interface: Tuple
    
    Split this string into a Tuple array of the given regular expression.
    
    Parameters:
    
    regex - - the delimiting regular expression
    
    Returns:
    
    the array of leaf Tuple
  - duplicate
```
public Tuple duplicate()
```
    Description copied from interface: Tuple
    
    Clone a tuple. This will return to you a deep copy of your tuple. Remember by default tuple operations are performed by reference.
    
    Returns:
    
    a new tuple
  - encodeBase64
```
public String encodeBase64()
```
    Description copied from interface: Tuple
    
    Encode a string Tuple into a base64 String
    Usage examples: String encoded = [a].encodeBase64(); [b] = [a].encodeBase64();
    
    Returns:
    
    base64 string
  - decodeBase64
```
public String decodeBase64()
```
    Description copied from interface: Tuple
    
    Decode a string Tuple already in base64
    Usage example: String decoded = [a].decodeBase64(); [b] = [a].decodeBase64();
    
    Returns:
    
    decoded string
  - select
```
public Tuple select(String... keys)
```
    Description copied from interface: Tuple
    Given a tuple, return a selection of one or several of its child. For example :
```
 
 // say input is a metricbeat  document with tons of fields including a "metricset" part
 // Executing this
 Tuple t = input.select("metricset");

 // produces a tuple t containing only "metricset", i.e. :
 //   "metricset" : {
 //     "module": "system",
 //     "name": "load",
 //     "rtt": 29
 //   }
 }
 
 
```
    Parameters:
    
    keys - the key(s) you want to select
    
    Returns:
    
    the selected tuple(s)
  - toEscapedJson
```
public String toEscapedJson()
```
    Returns:
    
    an RFC 4627 compliant escaped representation of this tuple
  - fromEscapedJson
```
public Tuple fromEscapedJson()
```
    Description copied from interface: Tuple
    
    This method assumes your tuple holds a string leaf value.
    
    Returns:
    
    a tuple from a RFC 4627 compliant escaped json string.
  - skip
```
public void skip()
```
    Description copied from interface: Tuple
    Skip a tuple value. This makes an inner field be removed and its content rattached to its father.
```
 
    // root : { "a" : { "b" : { "c" : 3 } } }
    root:[a].skip();
    // you have root == { "b" : { "c" : 3 } }
 
 
```
  - equalsOneOf
```
public boolean equalsOneOf(Tuple resource)
```
    Description copied from interface: Tuple
    Check if this tuple contains a sub-string. This variant takes in a resource tuple, and creates an PatriciaTrie index. It is created only the first time you call this method, subsequent calls will benefit from the ready to be used index. Use this variant in production if the set of substrings you need is always the same. It is the most efficient in particular if you have many sub-strings to check for.
    An example will best illustrate how it works. Say you have a domain name in a tuple field, [host][name] that contains for example "www.mydomain-prod.com". Suppose you want to know if that domain name contains one of the following substring
```
 
    { "prod", "admin" }
 
 
```
    Put your substring in a resource file (say) my-patterns.json. You can then simply write :
```
 
        if (tuple.equalsOneOf(getResourceTuple("my-patterns"))) {
                ...
    }
 
 
```
    Parameters:
    
    resource - your resource tuple, containing your string atoms
    
    Returns:
    
    true if your String leaf value matches one of the String defined in the resource tuple.
  - dump
```
public String dump()
```
    Description copied from interface: Tuple
    
    Return a String representation of this tuple.
    This method is completely different than Tuple.toString() in that it will not escape inner Strings. Use it to debug the tuple you work with.
    
    Returns:
    
    the content of the tuple
  - toMap
```
public Map<String,Object> toMap()
```
    Description copied from interface: Tuple
    
    Convert a tuple to a Map. This only works it the tuple contains a map, i.e. if tuple.isTuple() is true.
    
    Returns:
    
    the corresponding Map, or null if the tuple does not contain inner tuples.
  - replaceAllKeys
```
public Tuple replaceAllKeys(String regex,
                            String replacement)
```
    Description copied from interface: Tuple
    
    For each inner property Tuple contained in this tuple, replaces each substring occurence of its key that matches the given regular expression with the given replacement.
    
    Parameters:
    
    regex - the regular expression
    
    replacement - the replacement String
    
    Returns:
    
    the updated String
  - replaceAllKeyValues
```
public Tuple replaceAllKeyValues(String regex,
                                 String replacement)
```
    Description copied from interface: Tuple
    
    Combines Tuple.replaceAllKeys(java.lang.String, java.lang.String) and Tuple.replaceAllValues(java.lang.String, java.lang.String) in one call.
    
    Parameters:
    
    regex - the regular expression
    
    replacement - the replacement String
    
    Returns:
    
    the updated String
  - asGeoShape
```
public GeoFeatureTuple asGeoShape()
```
    Description copied from interface: Tuple
    
    Convert the Tuple in GeoFeatureTuple if the Tuple have the attributs : type and coordinates in content
    
    Returns:
    
    GeoFeatureTuple
  - up
```
public TupleImpl up()
```
  - putAll
```
public Tuple putAll(Map<String,Object> map)
```
    Description copied from interface: Tuple
    
    Put all the provided tuple key values in this tuple. This will transform your tuple into a map if not already one.
    
    Returns:
    
    this tuple

TypesA/B	B Leaf	B Array or Set	B Map
A Leaf	B	B	B
A Array or Set	A	Fusion A&B	Exception
A Map	A	Exception	Recursive Merge on Keys

Class TupleImpl

Field Summary

Fields inherited from class org.thales.punch.libraries.punchlang.impl.AbstractTupleImpl

Constructor Summary

Method Summary

Methods inherited from class org.thales.punch.libraries.punchlang.impl.AbstractTupleImpl

Methods inherited from class java.lang.Object

Field Detail

nullValue

Constructor Detail

TupleImpl

Method Detail

dtoPunchLeafValue

getValue

set

get

set

remove

remove

append

add

removeElement

empty

exists

getElement

asArray

isEmpty

asSet

setLeaf

contains

elements

getByKey

getValues

getIterator

getEntries

getElement

toString

toJson

toFlat

toAsciiJson

size

compareTo

compareTo

equals

isLeaf

mergeWith

merge

leafAsString

getSingleChild

splitAsTupleArray

duplicate

encodeBase64

decodeBase64

select

toEscapedJson

fromEscapedJson

skip

equalsOneOf

dump

toMap

replaceAllKeys

replaceAllKeyValues

asGeoShape

up

putAll