Module is.codion.framework.model

Package is.codion.framework.model

Class EntityConditions

java.lang.Object

is.codion.framework.model.EntityConditions

All Implemented Interfaces:

Supplier<Map<Attribute<?>,ConditionModel<?>>>

Direct Known Subclasses:

SwingEntityConditions

public class EntityConditions
extends Object
implements Supplier<Map<Attribute<?>,ConditionModel<?>>>

A default ConditionModel factory for Entity based condition models.

Extend and override the protected hooks to customize which conditions are created and how: include(Column)/include(ForeignKey) to control which attributes get a condition model, condition(Column)/condition(ForeignKey) to customize the created models, and createEqualSearchModel(ForeignKey)/createInSearchModel(ForeignKey) to customize the foreign key search models.

Constructor Summary

Constructors

Constructor	Description
EntityConditions(EntityType entityType, EntityConnectionProvider connectionProvider)	Instantiates a new EntityConditions.

Method Summary

Modifier and Type	Method	Description
protected <T> ColumnConditionModel<T>	condition(Column<T> column)	Only called if include(Column) returns true
protected ForeignKeyConditionModel	condition(ForeignKey foreignKey)	Only called if include(ForeignKey) returns true
protected final EntityConnectionProvider	connectionProvider()
protected EntitySearchModel	createEqualSearchModel(ForeignKey foreignKey)
protected EntitySearchModel	createInSearchModel(ForeignKey foreignKey)
protected final EntityDefinition	definition()
protected final EntityDefinition	definition(EntityType entityType)
final Map<Attribute<?>,ConditionModel<?>>	get()
protected boolean	include(Column<?> column)
protected boolean	include(ForeignKey foreignKey)

Methods inherited from class java.lang.Object

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

Constructor Details

EntityConditions

public EntityConditions(EntityType entityType,
 EntityConnectionProvider connectionProvider)

Instantiates a new EntityConditions.

Parameters:

entityType - the entity type

connectionProvider - the connection provider

Method Details

get

public final Map<Attribute<?>,ConditionModel<?>> get()

Specified by:

get in interface Supplier<Map<Attribute<?>,ConditionModel<?>>>

include

protected boolean include(Column<?> column)

Parameters:

column - the column

Returns:

true if a condition model should be included for the given column

include

protected boolean include(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key

Returns:

true if a condition model should be included for the given foreign key

condition

protected <T> ColumnConditionModel<T> condition(Column<T> column)

Only called if include(Column) returns true

Type Parameters:

T - the column type

Parameters:

column - the column

Returns:

a ColumnConditionModel based on the given column

condition

protected ForeignKeyConditionModel condition(ForeignKey foreignKey)

Only called if include(ForeignKey) returns true

Parameters:

foreignKey - the foreign key

Returns:

a ForeignKeyConditionModel based on the given foreign key

createEqualSearchModel

protected EntitySearchModel createEqualSearchModel(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key

Returns:

a search model to use for the equal value

createInSearchModel

protected EntitySearchModel createInSearchModel(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key

Returns:

a search model to use for the in values

connectionProvider

protected final EntityConnectionProvider connectionProvider()

Returns:

the underlying connection provider

definition

protected final EntityDefinition definition()

Returns:

the underlying EntityDefinition

definition

protected final EntityDefinition definition(EntityType entityType)

Parameters:

entityType - the entity type

Returns:

the definition of the given type