io.cdap.functions

Class JsonFunctions

java.lang.Object

io.cdap.functions.JsonFunctions

public final class JsonFunctions
extends Object

Collection of useful expression functions made available in the context of an expression. set-column column

Field Summary

Fields

Modifier and Type	Field and Description
static com.jayway.jsonpath.Configuration	GSON_CONFIGURATION

Method Summary

Modifier and Type	Method and Description
static int	ArrayLength(com.google.gson.JsonArray array)
static com.google.gson.JsonElement	drop(com.google.gson.JsonElement element, String field, String... fields) Deprecated.
static com.google.gson.JsonElement	drop(String json, String field, String... fields) Deprecated.
static boolean	IsArray(com.google.gson.JsonElement element) Checks if a Json is JsonArray.
static boolean	IsNull(com.google.gson.JsonElement element) Checks if a Json is JsonNull.
static boolean	IsObject(com.google.gson.JsonElement element) Checks if a Json is JsonObject.
static boolean	IsValid(String json) Checks if a json is valid.
static String	join(com.google.gson.JsonElement element, String separator) Deprecated.
static com.google.gson.JsonElement	keysToLower(com.google.gson.JsonElement element) Deprecated.
static com.google.gson.JsonElement	parse(String json) Deprecated.
static com.google.gson.JsonElement	Parse(String json) Parses a column or string to JSON.
static com.google.gson.JsonElement	parse(String json, boolean toLower) Deprecated.
static com.google.gson.JsonElement	select(com.google.gson.JsonElement element, boolean toLower, String path, String... paths) Deprecated.
static com.google.gson.JsonElement	select(com.google.gson.JsonElement element, String path, String... paths) Deprecated.
static com.google.gson.JsonElement	Select(com.google.gson.JsonElement element, String path, String... paths) Selects part of JSON using JSON DSL specified as json path.
static com.google.gson.JsonElement	select(String json, boolean toLower, String path, String... paths) Deprecated.
static com.google.gson.JsonElement	select(String json, String path, String... paths) Deprecated.
static String	stringify(com.google.gson.JsonElement element) Deprecated.
static String	Stringify(com.google.gson.JsonElement element) This method stringyfies json object.

Methods inherited from class java.lang.Object

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

Field Detail

GSON_CONFIGURATION

public static final com.jayway.jsonpath.Configuration GSON_CONFIGURATION

Method Detail

select

@Deprecated
public static com.google.gson.JsonElement select(String json,
                                                             String path,
                                                             String... paths)

Deprecated.

select

@Deprecated
public static com.google.gson.JsonElement select(String json,
                                                             boolean toLower,
                                                             String path,
                                                             String... paths)

Deprecated.

select

@Deprecated
public static com.google.gson.JsonElement select(com.google.gson.JsonElement element,
                                                             String path,
                                                             String... paths)

Deprecated.

select

@Deprecated
public static com.google.gson.JsonElement select(com.google.gson.JsonElement element,
                                                             boolean toLower,
                                                             String path,
                                                             String... paths)

Deprecated.

drop

@Deprecated
public static com.google.gson.JsonElement drop(String json,
                                                           String field,
                                                           String... fields)

Deprecated.

drop

@Deprecated
public static com.google.gson.JsonElement drop(com.google.gson.JsonElement element,
                                                           String field,
                                                           String... fields)

Deprecated.

Removes fields from a JSON inline. This method recursively iterates through the Json to delete one or more fields specified. It requires the Json to be parsed.

Parameters:

element - Json element to be parsed.

field - first field to be deleted.

fields - list of fields to be deleted.

Returns:

keysToLower

@Deprecated
public static com.google.gson.JsonElement keysToLower(com.google.gson.JsonElement element)

Deprecated.

This function lowers the keys of the json. it applies this transformation recurively.

Parameters:

element - to be transformed.

Returns:

modified element.

join

@Deprecated
public static String join(com.google.gson.JsonElement element,
                                      String separator)

Deprecated.

stringify

@Deprecated
public static String stringify(com.google.gson.JsonElement element)

Deprecated.

This method converts a JavaScript value to a JSON string.

Parameters:

element - the value to convert to JSON string

Returns:

a JSON string.

parse

@Deprecated
public static com.google.gson.JsonElement parse(String json)

Deprecated.

Parses a column or string to JSON. This is equivalent to JSON.parse() This function by default lowercases the keys.

Parameters:

json - string representation of json.

Returns:

parsed json else throws an exception.

parse

@Deprecated
public static com.google.gson.JsonElement parse(String json,
                                                            boolean toLower)

Deprecated.

Parses a column or string to JSON. This is equivalent to JSON.parse()

Parameters:

json - string representation of json.

toLower - true to lower case keys, false to leave it as-is.

Returns:

parsed json else throws an exception.

Parse

public static com.google.gson.JsonElement Parse(String json)

Parses a column or string to JSON. If the json string is invalid, this method will return a JsonNull

Parameters:

json - string representation of json.

Returns:

parsed json

IsValid

public static boolean IsValid(String json)

Checks if a json is valid.

Parameters:

json - to checked for validity.

Returns:

true if valid, false otherwise.

IsNull

public static boolean IsNull(com.google.gson.JsonElement element)

Checks if a Json is JsonNull.

Parameters:

element - to be inspected for null.

Returns:

true if null, false otherwise.

IsObject

public static boolean IsObject(com.google.gson.JsonElement element)

Checks if a Json is JsonObject.

Parameters:

element - to be inspected for object.

Returns:

true if object, false otherwise.

IsArray

public static boolean IsArray(com.google.gson.JsonElement element)

Checks if a Json is JsonArray.

Parameters:

element - to be inspected for array.

Returns:

true if array, false otherwise.

Select

public static com.google.gson.JsonElement Select(com.google.gson.JsonElement element,
                                                 String path,
                                                 String... paths)

Selects part of JSON using JSON DSL specified as json path.

Parameters:

element - json to be inspected.

path - to be searched for in the element.

paths - other paths.

Returns:

A json array containing the results of all json paths.

Stringify

public static String Stringify(com.google.gson.JsonElement element)

This method stringyfies json object.

Parameters:

element - the value to convert to JSON string

Returns:

a JSON string.

ArrayLength

@Nullable
public static int ArrayLength(com.google.gson.JsonArray array)

Returns:

Number of elements in the array.