org.jminor.common.model
Interface ColumnSearchModel<K>

All Known Subinterfaces:
ForeignKeySearchModel, PropertySearchModel<T>
All Known Implementing Classes:
DefaultColumnSearchModel, DefaultForeignKeySearchModel, DefaultPropertyFilterModel, DefaultPropertySearchModel

public interface ColumnSearchModel<K>

Specifies a search model based on a table column, search parameters, search type, upper bound and lower bound, as well as relevant events and states. the type of objects used to identify columns


Field Summary
static String LOWER_BOUND_PROPERTY
           
static String UPPER_BOUND_PROPERTY
           
 
Method Summary
 void addClearedListener(ActionListener listener)
           
 void addEnabledListener(ActionListener listener)
           
 void addLowerBoundListener(ActionListener listener)
           
 void addSearchStateListener(ActionListener listener)
           
 void addSearchTypeListener(ActionListener listener)
           
 void addUpperBoundListener(ActionListener listener)
           
 void clearSearch()
          Clears the criteria values from this search model
 K getColumnIdentifier()
           
 EventObserver getEnabledObserver()
           
 Format getFormat()
           
 StateObserver getLockedState()
           
 Object getLowerBound()
           
 EventObserver getLowerBoundObserver()
           
 SearchType getSearchType()
           
 EventObserver getSearchTypeObserver()
           
 int getType()
           
 Object getUpperBound()
           
 EventObserver getUpperBoundObserver()
           
 boolean include(Comparable comparable)
           
 boolean include(Object object)
           
 boolean isAutoEnable()
           
 boolean isAutomaticWildcard()
           
 boolean isCaseSensitive()
           
 boolean isEnabled()
           
 boolean isLocked()
           
 void removeClearedListener(ActionListener listener)
           
 void removeEnabledListener(ActionListener listener)
           
 void removeLowerBoundListener(ActionListener listener)
           
 void removeSearchStateListener(ActionListener listener)
           
 void removeSearchTypeListener(ActionListener listener)
           
 void removeUpperBoundListener(ActionListener listener)
           
 void setAutoEnable(boolean autoEnable)
          If set, this model automatically enables itself when a criteria is specified
 void setAutomaticWildcard(boolean value)
           
 void setCaseSensitive(boolean caseSensitive)
           
 void setEnabled(boolean value)
           
 void setLikeValue(Comparable value)
          A shortcut method for setting the upper bound value, searchType to LIKE and enabling this model.
 void setLocked(boolean value)
           
 void setLowerBound(boolean value)
           
 void setLowerBound(Boolean value)
           
 void setLowerBound(char value)
           
 void setLowerBound(Date value)
           
 void setLowerBound(Double value)
           
 void setLowerBound(Integer value)
           
 void setLowerBound(Object value)
           
 void setLowerBound(String value)
           
 void setLowerBound(Timestamp value)
           
 void setSearchType(SearchType searchType)
           
 void setUpperBound(boolean value)
           
 void setUpperBound(Boolean value)
           
 void setUpperBound(char value)
           
 void setUpperBound(Date value)
           
 void setUpperBound(Double value)
           
 void setUpperBound(Integer value)
           
 void setUpperBound(Object upper)
           
 void setUpperBound(String value)
           
 void setUpperBound(Timestamp value)
           
 

Field Detail

UPPER_BOUND_PROPERTY

static final String UPPER_BOUND_PROPERTY
See Also:
Constant Field Values

LOWER_BOUND_PROPERTY

static final String LOWER_BOUND_PROPERTY
See Also:
Constant Field Values
Method Detail

getColumnIdentifier

K getColumnIdentifier()
Returns:
the column identifier

isCaseSensitive

boolean isCaseSensitive()
Returns:
true if this filter is be case sensitive

setCaseSensitive

void setCaseSensitive(boolean caseSensitive)
Parameters:
caseSensitive - true if this search model should be case sensitive when working with strings

getFormat

Format getFormat()
Returns:
the Format object to use when formatting input, is any

include

boolean include(Object object)
Parameters:
object - the object
Returns:
true if the object should be included

setAutomaticWildcard

void setAutomaticWildcard(boolean value)
Parameters:
value - true if wildcard should automatically be added to strings

isAutomaticWildcard

boolean isAutomaticWildcard()
Returns:
true if wildcard is automatically be added to strings

include

boolean include(Comparable comparable)
Parameters:
comparable - the value to check
Returns:
true if the given value should be included

setLocked

void setLocked(boolean value)
Parameters:
value - true to lock this model, false to unlock

isLocked

boolean isLocked()
Returns:
true if this model is locked

getType

int getType()
Returns:
the data type this search model is based on
See Also:
Types

setUpperBound

void setUpperBound(Object upper)
Parameters:
upper - the new upper bound

setLikeValue

void setLikeValue(Comparable value)
A shortcut method for setting the upper bound value, searchType to LIKE and enabling this model.

Parameters:
value - the value to use as criteria

getUpperBound

Object getUpperBound()
Returns:
the upper bound

setLowerBound

void setLowerBound(Object value)
Parameters:
value - the lower bound

getLowerBound

Object getLowerBound()
Returns:
the lower bound

getSearchType

SearchType getSearchType()
Returns:
the search type

setSearchType

void setSearchType(SearchType searchType)
Parameters:
searchType - the search type

isAutoEnable

boolean isAutoEnable()
Returns:
true if auto enable is enabled

setAutoEnable

void setAutoEnable(boolean autoEnable)
If set, this model automatically enables itself when a criteria is specified

Parameters:
autoEnable - true to enable, false to disable

isEnabled

boolean isEnabled()
Returns:
true if this search model is enabled

setEnabled

void setEnabled(boolean value)
Parameters:
value - true to enable, false to disable

clearSearch

void clearSearch()
Clears the criteria values from this search model


setUpperBound

void setUpperBound(String value)
Parameters:
value - the upper bound

setUpperBound

void setUpperBound(Double value)
Parameters:
value - the upper bound

setUpperBound

void setUpperBound(Integer value)
Parameters:
value - the upper bound

setUpperBound

void setUpperBound(boolean value)
Parameters:
value - the upper bound

setUpperBound

void setUpperBound(char value)
Parameters:
value - the upper bound

setUpperBound

void setUpperBound(Boolean value)
Parameters:
value - the upper bound

setUpperBound

void setUpperBound(Timestamp value)
Parameters:
value - the upper bound

setUpperBound

void setUpperBound(Date value)
Parameters:
value - the upper bound

setLowerBound

void setLowerBound(String value)
Parameters:
value - the Lower bound

setLowerBound

void setLowerBound(Double value)
Parameters:
value - the Lower bound

setLowerBound

void setLowerBound(Integer value)
Parameters:
value - the Lower bound

setLowerBound

void setLowerBound(boolean value)
Parameters:
value - the Lower bound

setLowerBound

void setLowerBound(char value)
Parameters:
value - the Lower bound

setLowerBound

void setLowerBound(Boolean value)
Parameters:
value - the Lower bound

setLowerBound

void setLowerBound(Timestamp value)
Parameters:
value - the Lower bound

setLowerBound

void setLowerBound(Date value)
Parameters:
value - the Lower bound

getLockedState

StateObserver getLockedState()
Returns:
an observer for this model's locked state

getEnabledObserver

EventObserver getEnabledObserver()
Returns:
an observer for this model's enabled state

getLowerBoundObserver

EventObserver getLowerBoundObserver()
Returns:
an observer for this model's lower bound

getUpperBoundObserver

EventObserver getUpperBoundObserver()
Returns:
an observer for this model's upper bound

getSearchTypeObserver

EventObserver getSearchTypeObserver()
Returns:
an observer for this model's search type

addEnabledListener

void addEnabledListener(ActionListener listener)
Parameters:
listener - a listener to be notified each time the enabled state changes

removeEnabledListener

void removeEnabledListener(ActionListener listener)
Parameters:
listener - the listener to remove

addSearchTypeListener

void addSearchTypeListener(ActionListener listener)
Parameters:
listener - a listener to be notified each time the search type changes

removeSearchTypeListener

void removeSearchTypeListener(ActionListener listener)
Parameters:
listener - the listener to remove

addLowerBoundListener

void addLowerBoundListener(ActionListener listener)
Parameters:
listener - a listener to be notified each time the lower bound changes

removeLowerBoundListener

void removeLowerBoundListener(ActionListener listener)
Parameters:
listener - the listener to remove

addUpperBoundListener

void addUpperBoundListener(ActionListener listener)
Parameters:
listener - a listener to be notified each time the upper bound changes

removeUpperBoundListener

void removeUpperBoundListener(ActionListener listener)
Parameters:
listener - the listener to remove

addClearedListener

void addClearedListener(ActionListener listener)
Parameters:
listener - a listener to be notified each time the model is cleared

removeClearedListener

void removeClearedListener(ActionListener listener)
Parameters:
listener - the listener to remove

addSearchStateListener

void addSearchStateListener(ActionListener listener)
Parameters:
listener - a listener to be notified each time the search state changes

removeSearchStateListener

void removeSearchStateListener(ActionListener listener)
Parameters:
listener - the listener to remove