Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityConditions

All Superinterfaces:

TableConditions<Attribute<?>>

public interface EntityConditions
extends TableConditions<Attribute<?>>

Manages the condition models associated with an entity's attributes, providing the combined WHERE and HAVING conditions used when querying entities. Use builder() for an instance.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	EntityConditions.AdditionalConditions	Manages the additional WHERE and HAVING conditions.
static interface	EntityConditions.Builder	Builds an EntityConditions
static interface	EntityConditions.ConditionValue	Manages an additional condition supplier.
static interface	EntityConditions.Modified	Indicates if the condition has changed since the last call to EntityConditions.Modified.reset()

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	NEGATION_INCLUDES_NULL	Specifies whether the negative operators Operator.NOT_EQUAL, Operator.NOT_IN, Operator.NOT_BETWEEN and Operator.NOT_BETWEEN_EXCLUSIVE include null values when translated to a query condition, matching exactly the rows their positive counterparts do not, the way a ConditionModel used as a filter does.

Method Summary

Modifier and Type	Method	Description
EntityConditions.AdditionalConditions	additional()
static EntityConditions.Builder.EntityTypeStep	builder()
Value<Conjunction>	conjunction()	Default Conjunction.AND
EntityConnection	connection()
EntityType	entityType()
<T> ConditionModel<T>	get(Column<T> column)	Returns the ConditionModel associated with the given column.
ForeignKeyConditionModel	get(ForeignKey foreignKey)	Returns the ConditionModel associated with the given foreignKey.
Condition	having()	Returns a HAVING condition based on enabled condition models which are based on aggregate function columns.
EntityConditions.Modified	modified()
Condition	where()	Returns a WHERE condition based on enabled condition models which are based on non-aggregate function columns.

Methods inherited from interface is.codion.common.model.condition.TableConditions

changed, clear, enabled, get, get, persist

Field Details

NEGATION_INCLUDES_NULL

static final PropertyValue<Boolean> NEGATION_INCLUDES_NULL

Specifies whether the negative operators Operator.NOT_EQUAL, Operator.NOT_IN, Operator.NOT_BETWEEN and Operator.NOT_BETWEEN_EXCLUSIVE include null values when translated to a query condition, matching exactly the rows their positive counterparts do not, the way a ConditionModel used as a filter does. If false the condition follows SQL, where no comparison to null holds, excluding rows without a value. Note that this only affects conditions based on nullable columns and foreign keys, and only the conditions created by this model, conditions created via Column and ForeignKey are always plain SQL.

• Value type: Boolean
• Default value: true

See Also:

• ColumnConditionModel.Builder.negationIncludesNull(boolean)
• ForeignKeyConditionModel.Builder.negationIncludesNull(boolean)

Method Details

entityType

EntityType entityType()

Returns:

the type of the entity this table condition model is based on

connection

EntityConnection connection()

Returns:

the connection

where

Condition where()

Returns a WHERE condition based on enabled condition models which are based on non-aggregate function columns. Uses the conjunction managed by conjunction()

Returns:

the current WHERE condition based on the state of the underlying condition models

having

Condition having()

Returns a HAVING condition based on enabled condition models which are based on aggregate function columns. Uses the conjunction managed by conjunction()

Returns:

the current HAVING condition based on the state of the underlying condition models

conjunction

Value<Conjunction> conjunction()

Default Conjunction.AND

Returns:

the Value managing the conjunction to use in case of multiple conditions

get

<T> ConditionModel<T> get(Column<T> column)

Returns the ConditionModel associated with the given column.

Type Parameters:

T - the column value type

Parameters:

column - the column for which to retrieve the ConditionModel

Returns:

the ConditionModel associated with column

Throws:

IllegalArgumentException - in case no condition model exists for the given column

get

ForeignKeyConditionModel get(ForeignKey foreignKey)

Returns the ConditionModel associated with the given foreignKey.

Parameters:

foreignKey - the foreignKey for which to retrieve the ConditionModel

Returns:

the ConditionModel associated with foreignKey

Throws:

IllegalArgumentException - in case no condition model exists for the given foreignKey

additional

EntityConditions.AdditionalConditions additional()

Returns:

the EntityConditions.AdditionalConditions instance, for managing additional conditions

modified

EntityConditions.Modified modified()

Returns:

the EntityConditions.Modified instance

See Also:

• EntityConditions.Modified.reset()

builder

static EntityConditions.Builder.EntityTypeStep builder()

Returns:

a EntityConditions.Builder.EntityTypeStep