org.jminor.framework.model

Class DefaultEntityTableConditionModel

java.lang.Object

org.jminor.framework.model.DefaultEntityTableConditionModel

All Implemented Interfaces:

FilterCondition<Entity>, Refreshable, EntityTableConditionModel

public class DefaultEntityTableConditionModel
extends java.lang.Object
implements EntityTableConditionModel

A default EntityTableConditionModel implementation

Nested Class Summary

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

FilterCondition.AcceptAllCondition<T>, FilterCondition.RejectAllCondition<T>

Constructor Summary

Constructors

Constructor and Description
DefaultEntityTableConditionModel(java.lang.String entityId, EntityConnectionProvider connectionProvider, PropertyFilterModelProvider filterModelProvider, PropertyConditionModelProvider conditionModelProvider) Instantiates a new DefaultEntityTableConditionModel

Method Summary

Modifier and Type	Method and Description
void	addConditionStateListener(EventListener listener)
void	addSimpleConditionListener(EventListener listener)
void	clear() Clears all data from this refreshable instance
void	clearPropertyConditionModels() Clears the search state of all PropertyConditionModels, disables them and resets the search type to ConditionType.LIKE
boolean	containsPropertyConditionModel(java.lang.String propertyId)
Condition.Provider	getAdditionalConditionProvider()
FilterCondition<Entity>	getAdditionalFilterCondition()
Condition	getCondition()
StateObserver	getConditionStateObserver()
Conjunction	getConjunction()
java.lang.String	getEntityId()
PropertyConditionModel<? extends Property>	getPropertyConditionModel(java.lang.String propertyId)
java.util.Collection<PropertyConditionModel<? extends Property>>	getPropertyConditionModels()
ColumnConditionModel<Property>	getPropertyFilterModel(java.lang.String propertyId) The PropertyFilterModel associated with the property identified by propertyId
java.util.Collection<ColumnConditionModel<Property>>	getPropertyFilterModels()
java.lang.String	getSimpleConditionString()
EventObserver<java.lang.String>	getSimpleConditionStringObserver()
boolean	hasConditionStateChanged()
boolean	include(Entity item)
boolean	isEnabled()
boolean	isEnabled(java.lang.String propertyId)
boolean	isFilterEnabled(java.lang.String propertyId)
void	performSimpleSearch() Uses the simpleSearchText as a basis for a wildcard search on all String based condition models, or the condition models representing the search properties for the underlying entity
void	refresh() Performs a refresh, reloading the relevant data
void	rememberCurrentConditionState() Remembers the current condition model state, any subsequent changes to condition parameters or operators are notified via the conditionStateChanged observer.
void	removeConditionStateListener(EventListener listener)
void	removeSimpleConditionListener(EventListener listener)
EntityTableConditionModel	setAdditionalConditionProvider(Condition.Provider conditionProvider) Sets the additional condition provider, one not based on any individual property condition
EntityTableConditionModel	setAdditionalFilterCondition(FilterCondition<Entity> filterCondition) Sets the additional filter condition, one not based on any individual property condition
boolean	setConditionValues(java.lang.String propertyId, java.util.Collection values) Sets the search condition values of the condition model associated with the property identified by propertyId
void	setConjunction(Conjunction conjunction)
void	setEnabled(java.lang.String propertyId, boolean enabled) Enables/disables the search for the given property
void	setFilterValue(java.lang.String propertyId, java.lang.Comparable value) Sets the condition value of the PropertyFilterModel associated with the property identified by propertyId.
void	setSimpleConditionString(java.lang.String simpleConditionString) Note that calling this method may (and probably will) change the automatic prefix and case sensetivity settings of the underlying ColumnConditionModels

Methods inherited from class java.lang.Object

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

Constructor Detail

DefaultEntityTableConditionModel

public DefaultEntityTableConditionModel(java.lang.String entityId,
                                        EntityConnectionProvider connectionProvider,
                                        PropertyFilterModelProvider filterModelProvider,
                                        PropertyConditionModelProvider conditionModelProvider)

Instantiates a new DefaultEntityTableConditionModel

Parameters:

entityId - the ID of the underlying entity

connectionProvider - a EntityConnectionProvider instance, required if the searchable properties include foreign key properties

filterModelProvider - provides the column filter models for this table condition model

conditionModelProvider - provides the column condition models for this table condition model

Method Detail

getEntityId

public final java.lang.String getEntityId()

Specified by:

getEntityId in interface EntityTableConditionModel

Returns:

the id of the entity this table condition model is based on

rememberCurrentConditionState

public final void rememberCurrentConditionState()

Remembers the current condition model state, any subsequent changes to condition parameters or operators are notified via the conditionStateChanged observer. A data model using this condition model should call this method each time the model is refreshed according to the condition provided by this condition model.

Specified by:

rememberCurrentConditionState in interface EntityTableConditionModel

See Also:

EntityTableConditionModel.getConditionStateObserver()

hasConditionStateChanged

public final boolean hasConditionStateChanged()

Specified by:

hasConditionStateChanged in interface EntityTableConditionModel

Returns:

true if the condition model state (or configuration) has changed since the last time the condition model state was remembered

See Also:

EntityTableConditionModel.rememberCurrentConditionState()

getPropertyFilterModel

public final ColumnConditionModel<Property> getPropertyFilterModel(java.lang.String propertyId)

The PropertyFilterModel associated with the property identified by propertyId

Specified by:

getPropertyFilterModel in interface EntityTableConditionModel

Parameters:

propertyId - the id of the property for which to retrieve the PropertyFilterModel

Returns:

the PropertyFilterModel for the property with id propertyId, null if none is found

getPropertyFilterModels

public final java.util.Collection<ColumnConditionModel<Property>> getPropertyFilterModels()

Specified by:

getPropertyFilterModels in interface EntityTableConditionModel

Returns:

a Collection containing the filter models available in this table condition model

include

public final boolean include(Entity item)

Specified by:

include in interface FilterCondition<Entity>

Parameters:

item - the item

Returns:

true if item should be included, false if it should be filtered

refresh

public final void refresh()

Performs a refresh, reloading the relevant data

Specified by:

refresh in interface Refreshable

clear

public final void clear()

Clears all data from this refreshable instance

Specified by:

clear in interface Refreshable

clearPropertyConditionModels

public final void clearPropertyConditionModels()

Clears the search state of all PropertyConditionModels, disables them and resets the search type to ConditionType.LIKE

Specified by:

clearPropertyConditionModels in interface EntityTableConditionModel

getPropertyConditionModels

public final java.util.Collection<PropertyConditionModel<? extends Property>> getPropertyConditionModels()

Specified by:

getPropertyConditionModels in interface EntityTableConditionModel

Returns:

a Collection containing the PropertyConditionModels available in this table condition model

containsPropertyConditionModel

public final boolean containsPropertyConditionModel(java.lang.String propertyId)

Specified by:

containsPropertyConditionModel in interface EntityTableConditionModel

Parameters:

propertyId - the id of the property for which to check for the PropertyConditionModel

Returns:

true if this EntityTableConditionModel contains a PropertyConditionModel associated with the property identified by propertyId

getPropertyConditionModel

public final PropertyConditionModel<? extends Property> getPropertyConditionModel(java.lang.String propertyId)

Specified by:

getPropertyConditionModel in interface EntityTableConditionModel

Parameters:

propertyId - the id of the property for which to retrieve the PropertyConditionModel

Returns:

the PropertyConditionModel associated with the property identified by propertyId

See Also:

EntityTableConditionModel.containsPropertyConditionModel(String)

isEnabled

public final boolean isEnabled()

Specified by:

isEnabled in interface EntityTableConditionModel

Returns:

true if any of the underlying PropertyConditionModels is enabled

isEnabled

public final boolean isEnabled(java.lang.String propertyId)

Specified by:

isEnabled in interface EntityTableConditionModel

Parameters:

propertyId - the column propertyId

Returns:

true if the PropertyConditionModel behind column with index columnIndex is enabled

isFilterEnabled

public final boolean isFilterEnabled(java.lang.String propertyId)

Specified by:

isFilterEnabled in interface EntityTableConditionModel

Parameters:

propertyId - column propertyId

Returns:

true if the PropertyFilterModel behind column with index columnIndex is enabled

setConditionValues

public final boolean setConditionValues(java.lang.String propertyId,
                                        java.util.Collection values)

Sets the search condition values of the condition model associated with the property identified by propertyId

Specified by:

setConditionValues in interface EntityTableConditionModel

Parameters:

propertyId - the id of the property

values - the search condition values

Returns:

true if the search state changed as a result of this method call, false otherwise

setFilterValue

public final void setFilterValue(java.lang.String propertyId,
                                 java.lang.Comparable value)

Sets the condition value of the PropertyFilterModel associated with the property identified by propertyId.

Specified by:

setFilterValue in interface EntityTableConditionModel

Parameters:

propertyId - the id of the property

value - the condition value

getCondition

public final Condition getCondition()

Specified by:

getCondition in interface EntityTableConditionModel

Returns:

the current condition based on the state of the underlying condition models

getAdditionalConditionProvider

public final Condition.Provider getAdditionalConditionProvider()

Specified by:

getAdditionalConditionProvider in interface EntityTableConditionModel

Returns:

any additional search condition, not based on any individual property condition

setAdditionalConditionProvider

public final EntityTableConditionModel setAdditionalConditionProvider(Condition.Provider conditionProvider)

Sets the additional condition provider, one not based on any individual property condition

Specified by:

setAdditionalConditionProvider in interface EntityTableConditionModel

Parameters:

conditionProvider - the condition provider

Returns:

this EntityTableConditionModel instance

getAdditionalFilterCondition

public final FilterCondition<Entity> getAdditionalFilterCondition()

Specified by:

getAdditionalFilterCondition in interface EntityTableConditionModel

Returns:

any additional filter condition, not based on any individual property condition

setAdditionalFilterCondition

public final EntityTableConditionModel setAdditionalFilterCondition(FilterCondition<Entity> filterCondition)

Sets the additional filter condition, one not based on any individual property condition

Specified by:

setAdditionalFilterCondition in interface EntityTableConditionModel

Parameters:

filterCondition - the condition

Returns:

this EntityTableConditionModel instance

getSimpleConditionString

public final java.lang.String getSimpleConditionString()

Specified by:

getSimpleConditionString in interface EntityTableConditionModel

Returns:

the text used when performing a simple search

See Also:

EntityTableConditionModel.performSimpleSearch()

setSimpleConditionString

public final void setSimpleConditionString(java.lang.String simpleConditionString)

Note that calling this method may (and probably will) change the automatic prefix and case sensetivity settings of the underlying ColumnConditionModels

Specified by:

setSimpleConditionString in interface EntityTableConditionModel

Parameters:

simpleConditionString - the text to use next time a simple search is performed

See Also:

EntityTableConditionModel.performSimpleSearch(), ColumnConditionModel.setCaseSensitive(boolean), ColumnConditionModel.setAutomaticWildcard(ColumnConditionModel.AutomaticWildcard)

performSimpleSearch

public final void performSimpleSearch()

Uses the simpleSearchText as a basis for a wildcard search on all String based condition models, or the condition models representing the search properties for the underlying entity

Specified by:

performSimpleSearch in interface EntityTableConditionModel

See Also:

Entity.Definition#getSearchProperties()

getConjunction

public final Conjunction getConjunction()

Specified by:

getConjunction in interface EntityTableConditionModel

Returns:

the conjunction to be used when multiple column condition are active, the default is Conjunction.AND

See Also:

Conjunction

setConjunction

public final void setConjunction(Conjunction conjunction)

Specified by:

setConjunction in interface EntityTableConditionModel

Parameters:

conjunction - the conjunction to be used when more than one column search condition is active

See Also:

Conjunction

setEnabled

public final void setEnabled(java.lang.String propertyId,
                             boolean enabled)

Enables/disables the search for the given property

Specified by:

setEnabled in interface EntityTableConditionModel

Parameters:

propertyId - the id of the property for which to enable/disable the search

enabled - if true the search is enabled, otherwise it is disabled

getSimpleConditionStringObserver

public final EventObserver<java.lang.String> getSimpleConditionStringObserver()

Specified by:

getSimpleConditionStringObserver in interface EntityTableConditionModel

Returns:

an EventObserver notified each time the simple search text changes

getConditionStateObserver

public final StateObserver getConditionStateObserver()

Specified by:

getConditionStateObserver in interface EntityTableConditionModel

Returns:

a StateObserver indicating if the search state has changed since it was last remembered

See Also:

EntityTableConditionModel.rememberCurrentConditionState()

addConditionStateListener

public final void addConditionStateListener(EventListener listener)

Specified by:

addConditionStateListener in interface EntityTableConditionModel

Parameters:

listener - a listener notified each time the search state changes

removeConditionStateListener

public final void removeConditionStateListener(EventListener listener)

Specified by:

removeConditionStateListener in interface EntityTableConditionModel

Parameters:

listener - the listener to remove

addSimpleConditionListener

public final void addSimpleConditionListener(EventListener listener)

Specified by:

addSimpleConditionListener in interface EntityTableConditionModel

Parameters:

listener - a listener notified each time a simple search is performed

removeSimpleConditionListener

public final void removeSimpleConditionListener(EventListener listener)

Specified by:

removeSimpleConditionListener in interface EntityTableConditionModel

Parameters:

listener - the listener to remove