org.nuiton.spgeed

Class PipeFunctions

java.lang.Object

org.nuiton.spgeed.PipeFunctions

public class PipeFunctions
extends Object

Default function that can be used in sql expression (${...}). If you create new function here, add it in getExposedFunction

Author:

julien

Field Summary

Fields

Modifier and Type	Field and Description
protected Map<String,PipeFunction>	exposedFunction

Constructor Summary

Constructors

Constructor and Description
PipeFunctions()

Method Summary

Modifier and Type	Method and Description
Object	array(Query query, Object in, Object... args) Create string SQL Array representation of value, where each array item is replace by '?'
Object	collection(Query query, Object in, Object... args)
Map<String,PipeFunction>	getExposedFunction()
protected String[]	getFieldType(String field, boolean appendDelim)
protected boolean	isRow(String fields) try to match multiple fields with comma separator ex: "bidulle.truc, bidulle.machin, bidulle.email[0]"
Object	json(Query query, Object in, Object... args) convert value to json and add it to query parameter
protected Object	map(boolean forceCollection, Object value, org.nuiton.spgeed.PipeFunctions.MapFunction f) Call f.map for each element in value.
Object	map(Query query, Object in, Object... args) Convert each value in parameter 'in'
Object	row(Query query, Object in, Object... args)
Object	toParam(Query query, Object in, Object... args) Add value to query parameter and return string substitution '?'
Object	toString(Query query, Object in, Object... args) convert value to string value and return it
Object	values(Query query, Object in, Object... args) create sql insert value string, support 'in' as object or collection ex: "insert into mytable (id, myfield) values ${myobject |values('id', 'myfield)}" return "insert into mytable (id, myfield) values (?

Methods inherited from class java.lang.Object

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

Field Detail

exposedFunction

protected Map<String,PipeFunction> exposedFunction

Constructor Detail

PipeFunctions

public PipeFunctions()

Method Detail

getExposedFunction

public Map<String,PipeFunction> getExposedFunction()

map

protected Object map(boolean forceCollection,
                     Object value,
                     org.nuiton.spgeed.PipeFunctions.MapFunction f)
              throws Exception

Call f.map for each element in value. If value is not a collection apply f only to this value

Parameters:

forceCollection - if true result is always a collection. if value is null return empty collection if value is object return collection with one item if value is array or collection return collection with same item number

value - Collection or Array or Object

f - function used to map object

Returns:

null if value is null, Object return by f if value is not a collection and new collection with mapped result otherwize

Throws:

Exception

isRow

protected boolean isRow(String fields)

try to match multiple fields with comma separator ex: "bidulle.truc, bidulle.machin, bidulle.email[0]"

Parameters:

fields -

Returns:

true if fields is list of field

getFieldType

protected String[] getFieldType(String field,
                                boolean appendDelim)

Parameters:

field -

appendDelim - if true, append "::" before type

Returns:

return field name and field type, if no field name or type, empty string is returned in array

toParam

public Object toParam(Query query,
                      Object in,
                      Object... args)
               throws Exception

Add value to query parameter and return string substitution '?'

Parameters:

query - current query

in - value to convert to param

args - only one argument. This argument must be cast per example "::json", is used to add "::json" (type must be postgresql type) you can specify field name before type, to extract only one field from in value ex: birthdate::int

Returns:

string substitution '?'

Throws:

Exception

toString

public Object toString(Query query,
                       Object in,
                       Object... args)

convert value to string value and return it

Parameters:

query - current query

in - value to convert to string

args - not used

Returns:

string representation of value

json

public Object json(Query query,
                   Object in,
                   Object... args)
            throws com.fasterxml.jackson.core.JsonProcessingException,
                   SQLException

convert value to json and add it to query parameter

Parameters:

query - current query

in - value to convert to json

args - not used

Returns:

string parameter substitution '?'

Throws:

com.fasterxml.jackson.core.JsonProcessingException

SQLException

array

public Object array(Query query,
                    Object in,
                    Object... args)
             throws Exception

Create string SQL Array representation of value, where each array item is replace by '?' and real value pushed in query parameter

Parameters:

query - current query

in - Must be Collection or Array, each element is one element in sql ARRAY

args - not used

Returns:

SQL array as string with parameter (ex: ARRAY[?, ?, ?])

Throws:

Exception

collection

public Object collection(Query query,
                         Object in,
                         Object... args)
                  throws Exception

Throws:

Exception

row

public Object row(Query query,
                  Object in,
                  Object... args)
           throws Exception

Throws:

Exception

values

public Object values(Query query,
                     Object in,
                     Object... args)
              throws Exception

create sql insert value string, support 'in' as object or collection ex: "insert into mytable (id, myfield) values ${myobject |values('id', 'myfield)}" return "insert into mytable (id, myfield) values (?, ?)" "insert into mytable (id, myfield) values ${myArrayOfObject |values('id', 'myfield)}" return "insert into mytable (id, myfield) values (?, ?), (?, ?), (?, ?)"

Parameters:

query - current query

in - object or collection of object used to create values

args - list of field to extract as value parameter

Returns:

Throws:

Exception

map

public Object map(Query query,
                  Object in,
                  Object... args)
           throws Exception

Convert each value in parameter 'in'

Parameters:

query - current query

in - Collection to convert

args - field to extract from each object in parameter 'in'

Returns:

collection with extracted field, if arg is empty, return in if args length == 1 then collection contains field value directly if args length >= 2 then collection contains map with field name as key

Throws:

Exception