org.fryske_akademy.jpa

Class Param.Builder

java.lang.Object

org.fryske_akademy.jpa.Param.Builder

Enclosing class:

Param

public static class Param.Builder
extends Object

A factory for Param objects, parameter values can be added in two ways:

• as (the correct) Object => only syntax and wildcard support for String values
• as a String using a converter => syntax support also for non String values, no wildcard support

Users may use syntax in values they submit:

• (!)is null
• (!)is empty
• (!)>
• (!)<
• 1 <=> 10

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Param.Builder.DefaultWildcardMapping * => %, ? => _, NOTE that this mapping causes all four characters to be interpreted as wildcards in jpql/sql.
static interface	Param.Builder.WildcardMapping translation table a wildcard for more characters and a wildcard for one character

Field Summary

Fields

Modifier and Type	Field and Description
static String	BETWEENPATTERN
static Param.Builder.WildcardMapping	DEFAULT_MAPPING
static char	GREATER
static String	ISBLANK
static String	ISEMPTY for empty collection!
static String	ISNOTBLANK
static String	ISNOTEMPTY for non empty collection!
static String	ISNOTNULL
static String	ISNULL
static char	NEGATION
static char	SMALLER

Constructor Summary

Constructors

Constructor and Description
Builder() Builder with syntax support in value (!, >, < [!]is null, [!]is empty).
Builder(boolean caseInsensitive) Calls #Builder(boolean, WildcardMapping, boolean) } with true, null and the caseInsensitive argument.
Builder(boolean syntaxInValue, Param.Builder.WildcardMapping wildcardMapping, boolean caseInsensitive)

Method Summary

Modifier and Type	Method and Description
Param.Builder	add(String paramKey, Object paramValue) This method is suitable when your paramValue is the correct object for the query to be executed.
Param.Builder	add(String paramKey, Object paramValue, boolean or) This method is suitable when your paramValue is the correct object for the query to be executed.
Param.Builder	add(String paramKey, String paramValue, boolean or, com.vectorprint.StringConverter converter) This method is suitable when your paramValue is a String that must be converted to get the correct object for the query to be executed.
Param.Builder	add(String propertyPath, String paramKey, Object paramValue, boolean or) This method is suitable when your paramValue is the correct object for the query to be executed.
Param.Builder	add(String propertyPath, String paramKey, Param.OPERATOR operator, Object paramValue, boolean not, boolean or) Calls #add(String, String, OPERATOR, Object, boolean, boolean, Object) with null for maxValue
Param.Builder	add(String propertyPath, String paramKey, Param.OPERATOR operator, Object paramValue, boolean not, boolean or, Object maxValue) Bottleneck method, adds a new Param, does not apply any intelligence.
Param.Builder	add(String paramKey, String paramValue, String operator, boolean or, com.vectorprint.StringConverter converter) Assumes key and propertyPath are the same
Param.Builder	add(String paramKey, String paramValue, com.vectorprint.StringConverter converter) This method is suitable when your paramValue is a String that must be converted to get the correct object for the query to be executed.
Param.Builder	add(String propertyPath, String paramKey, String operator, Object paramValue, boolean not, boolean or) Calls add(String, String, String, Object, boolean, boolean, Object) with null for maxValue
Param.Builder	add(String propertyPath, String paramKey, String operator, Object paramValue, boolean not, boolean or, Object maxValue) Calls #add(String, String, OPERATOR, Object, boolean, boolean, Object) with Param.OPERATOR.fromToken(String)
Param.Builder	add(String propertyPath, String paramKey, String operator, String paramValue, boolean or, com.vectorprint.StringConverter converter) Bottleneck method for String values, when configured in the Builder, applies syntax support and wildcard mapping, applies conversion of the String value using the supplied converter.
Param.Builder	add(String propertyPath, String paramKey, String paramValue, com.vectorprint.StringConverter converter) This method is suitable when your paramValue is a String that must be converted to get the correct object for the query to be executed.
Param.Builder	addParam(List<Param> p)
Param.Builder	addParam(Param... p)
List<Param>	build() usefull if for example you need to add parameters yielded by a diffently configured builder
Param.Builder	checkNotNull(String propertyPath)
boolean	containsKey(String key)
static boolean	greater(String value) check if a string (user value) indicates a greater than comparison
static boolean	isBetween(String value)
boolean	isGreaterThan(String value) check if a string (user value) indicates a greater than comparison when syntaxInValue is used
boolean	isNegation(String value) check if a string (user value) indicates a negation when syntaxInValue is used
boolean	isSmallerThan(String value) check if a string (user value) indicates a smaller than comparison when syntaxInValue is used
boolean	isSyntaxInValue() when true wildcards are not replaced and syntax in value is not applied
Param.Builder	lastParamEndsGroup(boolean group)
Param.Builder	lastParamStartsGroup(boolean group)
static boolean	negation(String value) check if a string (user value) indicates a negation
Param.OPERATOR	operator(String operator, String value, boolean syntaxInValue) Returns an operator from the value when syntax is used and the trimmed value equals one of the supported operators, otherwise the trimmed operator
Param.Builder	remove(String paramKey)
static boolean	smaller(String value) check if a string (user value) indicates a smaller than comparison
static boolean	valueIsOperator(String s, boolean syntaxInValue) users may input "(!)is null", "(!)is empty", in that case there is no parameter value to be set for a key and the negation is in the operator ("is not null" as opposed to "not >")

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT_MAPPING

public static final Param.Builder.WildcardMapping DEFAULT_MAPPING

NEGATION

public static final char NEGATION

See Also:

Constant Field Values

ISNULL

public static final String ISNULL

See Also:

Constant Field Values

ISNOTNULL

public static final String ISNOTNULL

See Also:

Constant Field Values

ISBLANK

public static final String ISBLANK

See Also:

Constant Field Values

ISNOTBLANK

public static final String ISNOTBLANK

See Also:

Constant Field Values

ISEMPTY

public static final String ISEMPTY

for empty collection!

See Also:

Constant Field Values

ISNOTEMPTY

public static final String ISNOTEMPTY

for non empty collection!

See Also:

Constant Field Values

GREATER

public static final char GREATER

See Also:

Constant Field Values

SMALLER

public static final char SMALLER

See Also:

Constant Field Values

BETWEENPATTERN

public static final String BETWEENPATTERN

See Also:

Constant Field Values

Constructor Detail

Builder

public Builder(boolean syntaxInValue,
               Param.Builder.WildcardMapping wildcardMapping,
               boolean caseInsensitive)

Builder

public Builder()

Builder with syntax support in value (!, >, < [!]is null, [!]is empty). Calls #Builder(boolean, WildcardMapping, boolean) with true, null and false.

Builder

public Builder(boolean caseInsensitive)

Calls #Builder(boolean, WildcardMapping, boolean) } with true, null and the caseInsensitive argument.

Parameters:

caseInsensitive -

Method Detail

valueIsOperator

public static boolean valueIsOperator(String s,
                                      boolean syntaxInValue)

users may input "(!)is null", "(!)is empty", in that case there is no parameter value to be set for a key and the negation is in the operator ("is not null" as opposed to "not >")

Parameters:

s -

syntaxInValue -

Returns:

add

public Param.Builder add(String paramKey,
                         Object paramValue)

This method is suitable when your paramValue is the correct object for the query to be executed. It uses "like" as operator for String, otherwise "=".

Parameters:

paramKey -

paramValue -

Returns:

add

public Param.Builder add(String paramKey,
                         Object paramValue,
                         boolean or)

This method is suitable when your paramValue is the correct object for the query to be executed. It uses "like" as operator for String, otherwise "=".

Parameters:

paramKey -

paramValue -

or - will be prepended to parameters in the query except the first

Returns:

add

public Param.Builder add(String propertyPath,
                         String paramKey,
                         Object paramValue,
                         boolean or)

This method is suitable when your paramValue is the correct object for the query to be executed. The propertyPath may differ from key allowing you to apply multiple comparisons for the same propertyPath (i.e. e.column1=:column1 or e.column1=:column2). It uses "like" as operator for String, otherwise "=".

Parameters:

propertyPath -

paramKey -

paramValue -

or - will be prepended to parameters in the query except the first

Returns:

add

public Param.Builder add(String paramKey,
                         String paramValue,
                         com.vectorprint.StringConverter converter)

This method is suitable when your paramValue is a String that must be converted to get the correct object for the query to be executed. It uses "like" as operator when converter is null otherwise "=".

Parameters:

paramKey -

paramValue -

converter - see StringConverter

Returns:

add

public Param.Builder add(String propertyPath,
                         String paramKey,
                         String paramValue,
                         com.vectorprint.StringConverter converter)

This method is suitable when your paramValue is a String that must be converted to get the correct object for the query to be executed. The propertyPath may differ from key allowing you to apply multiple comparisons for the same propertyPath (i.e. e.column1=:column1 or e.column1=:column2). It uses "like" as operator when converter is null otherwise "=".

Parameters:

propertyPath -

paramKey -

paramValue -

converter - see StringConverter

Returns:

add

public Param.Builder add(String paramKey,
                         String paramValue,
                         boolean or,
                         com.vectorprint.StringConverter converter)

This method is suitable when your paramValue is a String that must be converted to get the correct object for the query to be executed. It uses "like" as operator when converter is null otherwise "=".

Parameters:

paramKey -

paramValue -

or -

converter - see StringConverter

Returns:

add

public Param.Builder add(String paramKey,
                         String paramValue,
                         String operator,
                         boolean or,
                         com.vectorprint.StringConverter converter)

Assumes key and propertyPath are the same

Parameters:

paramKey -

paramValue -

operator -

or -

converter -

Returns:

add

public Param.Builder add(String propertyPath,
                         String paramKey,
                         String operator,
                         String paramValue,
                         boolean or,
                         com.vectorprint.StringConverter converter)

Bottleneck method for String values, when configured in the Builder, applies syntax support and wildcard mapping, applies conversion of the String value using the supplied converter. Calls #add(String, String, OPERATOR, Object, boolean, boolean, Object) } with operator(java.lang.String, java.lang.String, boolean) for the operator. The value will be the empty string when valueIsOperator(java.lang.String, boolean) is true, will be StringConverter.convert(java.lang.String) when a converter is provided (negation is stripped), otherwise the value is returned with wildcards replaced and negation stripped (provided syntax support in values is active).

Parameters:

propertyPath - The propertyPath may differ from key allowing you to apply multiple comparisons for the same propertyPath (i.e. e.column1=:column1 or e.column1=:column2).

paramKey -

operator -

paramValue -

or -

converter - see StringConverter

Returns:

checkNotNull

public Param.Builder checkNotNull(String propertyPath)

lastParamStartsGroup

public Param.Builder lastParamStartsGroup(boolean group)

Parameters:

group - when true the last parameter starts a group (.

Returns:

lastParamEndsGroup

public Param.Builder lastParamEndsGroup(boolean group)

Parameters:

group - when true the last parameter starts a group (.

Returns:

isBetween

public static boolean isBetween(String value)

add

public Param.Builder add(String propertyPath,
                         String paramKey,
                         Param.OPERATOR operator,
                         Object paramValue,
                         boolean not,
                         boolean or,
                         Object maxValue)

Bottleneck method, adds a new Param, does not apply any intelligence.

Parameters:

propertyPath - The propertyPath may differ from key allowing you to apply multiple comparisons for the same propertyPath (i.e. e.column1=:column1 or e.column1=:column2).

paramKey -

operator -

paramValue -

not -

or -

maxValue - for Param.OPERATOR.BETWEEN

Returns:

Throws:

IllegalArgumentException - when paramKey is already present, value is null or invalid BETWEEN values

add

public Param.Builder add(String propertyPath,
                         String paramKey,
                         Param.OPERATOR operator,
                         Object paramValue,
                         boolean not,
                         boolean or)

Calls #add(String, String, OPERATOR, Object, boolean, boolean, Object) with null for maxValue

Parameters:

propertyPath -

paramKey -

operator -

paramValue -

not -

or -

Returns:

add

public Param.Builder add(String propertyPath,
                         String paramKey,
                         String operator,
                         Object paramValue,
                         boolean not,
                         boolean or,
                         Object maxValue)

Calls #add(String, String, OPERATOR, Object, boolean, boolean, Object) with Param.OPERATOR.fromToken(String)

Parameters:

propertyPath -

paramKey -

operator -

paramValue -

not -

or -

maxValue - for Param.OPERATOR.BETWEEN

Returns:

add

public Param.Builder add(String propertyPath,
                         String paramKey,
                         String operator,
                         Object paramValue,
                         boolean not,
                         boolean or)

Calls add(String, String, String, Object, boolean, boolean, Object) with null for maxValue

Parameters:

propertyPath -

paramKey -

operator -

paramValue -

not -

or -

Returns:

remove

public Param.Builder remove(String paramKey)

isNegation

public boolean isNegation(String value)

check if a string (user value) indicates a negation when syntaxInValue is used

Parameters:

value -

Returns:

See Also:

NEGATION

negation

public static boolean negation(String value)

check if a string (user value) indicates a negation

Parameters:

value -

Returns:

See Also:

NEGATION

greater

public static boolean greater(String value)

check if a string (user value) indicates a greater than comparison

Parameters:

value -

Returns:

See Also:

GREATER

smaller

public static boolean smaller(String value)

check if a string (user value) indicates a smaller than comparison

Parameters:

value -

Returns:

See Also:

SMALLER

isGreaterThan

public boolean isGreaterThan(String value)

check if a string (user value) indicates a greater than comparison when syntaxInValue is used

Parameters:

value -

Returns:

See Also:

GREATER

isSmallerThan

public boolean isSmallerThan(String value)

check if a string (user value) indicates a smaller than comparison when syntaxInValue is used

Parameters:

value -

Returns:

See Also:

SMALLER

operator

public Param.OPERATOR operator(String operator,
                               String value,
                               boolean syntaxInValue)

Returns an operator from the value when syntax is used and the trimmed value equals one of the supported operators, otherwise the trimmed operator

Parameters:

operator -

value -

syntaxInValue -

Returns:

addParam

public Param.Builder addParam(List<Param> p)

addParam

public Param.Builder addParam(Param... p)

build

public List<Param> build()

usefull if for example you need to add parameters yielded by a diffently configured builder

Returns:

isSyntaxInValue

public boolean isSyntaxInValue()

when true wildcards are not replaced and syntax in value is not applied

Returns:

containsKey

public boolean containsKey(String key)