Package io.jmix.core.querycondition

Class JpqlCondition

java.lang.Object

io.jmix.core.querycondition.SkippableCondition<JpqlCondition>

io.jmix.core.querycondition.JpqlCondition

All Implemented Interfaces:

Condition, Serializable

public class JpqlCondition
extends SkippableCondition<JpqlCondition>

Condition that represents JPQL query with "where" and optional "join" sections.

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
protected String	join
static final Pattern	PARAMETER_PATTERN
protected Map<String,Object>	parameterValuesMap
protected String	where

Fields inherited from class io.jmix.core.querycondition.SkippableCondition

skipNullOrEmpty

Constructor Summary

Constructors

Constructor	Description
JpqlCondition()

Method Summary

Modifier and Type	Method	Description
Condition	actualize(Set<String> actualParameters, boolean defaultSkipNullOrEmpty)	Checks whether the argument contains all parameters specified in the condition.
Condition	copy()	Returns a deep copy of this condition.
static JpqlCondition	create(String where, String join)
static JpqlCondition	createWithParameters(String where, String join, Map<String,Object> parameterValuesMap)
Set<String>	getExcludedParameters(Set<String> actualParameters)	Returns names of parameters that are not present in the given actualParameters but have null or empty value.
String	getJoin()
Collection<String>	getParameters()	Returns parameters specified in the condition.
Map<String,Object>	getParameterValuesMap()
String	getWhere()
protected void	parseParameters(String value)
protected void	removeParameters(String value)
void	setJoin(String join)
void	setParameterValuesMap(Map<String,Object> parameterValuesMap)
void	setWhere(String where)

Methods inherited from class io.jmix.core.querycondition.SkippableCondition

applyDefaultSkipNullOrEmpty, isSkipNullOrEmpty, setSkipNullOrEmpty, skipNullOrEmpty

Methods inherited from class java.lang.Object

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

Field Details

PARAMETER_PATTERN

public static final Pattern PARAMETER_PATTERN

where

protected String where

join

protected String join

parameterValuesMap

protected Map<String,Object> parameterValuesMap

Constructor Details

JpqlCondition

public JpqlCondition()

Method Details

create

public static JpqlCondition create(String where,
 @Nullable
 String join)

createWithParameters

public static JpqlCondition createWithParameters(String where,
 @Nullable
 String join,
 Map<String,Object> parameterValuesMap)

getWhere

public String getWhere()

setWhere

public void setWhere(String where)

getJoin

@Nullable
public String getJoin()

setJoin

public void setJoin(@Nullable
 String join)

getParameterValuesMap

public Map<String,Object> getParameterValuesMap()

setParameterValuesMap

public void setParameterValuesMap(Map<String,Object> parameterValuesMap)

getParameters

public Collection<String> getParameters()

Description copied from interface: Condition

Returns parameters specified in the condition.

actualize

@Nullable
public Condition actualize(Set<String> actualParameters,
 boolean defaultSkipNullOrEmpty)

Description copied from interface: Condition

Checks whether the argument contains all parameters specified in the condition.

defaultSkipNullOrEmpty - default value for SkippableCondition.skipNullOrEmpty, should be obtained using CoreProperties.isSkipNullOrEmptyConditionsByDefault()

Returns:

the condition if SkippableCondition.skipNullOrEmpty is false or if actualParameters contains all parameters specified in the condition and these parameters are not null or empty. Otherwise returns null.

copy

public Condition copy()

Description copied from interface: Condition

Returns a deep copy of this condition.

getExcludedParameters

public Set<String> getExcludedParameters(Set<String> actualParameters)

Description copied from interface: Condition

Returns names of parameters that are not present in the given actualParameters but have null or empty value.

For SkippableCondition, empty parameters are not included in the result if SkippableCondition.skipNullOrEmpty() is false.

parseParameters

protected void parseParameters(String value)

removeParameters

protected void removeParameters(String value)