Module is.codion.common.model

Package is.codion.common.model.condition

Interface ConditionModel<T>

Type Parameters:

T - the condition value type

All Known Subinterfaces:

ForeignKeyConditionModel, SwingForeignKeyConditionModel

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.
static enum	ConditionModel.Wildcard	The possible wildcard types

Field Summary

Fields

Modifier and Type	Field	Description
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.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.ValueClassBuilder	builder()
State	caseSensitive()
Observer<?>	changed()
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>	valueClass()

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.POSTFIX

CASE_SENSITIVE

static final PropertyValue<Boolean> CASE_SENSITIVE

Specifies whether string based conditions are case-sensitive by default

• Value type: Boolean
• Default value: false

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

locked

State locked()

Returns:

the State controlling the locked status

valueClass

Class<T> valueClass()

Returns:

the value class 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 on 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.

Parameters:

value - the value

Returns:

true if the given value is accepted by this models condition

changed

Observer<?> changed()

Returns:

an observer notified each time the condition changes

builder

static ConditionModel.Builder.ValueClassBuilder builder()

Returns:

a new ConditionModel.Builder.ValueClassBuilder instance