org.jminor.common.model.table

Class DefaultColumnConditionModel<K>

java.lang.Object

org.jminor.common.model.table.DefaultColumnConditionModel<K>

Type Parameters:

K - the type of the column identifier

All Implemented Interfaces:

ColumnConditionModel<K>

Direct Known Subclasses:

DefaultForeignKeyConditionModel, DefaultPropertyConditionModel, DefaultPropertyFilterModel

public class DefaultColumnConditionModel<K>
extends java.lang.Object
implements ColumnConditionModel<K>

A default ColumnConditionModel model implementation.

Nested Class Summary

Nested classes/interfaces inherited from interface org.jminor.common.model.table.ColumnConditionModel

ColumnConditionModel.AutomaticWildcard

Field Summary

Fields inherited from interface org.jminor.common.model.table.ColumnConditionModel

AUTOMATIC_WILDCARD, CASE_SENSITIVE

Constructor Summary

Constructors

Constructor and Description
DefaultColumnConditionModel(K columnIdentifier, java.lang.Class typeClass, java.lang.String wildcard) Instantiates a DefaultColumnConditionModel.
DefaultColumnConditionModel(K columnIdentifier, java.lang.Class typeClass, java.lang.String wildcard, java.text.Format format, java.lang.String dateTimeFormatPattern) Instantiates a DefaultColumnConditionModel.
DefaultColumnConditionModel(K columnIdentifier, java.lang.Class typeClass, java.lang.String wildcard, java.text.Format format, java.lang.String dateTimeFormatPattern, ColumnConditionModel.AutomaticWildcard automaticWildcard) Instantiates a DefaultColumnConditionModel.
DefaultColumnConditionModel(K columnIdentifier, java.lang.Class typeClass, java.lang.String wildcard, java.text.Format format, java.lang.String dateTimeFormatPattern, ColumnConditionModel.AutomaticWildcard automaticWildcard, boolean caseSensitive) Instantiates a DefaultColumnConditionModel.

Method Summary

Modifier and Type	Method and Description
void	addClearedListener(EventListener listener)
void	addConditionStateListener(EventListener listener)
void	addConditionTypeListener(EventDataListener<ConditionType> listener)
void	addEnabledListener(EventListener listener)
void	addLowerBoundListener(EventListener listener)
void	addLowerBoundRequiredListener(EventListener listener)
void	addUpperBoundListener(EventListener listener)
void	clearCondition() Disables and clears this condition model, that is, sets the upper and lower bounds to null and the condition type to the default value ConditionType.LIKE
ColumnConditionModel.AutomaticWildcard	getAutomaticWildcard()
K	getColumnIdentifier()
protected java.lang.Comparable	getComparable(java.lang.Object object)
ConditionType	getConditionType()
EventObserver<ConditionType>	getConditionTypeObserver()
java.lang.String	getDateTimeFormatPattern()
EventObserver<java.lang.Boolean>	getEnabledObserver()
java.text.Format	getFormat()
StateObserver	getLockedObserver()
java.lang.Object	getLowerBound()
Value	getLowerBoundValue()
java.lang.Class	getTypeClass()
java.lang.Object	getUpperBound()
Value	getUpperBoundValue()
java.lang.String	getWildcard()
boolean	include(java.lang.Comparable comparable)
boolean	include(java.lang.Object object)
boolean	isAutoEnable()
boolean	isCaseSensitive()
boolean	isEnabled()
boolean	isLocked()
boolean	isLowerBoundRequired()
void	removeClearedListener(EventListener listener)
void	removeConditionStateListener(EventListener listener)
void	removeConditionTypeListener(EventDataListener listener)
void	removeEnabledListener(EventListener listener)
void	removeLowerBoundListener(EventListener listener)
void	removeLowerBoundRequiredListener(EventListener listener)
void	removeUpperBoundListener(EventListener listener)
void	setAutoEnable(boolean autoEnable) If set, this model automatically enables itself when a condition is specified
void	setAutomaticWildcard(ColumnConditionModel.AutomaticWildcard automaticWildcard) Sets the automatic wildcard type.
void	setCaseSensitive(boolean caseSensitive)
void	setConditionType(ConditionType conditionType)
void	setEnabled(boolean enabled)
void	setLikeValue(java.lang.Object value) A shortcut method for setting the upper bound value, conditionType to LIKE and enabling this model in case of a non-null value.
void	setLocked(boolean value)
void	setLowerBound(java.lang.Object value)
void	setUpperBound(java.lang.Object value)
void	setWildcard(java.lang.String wildcard)

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultColumnConditionModel

public DefaultColumnConditionModel(K columnIdentifier,
                                   java.lang.Class typeClass,
                                   java.lang.String wildcard)

Instantiates a DefaultColumnConditionModel.

Parameters:

columnIdentifier - the column identifier

typeClass - the data type

wildcard - the string to use as wildcard

DefaultColumnConditionModel

public DefaultColumnConditionModel(K columnIdentifier,
                                   java.lang.Class typeClass,
                                   java.lang.String wildcard,
                                   java.text.Format format,
                                   java.lang.String dateTimeFormatPattern)

Instantiates a DefaultColumnConditionModel.

Parameters:

columnIdentifier - the column identifier

typeClass - the data type

wildcard - the string to use as wildcard

format - the format to use when presenting the values, numbers for example

dateTimeFormatPattern - the date/time format pattern to use in case of a date/time column

DefaultColumnConditionModel

public DefaultColumnConditionModel(K columnIdentifier,
                                   java.lang.Class typeClass,
                                   java.lang.String wildcard,
                                   java.text.Format format,
                                   java.lang.String dateTimeFormatPattern,
                                   ColumnConditionModel.AutomaticWildcard automaticWildcard)

Instantiates a DefaultColumnConditionModel.

Parameters:

columnIdentifier - the column identifier

typeClass - the data type

wildcard - the string to use as wildcard

format - the format to use when presenting the values, numbers for example

dateTimeFormatPattern - the date/time format pattern to use in case of a date/time column

automaticWildcard - the automatic wildcard type to use

DefaultColumnConditionModel

public DefaultColumnConditionModel(K columnIdentifier,
                                   java.lang.Class typeClass,
                                   java.lang.String wildcard,
                                   java.text.Format format,
                                   java.lang.String dateTimeFormatPattern,
                                   ColumnConditionModel.AutomaticWildcard automaticWildcard,
                                   boolean caseSensitive)

Instantiates a DefaultColumnConditionModel.

Parameters:

columnIdentifier - the column identifier

typeClass - the data type

wildcard - the string to use as wildcard

format - the format to use when presenting the values, numbers for example

dateTimeFormatPattern - the date/time format pattern to use in case of a date/time column

automaticWildcard - the automatic wildcard type to use

caseSensitive - true if string based conditions should be case sensitive

Method Detail

getColumnIdentifier

public final K getColumnIdentifier()

Specified by:

getColumnIdentifier in interface ColumnConditionModel<K>

Returns:

the column identifier

isCaseSensitive

public final boolean isCaseSensitive()

Specified by:

isCaseSensitive in interface ColumnConditionModel<K>

Returns:

true if this filter is be case sensitive

setCaseSensitive

public final void setCaseSensitive(boolean caseSensitive)

Specified by:

setCaseSensitive in interface ColumnConditionModel<K>

Parameters:

caseSensitive - true if this condition model should be case sensitive when working with strings

getFormat

public final java.text.Format getFormat()

Specified by:

getFormat in interface ColumnConditionModel<K>

Returns:

the Format object to use when formatting input, if any

getDateTimeFormatPattern

public java.lang.String getDateTimeFormatPattern()

Specified by:

getDateTimeFormatPattern in interface ColumnConditionModel<K>

Returns:

the date/time format pattern, if any

setLocked

public final void setLocked(boolean value)

Specified by:

setLocked in interface ColumnConditionModel<K>

Parameters:

value - true to lock this model, false to unlock

isLocked

public final boolean isLocked()

Specified by:

isLocked in interface ColumnConditionModel<K>

Returns:

true if this model is locked

getTypeClass

public final java.lang.Class getTypeClass()

Specified by:

getTypeClass in interface ColumnConditionModel<K>

Returns:

the data type this condition model is based on

setLikeValue

public final void setLikeValue(java.lang.Object value)

A shortcut method for setting the upper bound value, conditionType to LIKE and enabling this model in case of a non-null value.

Specified by:

setLikeValue in interface ColumnConditionModel<K>

Parameters:

value - the value to use as condition

setUpperBound

public final void setUpperBound(java.lang.Object value)

Specified by:

setUpperBound in interface ColumnConditionModel<K>

Parameters:

value - the new upper bound

getUpperBound

public final java.lang.Object getUpperBound()

Specified by:

getUpperBound in interface ColumnConditionModel<K>

Returns:

the upper bound

setLowerBound

public final void setLowerBound(java.lang.Object value)

Specified by:

setLowerBound in interface ColumnConditionModel<K>

Parameters:

value - the lower bound

getLowerBound

public final java.lang.Object getLowerBound()

Specified by:

getLowerBound in interface ColumnConditionModel<K>

Returns:

the lower bound

getConditionType

public final ConditionType getConditionType()

Specified by:

getConditionType in interface ColumnConditionModel<K>

Returns:

the search type

setConditionType

public final void setConditionType(ConditionType conditionType)

Specified by:

setConditionType in interface ColumnConditionModel<K>

Parameters:

conditionType - the search type

isLowerBoundRequired

public final boolean isLowerBoundRequired()

Specified by:

isLowerBoundRequired in interface ColumnConditionModel<K>

Returns:

true if the current search type requires a lower bound value to be specified, such as within and outside range.

getWildcard

public final java.lang.String getWildcard()

Returns:

the search wildcard

setWildcard

public final void setWildcard(java.lang.String wildcard)

Parameters:

wildcard - the search wildcard

isAutoEnable

public final boolean isAutoEnable()

Specified by:

isAutoEnable in interface ColumnConditionModel<K>

Returns:

true if auto enable is enabled

setAutoEnable

public final void setAutoEnable(boolean autoEnable)

If set, this model automatically enables itself when a condition is specified

Specified by:

setAutoEnable in interface ColumnConditionModel<K>

Parameters:

autoEnable - true to enable, false to disable

isEnabled

public final boolean isEnabled()

Specified by:

isEnabled in interface ColumnConditionModel<K>

Returns:

true if this condition model is enabled

setEnabled

public final void setEnabled(boolean enabled)

Specified by:

setEnabled in interface ColumnConditionModel<K>

Parameters:

enabled - true to enable, false to disable

setAutomaticWildcard

public final void setAutomaticWildcard(ColumnConditionModel.AutomaticWildcard automaticWildcard)

Sets the automatic wildcard type. Note that this is only applicable to string based condition models and only used for condition types ConditionType.LIKE and ConditionType.NOT_LIKE

Specified by:

setAutomaticWildcard in interface ColumnConditionModel<K>

Parameters:

automaticWildcard - the automatic wildcard type to use

getAutomaticWildcard

public final ColumnConditionModel.AutomaticWildcard getAutomaticWildcard()

Specified by:

getAutomaticWildcard in interface ColumnConditionModel<K>

Returns:

the automatic wildcard type being used by this model

clearCondition

public final void clearCondition()

Disables and clears this condition model, that is, sets the upper and lower bounds to null and the condition type to the default value ConditionType.LIKE

Specified by:

clearCondition in interface ColumnConditionModel<K>

getLockedObserver

public final StateObserver getLockedObserver()

Specified by:

getLockedObserver in interface ColumnConditionModel<K>

Returns:

an observer for this models locked state

getLowerBoundValue

public Value getLowerBoundValue()

Specified by:

getLowerBoundValue in interface ColumnConditionModel<K>

Returns:

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

getUpperBoundValue

public Value getUpperBoundValue()

Specified by:

getUpperBoundValue in interface ColumnConditionModel<K>

Returns:

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

getEnabledObserver

public final EventObserver<java.lang.Boolean> getEnabledObserver()

Specified by:

getEnabledObserver in interface ColumnConditionModel<K>

Returns:

an observer notified each time the enabled state changes

addEnabledListener

public final void addEnabledListener(EventListener listener)

Specified by:

addEnabledListener in interface ColumnConditionModel<K>

Parameters:

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

removeEnabledListener

public final void removeEnabledListener(EventListener listener)

Specified by:

removeEnabledListener in interface ColumnConditionModel<K>

Parameters:

listener - the listener to remove

addUpperBoundListener

public final void addUpperBoundListener(EventListener listener)

Specified by:

addUpperBoundListener in interface ColumnConditionModel<K>

Parameters:

listener - a listener to be notified each time the upper bound changes

removeUpperBoundListener

public final void removeUpperBoundListener(EventListener listener)

Specified by:

removeUpperBoundListener in interface ColumnConditionModel<K>

Parameters:

listener - the listener to remove

addLowerBoundListener

public final void addLowerBoundListener(EventListener listener)

Specified by:

addLowerBoundListener in interface ColumnConditionModel<K>

Parameters:

listener - a listener to be notified each time the lower bound changes

removeLowerBoundListener

public final void removeLowerBoundListener(EventListener listener)

Specified by:

removeLowerBoundListener in interface ColumnConditionModel<K>

Parameters:

listener - the listener to remove

addLowerBoundRequiredListener

public final void addLowerBoundRequiredListener(EventListener listener)

Specified by:

addLowerBoundRequiredListener in interface ColumnConditionModel<K>

Parameters:

listener - a listener to be notified each time the lower bound required attribute changes

removeLowerBoundRequiredListener

public final void removeLowerBoundRequiredListener(EventListener listener)

Specified by:

removeLowerBoundRequiredListener in interface ColumnConditionModel<K>

Parameters:

listener - the listener to remove

addClearedListener

public final void addClearedListener(EventListener listener)

Specified by:

addClearedListener in interface ColumnConditionModel<K>

Parameters:

listener - a listener to be notified each time the model is cleared

removeClearedListener

public final void removeClearedListener(EventListener listener)

Specified by:

removeClearedListener in interface ColumnConditionModel<K>

Parameters:

listener - the listener to remove

addConditionStateListener

public final void addConditionStateListener(EventListener listener)

Specified by:

addConditionStateListener in interface ColumnConditionModel<K>

Parameters:

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

removeConditionStateListener

public final void removeConditionStateListener(EventListener listener)

Specified by:

removeConditionStateListener in interface ColumnConditionModel<K>

Parameters:

listener - the listener to remove

addConditionTypeListener

public final void addConditionTypeListener(EventDataListener<ConditionType> listener)

Specified by:

addConditionTypeListener in interface ColumnConditionModel<K>

Parameters:

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

removeConditionTypeListener

public final void removeConditionTypeListener(EventDataListener listener)

Specified by:

removeConditionTypeListener in interface ColumnConditionModel<K>

Parameters:

listener - the listener to remove

getConditionTypeObserver

public final EventObserver<ConditionType> getConditionTypeObserver()

Specified by:

getConditionTypeObserver in interface ColumnConditionModel<K>

Returns:

an observer notified each time the condition type changes

include

public final boolean include(java.lang.Object object)

Specified by:

include in interface ColumnConditionModel<K>

Parameters:

object - the object

Returns:

true if the object should be included or if this model is not enabled

include

public final boolean include(java.lang.Comparable comparable)

Specified by:

include in interface ColumnConditionModel<K>

Parameters:

comparable - the value to check

Returns:

true if the given value should be included or if this model is not enabled

getComparable

protected java.lang.Comparable getComparable(java.lang.Object object)

Parameters:

object - the object

Returns:

a Comparable representing the given object