Module is.codion.framework.model

Package is.codion.framework.model

Class ForeignKeyConditionModel

java.lang.Object

is.codion.framework.model.ForeignKeyConditionModel

All Implemented Interfaces:

ColumnConditionModel<Attribute<?>,Entity>

public final class ForeignKeyConditionModel
extends Object
implements ColumnConditionModel<Attribute<?>,Entity>

A default foreign key condition model using EntitySearchModel for both the equalValue() and inValues().

See Also:

• builder(ForeignKey)

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.table.ColumnConditionModel

ColumnConditionModel.AutomaticWildcard, ColumnConditionModel.Factory<C>

Field Summary

Fields inherited from interface is.codion.common.model.table.ColumnConditionModel

AUTOMATIC_WILDCARD, CASE_SENSITIVE

Method Summary

Modifier and Type	Method	Description
boolean	accepts(Comparable<Entity> columnValue)	Returns true if the given value is accepted by this models condition.
State	autoEnable()
Value<ColumnConditionModel.AutomaticWildcard>	automaticWildcard()	Note that this is only applicable to string based condition models and only used for operators Operator.EQUAL and Operator.NOT_EQUAL
static ForeignKeyConditionModel.Builder	builder(ForeignKey foreignKey)
State	caseSensitive()
void	clear()	Clears this condition model, that is, sets all bounds to null and the operator to the first of the ones available.
Class<Entity>	columnClass()
Attribute<?>	columnIdentifier()
EventObserver<?>	conditionChangedEvent()
String	dateTimePattern()
State	enabled()
EntitySearchModel	equalSearchModel()
Value<Entity>	equalValue()
Format	format()
Entity	getEqualValue()
Collection<Entity>	getInValues()
Entity	getLowerBound()
Entity	getUpperBound()
EntitySearchModel	inSearchModel()
ValueSet<Entity>	inValues()
State	locked()
Value<Entity>	lowerBoundValue()
Value<Operator>	operator()
List<Operator>	operators()
void	setEqualValue(Entity value)	Sets the values used when the Operator.EQUAL is enabled.
void	setInValues(Collection<Entity> values)
void	setLowerBound(Entity value)
void	setUpperBound(Entity upper)
Value<Entity>	upperBoundValue()
char	wildcard()

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

columnIdentifier

public Attribute<?> columnIdentifier()

Specified by:

columnIdentifier in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the column identifier

caseSensitive

public State caseSensitive()

Specified by:

caseSensitive in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

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

format

public Format format()

Specified by:

format in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the Format object to use when formatting input, if any

dateTimePattern

public String dateTimePattern()

Specified by:

dateTimePattern in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the date/time format pattern, if any

automaticWildcard

public Value<ColumnConditionModel.AutomaticWildcard> automaticWildcard()

Description copied from interface: ColumnConditionModel

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

Specified by:

automaticWildcard in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the Value controlling whether automatic wildcards are enabled when working with strings

autoEnable

public State autoEnable()

Specified by:

autoEnable in interface ColumnConditionModel<Attribute<?>,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 ColumnConditionModel<Attribute<?>,Entity>

Returns:

the state controlling the locked status

columnClass

public Class<Entity> columnClass()

Specified by:

columnClass in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the column class this condition model is based on

setEqualValue

public void setEqualValue(Entity value)

Description copied from interface: ColumnConditionModel

Sets the values used when the Operator.EQUAL is enabled.

Specified by:

setEqualValue in interface ColumnConditionModel<Attribute<?>,Entity>

Parameters:

value - the value to use as condition

getEqualValue

public Entity getEqualValue()

Specified by:

getEqualValue in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the equal value, possibly null

setInValues

public void setInValues(Collection<Entity> values)

Specified by:

setInValues in interface ColumnConditionModel<Attribute<?>,Entity>

Parameters:

values - the values to set, an empty Collection for none

getInValues

public Collection<Entity> getInValues()

Specified by:

getInValues in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the in values, never null

setUpperBound

public void setUpperBound(Entity upper)

Specified by:

setUpperBound in interface ColumnConditionModel<Attribute<?>,Entity>

Parameters:

upper - the new upper bound

getUpperBound

public Entity getUpperBound()

Specified by:

getUpperBound in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the upper bound

setLowerBound

public void setLowerBound(Entity value)

Specified by:

setLowerBound in interface ColumnConditionModel<Attribute<?>,Entity>

Parameters:

value - the lower bound

getLowerBound

public Entity getLowerBound()

Specified by:

getLowerBound in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the lower bound

operators

public List<Operator> operators()

Specified by:

operators in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the operators available in this condition model

wildcard

public char wildcard()

Specified by:

wildcard in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

the character used as a wildcard when working with strings

enabled

public State enabled()

Specified by:

enabled in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

a state controlling the enabled status

clear

public void clear()

Description copied from interface: ColumnConditionModel

Clears this condition model, that is, sets all bounds to null and the operator to the first of the ones available.

Specified by:

clear in interface ColumnConditionModel<Attribute<?>,Entity>

See Also:

• ColumnConditionModel.autoEnable()
• ColumnConditionModel.operators()

equalValue

public Value<Entity> equalValue()

Specified by:

equalValue in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

a Value based on the equal value of this condition model

inValues

public ValueSet<Entity> inValues()

Specified by:

inValues in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

a ValueSet based on the in values of this condition model

upperBoundValue

public Value<Entity> upperBoundValue()

Specified by:

upperBoundValue in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

a Value based on the upper bound value of this condition model

lowerBoundValue

public Value<Entity> lowerBoundValue()

Specified by:

lowerBoundValue in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

a Value based on the lower bound value of this condition model

operator

public Value<Operator> operator()

Specified by:

operator in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

a Value based on the operator

accepts

public boolean accepts(Comparable<Entity> columnValue)

Description copied from interface: ColumnConditionModel

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

Specified by:

accepts in interface ColumnConditionModel<Attribute<?>,Entity>

Parameters:

columnValue - the column value

Returns:

true if the given value is accepted by this models condition

conditionChangedEvent

public EventObserver<?> conditionChangedEvent()

Specified by:

conditionChangedEvent in interface ColumnConditionModel<Attribute<?>,Entity>

Returns:

an observer notified each time the condition state changes

builder

public static ForeignKeyConditionModel.Builder builder(ForeignKey foreignKey)

Parameters:

foreignKey - the foreign key

Returns:

a new ForeignKeyConditionModel.Builder