Package org.keycloak.models.map.storage.hotRod

Class IckleQueryMapModelCriteriaBuilder<E extends AbstractHotRodEntity,M>

java.lang.Object

org.keycloak.models.map.storage.hotRod.IckleQueryMapModelCriteriaBuilder<E,M>

All Implemented Interfaces:

ModelCriteriaBuilder<M,IckleQueryMapModelCriteriaBuilder<E,M>>

public class IckleQueryMapModelCriteriaBuilder<E extends AbstractHotRodEntity,M>
extends Object
implements ModelCriteriaBuilder<M,IckleQueryMapModelCriteriaBuilder<E,M>>

Nested Class Summary

Nested classes/interfaces inherited from interface org.keycloak.models.map.storage.ModelCriteriaBuilder

ModelCriteriaBuilder.Operator

Field Summary

Fields

Modifier and Type	Field	Description
static Map<SearchableModelField<?>,String>	INFINISPAN_NAME_OVERRIDES
static Set<SearchableModelField<?>>	LOWERCASE_NORMALIZED_MODEL_FIELDS

Constructor Summary

Constructors

Constructor	Description
IckleQueryMapModelCriteriaBuilder(Class<E> hotRodEntityClass)
IckleQueryMapModelCriteriaBuilder(Class<E> hotRodEntityClass, StringBuilder whereClauseBuilder, Map<String,Object> parameters)

Method Summary

Modifier and Type	Method	Description
IckleQueryMapModelCriteriaBuilder<E,M>	and(IckleQueryMapModelCriteriaBuilder<E,M>... builders)	Creates and returns a new instance of ModelCriteriaBuilder that combines the given builders with the Boolean AND operator.
IckleQueryMapModelCriteriaBuilder<E,M>	compare(SearchableModelField<? super M> modelField, ModelCriteriaBuilder.Operator op, Object... value)	Adds a constraint for the given model field to this criteria builder and returns a criteria builder that is combined with the the new constraint.
static String	getFieldName(SearchableModelField<?> modelField)
String	getIckleQuery()
Map<String,Object>	getParameters()	Ickle queries are created using named parameters to avoid query injections; this method provides mapping between parameter names and corresponding values
IckleQueryMapModelCriteriaBuilder<E,M>	not(IckleQueryMapModelCriteriaBuilder<E,M> builder)	Creates and returns a new instance of ModelCriteriaBuilder that negates the given builder.
IckleQueryMapModelCriteriaBuilder<E,M>	or(IckleQueryMapModelCriteriaBuilder<E,M>... builders)	Creates and returns a new instance of ModelCriteriaBuilder that combines the given builders with the Boolean OR operator.
static Object	sanitizeNonAnalyzed(Object value)

Methods inherited from class java.lang.Object

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

Field Detail

INFINISPAN_NAME_OVERRIDES

public static final Map<SearchableModelField<?>,String> INFINISPAN_NAME_OVERRIDES

LOWERCASE_NORMALIZED_MODEL_FIELDS

public static final Set<SearchableModelField<?>> LOWERCASE_NORMALIZED_MODEL_FIELDS

Constructor Detail

IckleQueryMapModelCriteriaBuilder

public IckleQueryMapModelCriteriaBuilder(Class<E> hotRodEntityClass,
                                         StringBuilder whereClauseBuilder,
                                         Map<String,Object> parameters)

IckleQueryMapModelCriteriaBuilder

public IckleQueryMapModelCriteriaBuilder(Class<E> hotRodEntityClass)

Method Detail

getFieldName

public static String getFieldName(SearchableModelField<?> modelField)

compare

public IckleQueryMapModelCriteriaBuilder<E,M> compare(SearchableModelField<? super M> modelField,
                                                            ModelCriteriaBuilder.Operator op,
                                                            Object... value)

Description copied from interface: ModelCriteriaBuilder

Adds a constraint for the given model field to this criteria builder and returns a criteria builder that is combined with the the new constraint. The resulting constraint is a logical conjunction (i.e. AND) of the original constraint present in this ModelCriteriaBuilder and the given operator.

Specified by:

compare in interface ModelCriteriaBuilder<E extends AbstractHotRodEntity,M>

Parameters:

modelField - Field on the logical model to be constrained

op - Operator

value - Additional operands of the operator.

Returns:

and

public IckleQueryMapModelCriteriaBuilder<E,M> and(IckleQueryMapModelCriteriaBuilder<E,M>... builders)

Description copied from interface: ModelCriteriaBuilder

Creates and returns a new instance of ModelCriteriaBuilder that combines the given builders with the Boolean AND operator.

Predicate coming out of and on an empty array of builders (i.e. empty conjunction) is always true.

   cb = storage.getCriteriaBuilder();
   storage.read(cb.or(
     cb.and(cb.compare(FIELD1, EQ, 1), cb.compare(FIELD2, EQ, 2)),
     cb.and(cb.compare(FIELD1, EQ, 3), cb.compare(FIELD2, EQ, 4))
   );
 

Specified by:

and in interface ModelCriteriaBuilder<E extends AbstractHotRodEntity,M>

or

public IckleQueryMapModelCriteriaBuilder<E,M> or(IckleQueryMapModelCriteriaBuilder<E,M>... builders)

Description copied from interface: ModelCriteriaBuilder

Creates and returns a new instance of ModelCriteriaBuilder that combines the given builders with the Boolean OR operator.

Predicate coming out of or on an empty array of builders (i.e. empty disjunction) is always false.

   cb = storage.getCriteriaBuilder();
   storage.read(cb.or(
     cb.compare(FIELD1, EQ, 1).compare(FIELD2, EQ, 2),
     cb.compare(FIELD1, EQ, 3).compare(FIELD2, EQ, 4)
   );
 

Specified by:

or in interface ModelCriteriaBuilder<E extends AbstractHotRodEntity,M>

not

public IckleQueryMapModelCriteriaBuilder<E,M> not(IckleQueryMapModelCriteriaBuilder<E,M> builder)

Description copied from interface: ModelCriteriaBuilder

Creates and returns a new instance of ModelCriteriaBuilder that negates the given builder.

Note that if the builder has no condition yet, there is nothing to negate: empty negation is always true.

Specified by:

not in interface ModelCriteriaBuilder<E extends AbstractHotRodEntity,M>

Returns:

sanitizeNonAnalyzed

public static Object sanitizeNonAnalyzed(Object value)

getIckleQuery

public String getIckleQuery()

Returns:

Ickle query that represents this QueryBuilder

getParameters

public Map<String,Object> getParameters()

Ickle queries are created using named parameters to avoid query injections; this method provides mapping between parameter names and corresponding values

Returns:

Mapping from name of the parameter to value