io.jmix.core.querycondition

Class PropertyCondition

java.lang.Object

io.jmix.core.querycondition.PropertyCondition

All Implemented Interfaces:

Condition, java.io.Serializable

public class PropertyCondition
extends java.lang.Object
implements Condition

Condition for filtering by entity property.

Use one of the static methods like equal(String, Object), greater(String, Object) to create property conditions.

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	PropertyCondition.Operation String constants defining comparison operations.

Constructor Summary

Constructors

Constructor and Description
PropertyCondition()

Method Summary

Modifier and Type	Method and Description
Condition	actualize(java.util.Set<java.lang.String> actualParameters) Returns the condition if the argument contains all parameters specified in the condition.
static PropertyCondition	contains(java.lang.String property, java.lang.Object value) Creates a condition that is translated to "like %value%".
PropertyCondition	copy() Returns a deep copy of this condition.
static PropertyCondition	create(java.lang.String property, java.lang.String operation, java.lang.Object value) Creates a condition to compare the property with the given value.
static PropertyCondition	createWithParameterName(java.lang.String property, java.lang.String operation, java.lang.String parameterName) Creates property condition with the specified parameter name.
static PropertyCondition	createWithValue(java.lang.String property, java.lang.String operation, java.lang.Object parameterValue) Creates a condition to compare the property with the provided value.
static PropertyCondition	endsWith(java.lang.String property, java.lang.Object value) Creates a condition that is translated to "like %value".
static PropertyCondition	equal(java.lang.String property, java.lang.Object value) Creates "=" condition.
java.util.Set<java.lang.String>	getExcludedParameters(java.util.Set<java.lang.String> actualParameters)
java.lang.String	getOperation()
java.lang.String	getParameterName()
java.util.Collection<java.lang.String>	getParameters() Returns parameters specified in the condition.
java.lang.Object	getParameterValue()
java.lang.String	getProperty()
static PropertyCondition	greater(java.lang.String property, java.lang.Object value) Creates ">" condition.
static PropertyCondition	greaterOrEqual(java.lang.String property, java.lang.Object value) Creates ">=" condition.
static PropertyCondition	inList(java.lang.String property, java.lang.Object value) Creates a condition that is translated to "in".
static PropertyCondition	isSet(java.lang.String property, java.lang.Object value) Creates a condition that is translated to "is null" or "is not null" depending on the parameter value.
static PropertyCondition	less(java.lang.String property, java.lang.Object value) Creates "<" condition.
static PropertyCondition	lessOrEqual(java.lang.String property, java.lang.Object value) Creates "<=" condition.
static PropertyCondition	notEqual(java.lang.String property, java.lang.Object value) Creates "!=" condition.
static PropertyCondition	notInList(java.lang.String property, java.lang.Object value) Creates a condition that is translated to "not in".
void	setOperation(java.lang.String operation)
void	setParameterName(java.lang.String parameterName)
void	setParameterValue(java.lang.Object parameterValue)
void	setProperty(java.lang.String property)
static PropertyCondition	startsWith(java.lang.String property, java.lang.Object value) Creates a condition that is translated to "like value%".
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

PropertyCondition

public PropertyCondition()

Method Detail

createWithParameterName

public static PropertyCondition createWithParameterName(java.lang.String property,
                                                        java.lang.String operation,
                                                        java.lang.String parameterName)

Creates property condition with the specified parameter name. The parameter value must be provided by calling setParameterValue(Object) method.

Parameters:

property - entity attribute name

operation - comparison operation, see PropertyCondition.Operation constants

parameterName - parameter name

createWithValue

public static PropertyCondition createWithValue(java.lang.String property,
                                                java.lang.String operation,
                                                java.lang.Object parameterValue)

Creates a condition to compare the property with the provided value. A parameter name is generated based on the property name.

Parameters:

property - entity attribute name

operation - comparison operation, see PropertyCondition.Operation constants.

parameterValue - value to compare with

create

public static PropertyCondition create(java.lang.String property,
                                       java.lang.String operation,
                                       java.lang.Object value)

Creates a condition to compare the property with the given value.

Parameters:

property - entity attribute name

operation - comparison operation, see constants in PropertyCondition.Operation

value - value to compare with

equal

public static PropertyCondition equal(java.lang.String property,
                                      java.lang.Object value)

Creates "=" condition.

notEqual

public static PropertyCondition notEqual(java.lang.String property,
                                         java.lang.Object value)

Creates "!=" condition.

greater

public static PropertyCondition greater(java.lang.String property,
                                        java.lang.Object value)

Creates ">" condition.

greaterOrEqual

public static PropertyCondition greaterOrEqual(java.lang.String property,
                                               java.lang.Object value)

Creates ">=" condition.

less

public static PropertyCondition less(java.lang.String property,
                                     java.lang.Object value)

Creates "<" condition.

lessOrEqual

public static PropertyCondition lessOrEqual(java.lang.String property,
                                            java.lang.Object value)

Creates "<=" condition.

contains

public static PropertyCondition contains(java.lang.String property,
                                         java.lang.Object value)

Creates a condition that is translated to "like %value%".

startsWith

public static PropertyCondition startsWith(java.lang.String property,
                                           java.lang.Object value)

Creates a condition that is translated to "like value%".

endsWith

public static PropertyCondition endsWith(java.lang.String property,
                                         java.lang.Object value)

Creates a condition that is translated to "like %value".

isSet

public static PropertyCondition isSet(java.lang.String property,
                                      java.lang.Object value)

Creates a condition that is translated to "is null" or "is not null" depending on the parameter value.

inList

public static PropertyCondition inList(java.lang.String property,
                                       java.lang.Object value)

Creates a condition that is translated to "in".

notInList

public static PropertyCondition notInList(java.lang.String property,
                                          java.lang.Object value)

Creates a condition that is translated to "not in".

getProperty

public java.lang.String getProperty()

setProperty

public void setProperty(java.lang.String property)

getOperation

public java.lang.String getOperation()

setOperation

public void setOperation(java.lang.String operation)

getParameterName

public java.lang.String getParameterName()

setParameterName

public void setParameterName(java.lang.String parameterName)

getParameterValue

@Nullable
public java.lang.Object getParameterValue()

setParameterValue

public void setParameterValue(@Nullable
                              java.lang.Object parameterValue)

getParameters

public java.util.Collection<java.lang.String> getParameters()

Description copied from interface: Condition

Returns parameters specified in the condition.

Specified by:

getParameters in interface Condition

actualize

@Nullable
public Condition actualize(java.util.Set<java.lang.String> actualParameters)

Description copied from interface: Condition

Returns the condition if the argument contains all parameters specified in the condition.

Specified by:

actualize in interface Condition

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

copy

public PropertyCondition copy()

Description copied from interface: Condition

Returns a deep copy of this condition.

Specified by:

copy in interface Condition

getExcludedParameters

public java.util.Set<java.lang.String> getExcludedParameters(java.util.Set<java.lang.String> actualParameters)

Specified by:

getExcludedParameters in interface Condition