Package io.jmix.core.querycondition

Class LogicalCondition

java.lang.Object

io.jmix.core.querycondition.LogicalCondition

All Implemented Interfaces:

Condition, Serializable

public class LogicalCondition
extends Object
implements Condition

Logical condition (AND, OR) which contains other conditions.

getParameters() returns parameters of nested conditions.

Use and(Condition...) and or(Condition...) static methods to create logical conditions.

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LogicalCondition.Type

Constructor Summary

Constructors

Constructor	Description
LogicalCondition(LogicalCondition.Type type)

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.
LogicalCondition	add(Condition condition)
static LogicalCondition	and()	Creates empty AND condition.
static LogicalCondition	and(Condition... conditions)	Creates AND condition with the given nested conditions.
Condition	copy()	Returns a deep copy of this condition.
List<Condition>	getConditions()
Set<String>	getExcludedParameters(Set<String> actualParameters)	Returns names of parameters that are not present in the given actualParameters but have null or empty value.
Collection<String>	getParameters()	Returns parameters specified in the condition.
LogicalCondition.Type	getType()
static LogicalCondition	or()	Creates empty OR condition.
static LogicalCondition	or(Condition... conditions)	Creates OR condition with the given nested conditions.
void	setConditions(List<Condition> conditions)
void	setType(LogicalCondition.Type type)
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Details

LogicalCondition

public LogicalCondition(LogicalCondition.Type type)

Method Details

and

public static LogicalCondition and()

Creates empty AND condition. Use add(Condition) method to add nested conditions.

and

public static LogicalCondition and(Condition... conditions)

Creates AND condition with the given nested conditions.

or

public static LogicalCondition or()

Creates empty OR condition. Use add(Condition) method to add nested conditions.

or

public static LogicalCondition or(Condition... conditions)

Creates OR condition with the given nested conditions.

getType

public LogicalCondition.Type getType()

setType

public void setType(LogicalCondition.Type type)

getConditions

public List<Condition> getConditions()

setConditions

public void setConditions(List<Condition> conditions)

add

public LogicalCondition add(Condition condition)

getParameters

public Collection<String> getParameters()

Description copied from interface: Condition

Returns parameters specified in the condition.

Specified by:

getParameters in interface 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.

Specified by:

actualize in interface 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.

Specified by:

copy in interface 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.

Specified by:

getExcludedParameters in interface Condition

toString

public String toString()

Overrides:

toString in class Object