Module is.codion.framework.model

Package is.codion.framework.model

Interface EntityTableConditionModel

public interface EntityTableConditionModel

Factory for EntityTableConditionModel instances via entityTableConditionModel(EntityType, EntityConnectionProvider)

Method Summary

Modifier and Type	Method	Description
Observer<?>	changed()
void	clear()	Clears the search state of all non-persistant condition models, disables them and resets the operator to the inital one.
TableConditionModel<Attribute<?>>	conditionModel()
EntityConnectionProvider	connectionProvider()
ObservableState	enabled()
static EntityTableConditionModel	entityTableConditionModel(EntityType entityType, EntityConnectionProvider connectionProvider)	Creates a new EntityTableConditionModel
static EntityTableConditionModel	entityTableConditionModel(EntityType entityType, EntityConnectionProvider connectionProvider, Supplier<Map<Attribute<?>,ConditionModel<?>>> conditionModelFactory)	Creates a new EntityTableConditionModel
EntityType	entityType()
Map<Attribute<?>,ConditionModel<?>>	get()
<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(Conjunction conjunction)	Returns a HAVING condition based on enabled condition models which are based on aggregate function columns.
<T> Optional<ConditionModel<T>>	optional(Attribute<T> attribute)	The condition model associated with attribute
ValueSet<Attribute<?>>	persist()
Condition	where(Conjunction conjunction)	Returns a WHERE condition based on enabled condition models which are based on non-aggregate function columns.

Method Details

entityType

EntityType entityType()

Returns:

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

connectionProvider

EntityConnectionProvider connectionProvider()

Returns:

the connection provider

where

Condition where(Conjunction conjunction)

Returns a WHERE condition based on enabled condition models which are based on non-aggregate function columns.

Parameters:

conjunction - the conjunction to use in case of multiple enabled conditions

Returns:

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

having

Condition having(Conjunction conjunction)

Returns a HAVING condition based on enabled condition models which are based on aggregate function columns.

Parameters:

conjunction - the conjunction to use in case of multiple enabled conditions

Returns:

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

get

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

Returns:

an unmodifiable view of the available condition models

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

optional

<T> Optional<ConditionModel<T>> optional(Attribute<T> attribute)

The condition model associated with attribute

Type Parameters:

T - the condition value type

Parameters:

attribute - the attribute for which to retrieve the ConditionModel

Returns:

the ConditionModel for the attribute or an empty Optional in case one is not available

clear

void clear()

Clears the search state of all non-persistant condition models, disables them and resets the operator to the inital one.

See Also:

• persist()

enabled

ObservableState enabled()

Returns:

an ObservableState enabled when any of the underlying condition models are enabled

changed

Observer<?> changed()

Returns:

an observer notified each time the condition changes

persist

ValueSet<Attribute<?>> persist()

Returns:

a ValueSet controlling the identifiers of conditions which should persist when this condition model is cleared

See Also:

• clear()

conditionModel

TableConditionModel<Attribute<?>> conditionModel()

Returns:

the underlying TableConditionModel

entityTableConditionModel

static EntityTableConditionModel entityTableConditionModel(EntityType entityType,
 EntityConnectionProvider connectionProvider)

Creates a new EntityTableConditionModel

Parameters:

entityType - the underlying entity type

connectionProvider - a EntityConnectionProvider instance

Returns:

a new EntityTableConditionModel instance

entityTableConditionModel

static EntityTableConditionModel entityTableConditionModel(EntityType entityType,
 EntityConnectionProvider connectionProvider,
 Supplier<Map<Attribute<?>,ConditionModel<?>>> conditionModelFactory)

Creates a new EntityTableConditionModel

Parameters:

entityType - the underlying entity type

connectionProvider - a EntityConnectionProvider instance

conditionModelFactory - supplies the column condition models for this table condition model

Returns:

a new EntityTableConditionModel instance