Module is.codion.framework.model

Package is.codion.framework.model

Class ForeignKeyConditionModel

java.lang.Object

is.codion.framework.model.ForeignKeyConditionModel

All Implemented Interfaces:

ConditionModel<Entity>

public final class ForeignKeyConditionModel
extends Object
implements ConditionModel<Entity>

A default foreign key condition model using EntitySearchModel for both the Operator.EQUAL and Operator.IN operands.

See Also:

• builder()

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static interface	ForeignKeyConditionModel.Builder	A builder for a ForeignKeyConditionModel

Nested classes/interfaces inherited from interface is.codion.common.model.condition.ConditionModel

ConditionModel.Operands<T>, ConditionModel.Wildcard

Field Summary

Fields inherited from interface is.codion.common.model.condition.ConditionModel

CASE_SENSITIVE, WILDCARD

Method Summary

Modifier and Type	Method	Description
boolean	accepts(Comparable<Entity> value)	Returns true if the given value is accepted by this models condition.
State	autoEnable()
static ForeignKeyConditionModel.Builder	builder()
State	caseSensitive()
Observer<?>	changed()
void	clear()	Clears this condition model, that is, clears all operands and sets the operator to the initial one.
String	dateTimePattern()
State	enabled()
EntitySearchModel	equalSearchModel()
Optional<Format>	format()
EntitySearchModel	inSearchModel()
State	locked()
ConditionModel.Operands<Entity>	operands()
Value<Operator>	operator()
List<Operator>	operators()
Class<Entity>	valueClass()
Mutable<ConditionModel.Wildcard>	wildcard()	Note that this is only applicable to string based condition models and only used for operators Operator.EQUAL and Operator.NOT_EQUAL

Methods inherited from class java.lang.Object

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

Method Details

equalSearchModel

public EntitySearchModel equalSearchModel()

Returns:

the combo box model controlling the equal value

Throws:

IllegalStateException - in case no such model is available

inSearchModel

public EntitySearchModel inSearchModel()

Returns:

the search model controlling the in values

Throws:

IllegalStateException - in case no such model is available

caseSensitive

public State caseSensitive()

Specified by:

caseSensitive in interface ConditionModel<Entity>

Returns:

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

format

public Optional<Format> format()

Specified by:

format in interface ConditionModel<Entity>

Returns:

the Format object to use when formatting input, an empty Optional in case none is available

dateTimePattern

public String dateTimePattern()

Specified by:

dateTimePattern in interface ConditionModel<Entity>

Returns:

the date/time format pattern, if any

wildcard

public Mutable<ConditionModel.Wildcard> wildcard()

Description copied from interface: ConditionModel

Note that this is only applicable to string based condition models and only used for operators Operator.EQUAL and Operator.NOT_EQUAL

Specified by:

wildcard in interface ConditionModel<Entity>

Returns:

the Mutable controlling whether wildcards are added to strings

autoEnable

public State autoEnable()

Specified by:

autoEnable in interface ConditionModel<Entity>

Returns:

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

locked

public State locked()

Specified by:

locked in interface ConditionModel<Entity>

Returns:

the State controlling the locked status

valueClass

public Class<Entity> valueClass()

Specified by:

valueClass in interface ConditionModel<Entity>

Returns:

the value class this condition model is based on

operators

public List<Operator> operators()

Specified by:

operators in interface ConditionModel<Entity>

Returns:

the operators available in this condition model

enabled

public State enabled()

Specified by:

enabled in interface ConditionModel<Entity>

Returns:

a state controlling the enabled status

clear

public void clear()

Description copied from interface: ConditionModel

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

Specified by:

clear in interface ConditionModel<Entity>

See Also:

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

operator

public Value<Operator> operator()

Specified by:

operator in interface ConditionModel<Entity>

Returns:

a Value controlling on the operator

operands

public ConditionModel.Operands<Entity> operands()

Specified by:

operands in interface ConditionModel<Entity>

Returns:

the operands

accepts

public boolean accepts(Comparable<Entity> value)

Description copied from interface: ConditionModel

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

Specified by:

accepts in interface ConditionModel<Entity>

Parameters:

value - the value

Returns:

true if the given value is accepted by this models condition

changed

public Observer<?> changed()

Specified by:

changed in interface ConditionModel<Entity>

Returns:

an observer notified each time the condition changes

builder

public static ForeignKeyConditionModel.Builder builder()

Returns:

a new ForeignKeyConditionModel.Builder