Module is.codion.common.model

Package is.codion.common.model.condition

Interface ConditionModel<T>

Type Parameters:

T - the condition value type

All Known Subinterfaces:

AttributeConditionModel<T>, ColumnConditionModel<T>, ForeignKeyConditionModel

public interface ConditionModel<T>

Specifies a condition with an operator and operands as well as relevant events and states. For instances create a ConditionModel.Builder via builder().

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	ConditionModel.Builder<T>	Builds a ConditionModel instance.
static interface	ConditionModel.Operands<T>	Provides condition operands.
static interface	ConditionModel.SetCondition<T>	Provides a way to set the condition, each method a single change to it: changed() is notified once, when the method has set the operand, the operator and the enabled state, if the condition changed, its enabled state included, which is what the method returns.
static enum	ConditionModel.Wildcard	The possible wildcard types

Field Summary

Fields

Modifier and Type	Field	Description
static final PropertyValue<Boolean>	AUTO_ENABLE	Specifies whether conditions auto-enable by default.
static final PropertyValue<Boolean>	CASE_SENSITIVE	Specifies whether string based conditions are case-sensitive by default Value type: Boolean Default value: false
static final PropertyValue<ConditionModel.Wildcard>	WILDCARD	Specifies whether wildcards are added to string values Value type: ConditionModel.Wildcard Default value: ConditionModel.Wildcard.PREFIX_AND_POSTFIX
static final String	WILDCARD_CHARACTER	The wildcard character

Method Summary

Modifier and Type	Method	Description
boolean	accepts(@Nullable Comparable<T> value)	Returns true if the given value is accepted by this models condition.
State	autoEnable()
static ConditionModel.Builder.ValueTypeStep	builder()
Optional<String>	caption()
State	caseSensitive()
Observer<?>	changed()	Notified once per change to the condition: a set() or clear(), or an operand, the operator, enabled(), caseSensitive() or the wildcard changed on its own, along with the enabling or disabling it causes when the condition auto enables.
void	clear()	Clears this condition model, that is, disables it, clears all operands and sets the operator to the initial one.
Optional<String>	dateTimePattern()
State	enabled()
Optional<Format>	format()
State	locked()
ConditionModel.Operands<T>	operands()
Value<Operator>	operator()
List<Operator>	operators()
ConditionModel.SetCondition<T>	set()
Class<T>	type()

Field Details

WILDCARD_CHARACTER

static final String WILDCARD_CHARACTER

The wildcard character

See Also:

• Constant Field Values

WILDCARD

static final PropertyValue<ConditionModel.Wildcard> WILDCARD

Specifies whether wildcards are added to string values

• Value type: ConditionModel.Wildcard
• Default value: ConditionModel.Wildcard.PREFIX_AND_POSTFIX

See Also:

• ConditionModel.Operands.wildcard()

CASE_SENSITIVE

static final PropertyValue<Boolean> CASE_SENSITIVE

Specifies whether string based conditions are case-sensitive by default

• Value type: Boolean
• Default value: false

See Also:

• caseSensitive()

AUTO_ENABLE

static final PropertyValue<Boolean> AUTO_ENABLE

Specifies whether conditions auto-enable by default.

• Value type: Boolean
• Default value: true

See Also:

• autoEnable()

Method Details

caseSensitive

State caseSensitive()

Returns:

the State controlling whether this model is case-sensitive, when working with strings

format

Optional<Format> format()

Returns:

the Format to use when presenting a value, an empty Optional in case none is available

dateTimePattern

Optional<String> dateTimePattern()

Returns:

the date/time format pattern to use when presenting a temporal value, an empty Optional in case none is available

autoEnable

State autoEnable()

Returns:

the State controlling whether this model is enabled automatically when a condition value is specified

caption

Optional<String> caption()

Returns:

the caption associated with this condition model

locked

State locked()

Returns:

the State controlling the locked status

type

Class<T> type()

Returns:

the value type this condition model is based on

operators

List<Operator> operators()

Returns:

the operators available in this condition model

enabled

State enabled()

Returns:

a state controlling the enabled status

clear

void clear()

Clears this condition model, that is, disables it, clears all operands and sets the operator to the initial one.

See Also:

• operators()
• ConditionModel.Builder.operator(Operator)

operator

Value<Operator> operator()

Returns:

a Value controlling the operator

operands

ConditionModel.Operands<T> operands()

Returns:

the operands

set

ConditionModel.SetCondition<T> set()

Returns:

the ConditionModel.SetCondition instance

accepts

boolean accepts(@Nullable Comparable<T> value)

Returns true if the given value is accepted by this models condition.

A missing operand, a null ConditionModel.Operands.equal() or an empty ConditionModel.Operands.in(), means null: Operator.EQUAL and Operator.IN accept null alone, Operator.NOT_EQUAL and Operator.NOT_IN any value but null.

Parameters:

value - the value

Returns:

true if the given value is accepted by this models condition

changed

Observer<?> changed()

Notified once per change to the condition: a set() or clear(), or an operand, the operator, enabled(), caseSensitive() or the wildcard changed on its own, along with the enabling or disabling it causes when the condition auto enables.

Notified when the change has finished, so a listener sees the condition as set, never half set, and only when the condition differs from when it was last notified, an operand set to an equal value being no change.

Returns:

an observer notified each time the condition changes

builder

static ConditionModel.Builder.ValueTypeStep builder()

Returns:

a ConditionModel.Builder.ValueTypeStep instance