ColumnConditionModel (Codion Framework API 0.17.16)

Type Parameters:

C - the type used to identify columns

T - the column value type

All Known Implementing Classes:

AbstractForeignKeyConditionModel, EntityComboBoxModelConditionModel, EntityListConditionModel, EntitySearchModelConditionModel
```
public interface ColumnConditionModel<C,T>
```
Specifies a condition model based on a table column, parameters, operator, upper bound and lower bound, as well as relevant events and states. For instances create a ColumnConditionModel.Builder via builder(Object, Class).

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`ColumnConditionModel.AutomaticWildcard` The possible automatic wildcard types
`static interface`	`ColumnConditionModel.Builder<C,T>` Builds a `ColumnConditionModel` instance.

Field Summary

Fields
Modifier and Type	Field and Description
`static PropertyValue<ColumnConditionModel.AutomaticWildcard>`	`AUTOMATIC_WILDCARD` Specifies whether wildcards are automatically added to string conditions by default Value type: `ColumnConditionModel.AutomaticWildcard` Default value: `ColumnConditionModel.AutomaticWildcard.NONE`
`static PropertyValue<Boolean>`	`CASE_SENSITIVE` Specifies whether string based conditions are case-sensitive or not by default Value type: Boolean Default value: true

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`boolean`	`accepts(Comparable<T> columnValue)` Returns true if this model is enabled and the given value is accepted by this models condition.
`void`	`addClearedListener(EventListener listener)`
`void`	`addConditionChangedListener(EventListener listener)`
`void`	`addEnabledListener(EventListener listener)`
`void`	`addEqualsValueListener(EventListener listener)`
`void`	`addLowerBoundListener(EventListener listener)`
`void`	`addOperatorListener(EventDataListener<Operator> listener)`
`void`	`addUpperBoundListener(EventListener listener)`
`State`	`autoEnableState()`
`Value<ColumnConditionModel.AutomaticWildcard>`	`automaticWildcardValue()` Note that this is only applicable to string based condition models and only used for operators `Operator.EQUAL` and `Operator.NOT_EQUAL`
`static <C,T> ColumnConditionModel.Builder<C,T>`	`builder(C columnIdentifier, Class<T> columnClass)` Returns a new `ColumnConditionModel.Builder` instance.
`static String`	`caption(Operator operator)`
`State`	`caseSensitiveState()`
`void`	`clearCondition()` 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`
`Class<T>`	`columnClass()`
`C`	`columnIdentifier()`
`String`	`dateTimePattern()`
`State`	`enabledState()`
`ValueSet<T>`	`equalValueSet()`
`Format`	`format()`
`T`	`getEqualValue()`
`Collection<T>`	`getEqualValues()`
`T`	`getLowerBound()`
`Operator`	`getOperator()`
`T`	`getUpperBound()`
`boolean`	`isEnabled()`
`boolean`	`isLocked()`
`StateObserver`	`lockedObserver()`
`Value<T>`	`lowerBoundValue()`
`List<Operator>`	`operators()`
`Value<Operator>`	`operatorValue()`
`void`	`removeClearedListener(EventListener listener)`
`void`	`removeConditionChangedListener(EventListener listener)`
`void`	`removeEnabledListener(EventListener listener)`
`void`	`removeEqualsValueListener(EventListener listener)`
`void`	`removeLowerBoundListener(EventListener listener)`
`void`	`removeOperatorListener(EventDataListener<Operator> listener)`
`void`	`removeUpperBoundListener(EventListener listener)`
`void`	`setEnabled(boolean enabled)`
`void`	`setEqualValue(T value)` Sets the values used when the `Operator.EQUAL` is enabled.
`void`	`setEqualValues(Collection<T> values)`
`void`	`setLocked(boolean locked)`
`void`	`setLowerBound(T value)`
`void`	`setOperator(Operator operator)`
`void`	`setUpperBound(T upper)`
`Value<T>`	`upperBoundValue()`
`char`	`wildcard()`

- Field Detail
  - AUTOMATIC_WILDCARD
```
static final PropertyValue<ColumnConditionModel.AutomaticWildcard> AUTOMATIC_WILDCARD
```
    Specifies whether wildcards are automatically added to string conditions by default
    Value type: ColumnConditionModel.AutomaticWildcard
    Default value: ColumnConditionModel.AutomaticWildcard.NONE
  - CASE_SENSITIVE
```
static final PropertyValue<Boolean> CASE_SENSITIVE
```
    Specifies whether string based conditions are case-sensitive or not by default
    Value type: Boolean
    Default value: true
- Method Detail
  - columnIdentifier
```
C columnIdentifier()
```
    Returns:
    
    the column identifier
  - caseSensitiveState
```
State caseSensitiveState()
```
    Returns:
    
    the State controlling whether this model is case-sensitive, when working with strings
  - format
```
Format format()
```
    Returns:
    
    the Format object to use when formatting input, if any
  - dateTimePattern
```
String dateTimePattern()
```
    Returns:
    
    the date/time format pattern, if any
  - automaticWildcardValue
```
Value<ColumnConditionModel.AutomaticWildcard> automaticWildcardValue()
```
    Note that this is only applicable to string based condition models and only used for operators Operator.EQUAL and Operator.NOT_EQUAL
    
    Returns:
    
    the Value controlling whether automatic wildcards are enabled when working with strings
  - autoEnableState
```
State autoEnableState()
```
    Returns:
    
    the State controlling whether this model is enabled automatically when a condition value is specified
  - setLocked
```
void setLocked(boolean locked)
```
    Parameters:
    
    locked - true to lock this model, false to unlock
  - isLocked
```
boolean isLocked()
```
    Returns:
    
    true if this model is locked
  - columnClass
```
Class<T> columnClass()
```
    Returns:
    
    the column class this condition model is based on
  - setEqualValue
```
void setEqualValue(T value)
```
    Sets the values used when the Operator.EQUAL is enabled.
    
    Parameters:
    
    value - the value to use as condition
  - getEqualValue
```
T getEqualValue()
```
    Returns:
    
    the equal value, possibly null
  - setEqualValues
```
void setEqualValues(Collection<T> values)
```
    Parameters:
    
    values - the values to set
  - getEqualValues
```
Collection<T> getEqualValues()
```
    Returns:
    
    the equal values, never null
  - setUpperBound
```
void setUpperBound(T upper)
```
    Parameters:
    
    upper - the new upper bound
  - getUpperBound
```
T getUpperBound()
```
    Returns:
    
    the upper bound
  - setLowerBound
```
void setLowerBound(T value)
```
    Parameters:
    
    value - the lower bound
  - getLowerBound
```
T getLowerBound()
```
    Returns:
    
    the lower bound
  - getOperator
```
Operator getOperator()
```
    Returns:
    
    the search operator
  - setOperator
```
void setOperator(Operator operator)
```
    Parameters:
    
    operator - the conditional operator
    
    Throws:
    
    IllegalArgumentException - in case the given operator is not available in this condition model
  - operators
```
List<Operator> operators()
```
    Returns:
    
    the operators available in this condition model
  - wildcard
```
char wildcard()
```
    Returns:
    
    the character used as a wildcard when working with strings
  - isEnabled
```
boolean isEnabled()
```
    Returns:
    
    true if this condition model is enabled
  - setEnabled
```
void setEnabled(boolean enabled)
```
    Parameters:
    
    enabled - true to enable, false to disable
  - clearCondition
```
void clearCondition()
```
    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
  - equalValueSet
```
ValueSet<T> equalValueSet()
```
    Returns:
    
    a ValueSet based on the equals values of this condition model
  - upperBoundValue
```
Value<T> upperBoundValue()
```
    Returns:
    
    a Value based on the upper bound value of this condition model
  - lowerBoundValue
```
Value<T> lowerBoundValue()
```
    Returns:
    
    a Value based on the lower bound value of this condition model
  - lockedObserver
```
StateObserver lockedObserver()
```
    Returns:
    
    an observer for this model's locked state
  - enabledState
```
State enabledState()
```
    Returns:
    
    a State controlling the enabled state
  - operatorValue
```
Value<Operator> operatorValue()
```
    Returns:
    
    a Value based on the operator
  - accepts
```
boolean accepts(Comparable<T> columnValue)
```
    Returns true if this model is enabled and the given value is accepted by this models condition.
    
    Parameters:
    
    columnValue - the column value
    
    Returns:
    
    true if this model is enabled and the given value is accepted by this models condition
  - addEnabledListener
```
void addEnabledListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to be notified each time the enabled state changes
  - removeEnabledListener
```
void removeEnabledListener(EventListener listener)
```
    Parameters:
    
    listener - the listener to remove
  - addOperatorListener
```
void addOperatorListener(EventDataListener<Operator> listener)
```
    Parameters:
    
    listener - a listener to be notified each time the operator changes
  - removeOperatorListener
```
void removeOperatorListener(EventDataListener<Operator> listener)
```
    Parameters:
    
    listener - the listener to remove
  - addEqualsValueListener
```
void addEqualsValueListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to be notified each time the lower bound changes
  - removeEqualsValueListener
```
void removeEqualsValueListener(EventListener listener)
```
    Parameters:
    
    listener - the listener to remove
  - addLowerBoundListener
```
void addLowerBoundListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to be notified each time the lower bound changes
  - removeLowerBoundListener
```
void removeLowerBoundListener(EventListener listener)
```
    Parameters:
    
    listener - the listener to remove
  - addUpperBoundListener
```
void addUpperBoundListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to be notified each time the upper bound changes
  - removeUpperBoundListener
```
void removeUpperBoundListener(EventListener listener)
```
    Parameters:
    
    listener - the listener to remove
  - addClearedListener
```
void addClearedListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to be notified each time the model is cleared
  - removeClearedListener
```
void removeClearedListener(EventListener listener)
```
    Parameters:
    
    listener - the listener to remove
  - addConditionChangedListener
```
void addConditionChangedListener(EventListener listener)
```
    Parameters:
    
    listener - a listener to be notified each time the condition state changes
  - removeConditionChangedListener
```
void removeConditionChangedListener(EventListener listener)
```
    Parameters:
    
    listener - the listener to remove
  - builder
```
static <C,T> ColumnConditionModel.Builder<C,T> builder(C columnIdentifier,
                                                       Class<T> columnClass)
```
    Returns a new ColumnConditionModel.Builder instance.
    
    Type Parameters:
    
    C - the column identifier type
    
    T - the column value type
    
    Parameters:
    
    columnIdentifier - the column identifier
    
    columnClass - the column class
    
    Returns:
    
    a new ColumnConditionModel.Builder instance
  - caption
```
static String caption(Operator operator)
```
    Parameters:
    
    operator - the operator
    
    Returns:
    
    a caption for the given operator

Interface ColumnConditionModel<C,T>

Nested Class Summary

Field Summary

Method Summary

Field Detail

AUTOMATIC_WILDCARD

CASE_SENSITIVE

Method Detail

columnIdentifier

caseSensitiveState

format

dateTimePattern

automaticWildcardValue

autoEnableState

setLocked

isLocked

columnClass

setEqualValue

getEqualValue

setEqualValues

getEqualValues

setUpperBound

getUpperBound

setLowerBound

getLowerBound

getOperator

setOperator

operators

wildcard

isEnabled

setEnabled

clearCondition

equalValueSet

upperBoundValue

lowerBoundValue

lockedObserver

enabledState

operatorValue

accepts

addEnabledListener

removeEnabledListener

addOperatorListener

removeOperatorListener

addEqualsValueListener

removeEqualsValueListener

addLowerBoundListener

removeLowerBoundListener

addUpperBoundListener

removeUpperBoundListener

addClearedListener

removeClearedListener

addConditionChangedListener

removeConditionChangedListener

builder

caption