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

Helps building a list of Parameters, there are three approaches for values.

• provide string values. Syntax support when enabled: is [not] null/empty" and ! at the beginning
• provide string values and a converter to get the correct object. Support for ! at the beginning. StringConverter has some ready to use converters
• provide object values (which can be strings). No syntax support

The converter argument in methods may be null, conversion isn't applied then. Methods using Object for the parameter value don't apply conversion nor syntax support. When operator is not supplied, String values use the "like" operator, when a converter is provided "=" is the default operator. Wildcard mapping, case sensitivity and syntaxSupport are configured in the builder constructor, NOTE that wildcard mapping is independent from syntax support.

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 Param.Builder.WildcardMapping	DEFAULT_MAPPING
static String	ISEMPTY
static String	ISNOTEMPTY
static String	ISNOTNULL
static String	ISNULL
static char	NEGATION

Constructor Summary

Constructors

Constructor and Description
Builder() Builder with syntax support in value (!, is [not] null, is [not] 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 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) Bottleneck method, adds a new Param, does not apply any intelligence.
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.
Param.Builder	add(String paramKey, String paramValue, String operator, com.vectorprint.StringConverter converter) Uses true for "or"
List<Param>	build()
boolean	containsKey(String key)
boolean	isNegation(String value) check if a string (user value) indicates a negation and syntaxInValue is used
boolean	isSyntaxInValue() when true wildcards are not replaced and syntax in value is not applied
static String	operator(String operator, String value, boolean syntaxInValue) Returns static final Strings when syntax is used and present in value, otherwise the trimmed operator
Param.Builder	remove(String paramKey)
static boolean	valueIsOperator(String s, boolean syntaxInValue) users may input "is (not) null", "is (not) empty" etc., in that case there is no parameter value to be set for a key.

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

ISNULL

public static final String ISNULL

See Also:

Constant Field Values

ISNOTNULL

public static final String ISNOTNULL

See Also:

Constant Field Values

ISEMPTY

public static final String ISEMPTY

See Also:

Constant Field Values

ISNOTEMPTY

public static final String ISNOTEMPTY

See Also:

Constant Field Values

NEGATION

public static final char NEGATION

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 [not] null, is [not] 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

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 in the query for parameters 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 paramKey,
                         String paramValue,
                         String operator,
                         com.vectorprint.StringConverter converter)

Uses true for "or"

Parameters:

paramKey -

paramValue -

operator -

converter -

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. Calls add(java.lang.String, java.lang.String, java.lang.String, java.lang.Object, boolean, boolean) 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 -

paramKey -

operator -

paramValue -

or -

converter - see StringConverter

Returns:

add

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

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

Parameters:

propertyPath -

paramKey -

operator -

paramValue -

not -

or -

Returns:

Throws:

IllegalArgumentException - when paramKey is already present or when value is null

remove

public Param.Builder remove(String paramKey)

isNegation

public boolean isNegation(String value)

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

Parameters:

value -

Returns:

See Also:

NEGATION

operator

public static String operator(String operator,
                              String value,
                              boolean syntaxInValue)

Returns static final Strings when syntax is used and present in value, otherwise the trimmed operator

Parameters:

operator -

value -

syntaxInValue -

Returns:

valueIsOperator

public static boolean valueIsOperator(String s,
                                      boolean syntaxInValue)

users may input "is (not) null", "is (not) empty" etc., in that case there is no parameter value to be set for a key.

Parameters:

s -

syntaxInValue -

Returns:

build

public List<Param> build()

isSyntaxInValue

public boolean isSyntaxInValue()

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

Returns:

containsKey

public boolean containsKey(String key)