Module is.codion.framework.model

Package is.codion.framework.model

Class AbstractForeignKeyConditionModel

java.lang.Object

is.codion.framework.model.AbstractForeignKeyConditionModel

All Implemented Interfaces:

ColumnConditionModel<ForeignKey,Entity>

Direct Known Subclasses:

EntityComboBoxConditionModel, EntitySearchConditionModel

public abstract class AbstractForeignKeyConditionModel
extends Object
implements ColumnConditionModel<ForeignKey,Entity>

An abstract base class for ForeignKey based ColumnConditionModels.

Nested Class Summary

Nested classes/interfaces inherited from interface is.codion.common.model.table.ColumnConditionModel

ColumnConditionModel.AutomaticWildcard, ColumnConditionModel.Builder<C,T>, ColumnConditionModel.Factory<C>

Field Summary

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

AUTOMATIC_WILDCARD, CASE_SENSITIVE

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	AbstractForeignKeyConditionModel(ForeignKey foreignKey)

Method Summary

Modifier and Type	Method	Description
final boolean	accepts(Comparable<Entity> columnValue)	Returns true if the given value is accepted by this models condition.
final void	addChangeListener(Runnable listener)
final State	autoEnable()
final 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
final State	caseSensitive()
final void	clear()	Disables and clears this condition model, that is, sets the upper and lower bounds to null and the operator to the default value Operator.EQUAL
final Class<Entity>	columnClass()
final ForeignKey	columnIdentifier()
final String	dateTimePattern()
final State	enabled()
final ValueSet<Entity>	equalValues()
final Format	format()
final Entity	getEqualValue()
final Collection<Entity>	getEqualValues()
final Entity	getLowerBound()
final Entity	getUpperBound()
final State	locked()
final Value<Entity>	lowerBoundValue()
final Value<Operator>	operator()
final List<Operator>	operators()
final void	removeChangeListener(Runnable listener)
final void	setEqualValue(Entity value)	Sets the values used when the Operator.EQUAL is enabled.
final void	setEqualValues(Collection<Entity> values)
final void	setLowerBound(Entity value)
final void	setUpperBound(Entity value)
final Value<Entity>	upperBoundValue()
final char	wildcard()

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractForeignKeyConditionModel

protected AbstractForeignKeyConditionModel(ForeignKey foreignKey)

Method Details

columnIdentifier

public final ForeignKey columnIdentifier()

Specified by:

columnIdentifier in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the column identifier

caseSensitive

public final State caseSensitive()

Specified by:

caseSensitive in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

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

format

public final Format format()

Specified by:

format in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the Format object to use when formatting input, if any

dateTimePattern

public final String dateTimePattern()

Specified by:

dateTimePattern in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the date/time format pattern, if any

locked

public final State locked()

Specified by:

locked in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the state controlling the locked status

columnClass

public final Class<Entity> columnClass()

Specified by:

columnClass in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the column class this condition model is based on

setEqualValue

public final 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<ForeignKey,Entity>

Parameters:

value - the value to use as condition

getEqualValue

public final Entity getEqualValue()

Specified by:

getEqualValue in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the equal value, possibly null

setEqualValues

public final void setEqualValues(Collection<Entity> values)

Specified by:

setEqualValues in interface ColumnConditionModel<ForeignKey,Entity>

Parameters:

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

getEqualValues

public final Collection<Entity> getEqualValues()

Specified by:

getEqualValues in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the equal values, never null

setUpperBound

public final void setUpperBound(Entity value)

Specified by:

setUpperBound in interface ColumnConditionModel<ForeignKey,Entity>

Parameters:

value - the new upper bound

getUpperBound

public final Entity getUpperBound()

Specified by:

getUpperBound in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the upper bound

setLowerBound

public final void setLowerBound(Entity value)

Specified by:

setLowerBound in interface ColumnConditionModel<ForeignKey,Entity>

Parameters:

value - the lower bound

getLowerBound

public final Entity getLowerBound()

Specified by:

getLowerBound in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the lower bound

operator

public final Value<Operator> operator()

Specified by:

operator in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

a Value based on the operator

operators

public final List<Operator> operators()

Specified by:

operators in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the operators available in this condition model

wildcard

public final char wildcard()

Specified by:

wildcard in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

the character used as a wildcard when working with strings

enabled

public final State enabled()

Specified by:

enabled in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

a state controlling the enabled status

automaticWildcard

public final 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<ForeignKey,Entity>

Returns:

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

autoEnable

public final State autoEnable()

Specified by:

autoEnable in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

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

clear

public final void clear()

Description copied from interface: ColumnConditionModel

Disables and clears this condition model, that is, sets the upper and lower bounds to null and the operator to the default value Operator.EQUAL

Specified by:

clear in interface ColumnConditionModel<ForeignKey,Entity>

accepts

public final 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<ForeignKey,Entity>

Parameters:

columnValue - the column value

Returns:

true if the given value is accepted by this models condition

equalValues

public final ValueSet<Entity> equalValues()

Specified by:

equalValues in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

a ValueSet based on the equals values of this condition model

lowerBoundValue

public final Value<Entity> lowerBoundValue()

Specified by:

lowerBoundValue in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

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

upperBoundValue

public final Value<Entity> upperBoundValue()

Specified by:

upperBoundValue in interface ColumnConditionModel<ForeignKey,Entity>

Returns:

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

addChangeListener

public final void addChangeListener(Runnable listener)

Specified by:

addChangeListener in interface ColumnConditionModel<ForeignKey,Entity>

Parameters:

listener - a listener to be notified each time the condition state changes

removeChangeListener

public final void removeChangeListener(Runnable listener)

Specified by:

removeChangeListener in interface ColumnConditionModel<ForeignKey,Entity>

Parameters:

listener - the listener to remove