Module is.codion.framework.domain

Package is.codion.framework.domain.entity.condition

Interface Condition

All Known Subinterfaces:

ColumnCondition<T>, Condition.All, Condition.Combination, CustomCondition, ForeignKeyCondition

All Known Implementing Classes:

AbstractCondition

public interface Condition

Specifies a query condition.

See Also:

• all(EntityType)
• key(Entity.Key)
• keys(Collection)
• and(Condition...)
• and(Collection)
• or(Condition...)
• or(Collection)
• combination(Conjunction, Condition...)
• combination(Conjunction, Condition...)
• customCondition(ConditionType)
• customCondition(ConditionType, List, List)

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Condition.All	A condition specifying all entities of a given type, a no-condition.
static interface	Condition.Combination	An interface encapsulating a combination of Condition instances, that should be either AND'ed or OR'ed together in a query context

Method Summary

Modifier and Type	Method	Description
static Condition	all(EntityType entityType)
static Condition.Combination	and(Condition... conditions)	Returns a new Condition.Combination instance, combining the given condition with AND.
static Condition.Combination	and(Collection<Condition> conditions)	Returns a new Condition.Combination instance, combining the given conditions with AND.
List<Column<?>>	columns()
static Condition.Combination	combination(Conjunction conjunction, Condition... conditions)	Initializes a new Condition.Combination instance
static Condition.Combination	combination(Conjunction conjunction, Collection<Condition> conditions)	Initializes a new Condition.Combination instance
static CustomCondition	customCondition(ConditionType conditionType)	Creates a new CustomCondition based on the condition of the given type
static CustomCondition	customCondition(ConditionType conditionType, List<Column<?>> columns, List<Object> values)	Creates a new CustomCondition based on the condition of the given type
EntityType	entityType()
static Condition	key(Entity.Key key)	Creates a Condition based on the given key
static Condition	keys(Collection<Entity.Key> keys)	Creates a Condition based on the given keys.
static Condition.Combination	or(Condition... conditions)	Returns a new Condition.Combination instance, combining the given condition with OR.
static Condition.Combination	or(Collection<Condition> conditions)	Returns a new Condition.Combination instance, combining the given conditions with OR.
String	toString(EntityDefinition definition)	Returns a string representing this condition, e.g.
List<?>	values()

Method Details

entityType

EntityType entityType()

Returns:

the entity type

values

List<?> values()

Returns:

a list of the values this condition is based on, in the order they appear in the condition clause. An empty list is returned in case no values are specified.

columns

List<Column<?>> columns()

Returns:

a list of the columns this condition is based on, in the same order as their respective values appear in the condition clause. An empty list is returned in case no values are specified.

toString

String toString(EntityDefinition definition)

Returns a string representing this condition, e.g. "column = ?" or "col1 is not null and col2 in (?, ?)".

Parameters:

definition - the entity definition

Returns:

a condition string

all

static Condition all(EntityType entityType)

Parameters:

entityType - the entity type

Returns:

a Condition specifying all entities of the given type

key

static Condition key(Entity.Key key)

Creates a Condition based on the given key

Parameters:

key - the key

Returns:

a condition based on the given key

keys

static Condition keys(Collection<Entity.Key> keys)

Creates a Condition based on the given keys.

Parameters:

keys - the keys

Returns:

a condition based on the given keys

Throws:

IllegalArgumentException - in case keys is empty or if it contains keys from multiple entity types

and

static Condition.Combination and(Condition... conditions)

Returns a new Condition.Combination instance, combining the given condition with AND.

Parameters:

conditions - the conditions to combine

Returns:

a new conditions combination

and

static Condition.Combination and(Collection<Condition> conditions)

Returns a new Condition.Combination instance, combining the given conditions with AND.

Parameters:

conditions - the conditions to combine

Returns:

a new conditions combination

or

static Condition.Combination or(Condition... conditions)

Returns a new Condition.Combination instance, combining the given condition with OR.

Parameters:

conditions - the conditions to combine

Returns:

a new conditions combination

or

static Condition.Combination or(Collection<Condition> conditions)

Returns a new Condition.Combination instance, combining the given conditions with OR.

Parameters:

conditions - the conditions to combine

Returns:

a new conditions combination

combination

static Condition.Combination combination(Conjunction conjunction,
 Condition... conditions)

Initializes a new Condition.Combination instance

Parameters:

conjunction - the Conjunction to use

conditions - the conditions to combine

Returns:

a new Condition.Combination instance

Throws:

IllegalArgumentException - in case conditions is empty

combination

static Condition.Combination combination(Conjunction conjunction,
 Collection<Condition> conditions)

Initializes a new Condition.Combination instance

Parameters:

conjunction - the Conjunction to use

conditions - the conditions to combine

Returns:

a new Condition.Combination instance

Throws:

IllegalArgumentException - in case conditions is empty

customCondition

static CustomCondition customCondition(ConditionType conditionType)

Creates a new CustomCondition based on the condition of the given type

Parameters:

conditionType - the condition type

Returns:

a new CustomCondition instance

Throws:

NullPointerException - in case the condition type is null

See Also:

• EntityDefinition.Builder.conditionProvider(ConditionType, ConditionProvider)

customCondition

static CustomCondition customCondition(ConditionType conditionType,
 List<Column<?>> columns,
 List<Object> values)

Creates a new CustomCondition based on the condition of the given type

Parameters:

conditionType - the condition type

columns - the columns representing the values used by this condition, in the same order as their respective values

values - the values used by this condition string

Returns:

a new CustomCondition instance

Throws:

NullPointerException - in case any of the parameters are null

See Also:

• EntityDefinition.Builder.conditionProvider(ConditionType, ConditionProvider)