org.jminor.framework.model

Interface EntityTableConditionModel

All Superinterfaces:

FilterCondition<Entity>, Refreshable

All Known Implementing Classes:

DefaultEntityTableConditionModel

public interface EntityTableConditionModel
extends FilterCondition<Entity>, Refreshable

This interface defines filtering functionality, which refers to showing/hiding entities already available in a table model and searching functionality, which refers to configuring the underlying query, which then needs to be re-run.

Nested Class Summary

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

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

Method Summary

Modifier and Type	Method and Description
void	addConditionStateListener(EventListener listener)
void	addSimpleConditionListener(EventListener listener)
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	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	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 simpleSearchText) Note that calling this method may (and probably will) change the automatic prefix and case sensetivity settings of the underlying ColumnConditionModels

Methods inherited from interface org.jminor.common.model.FilterCondition

include

Methods inherited from interface org.jminor.common.model.Refreshable

clear, refresh

Method Detail

getEntityId

java.lang.String getEntityId()

Returns:

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

setConditionValues

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

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

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

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

Parameters:

propertyId - the id of the property

value - the condition value

getCondition

Condition getCondition()

Returns:

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

getAdditionalConditionProvider

Condition.Provider getAdditionalConditionProvider()

Returns:

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

setAdditionalConditionProvider

EntityTableConditionModel setAdditionalConditionProvider(Condition.Provider conditionProvider)

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

Parameters:

conditionProvider - the condition provider

Returns:

this EntityTableConditionModel instance

getAdditionalFilterCondition

FilterCondition<Entity> getAdditionalFilterCondition()

Returns:

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

setAdditionalFilterCondition

EntityTableConditionModel setAdditionalFilterCondition(FilterCondition<Entity> filterCondition)

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

Parameters:

filterCondition - the condition

Returns:

this EntityTableConditionModel instance

isEnabled

boolean isEnabled()

Returns:

true if any of the underlying PropertyConditionModels is enabled

isEnabled

boolean isEnabled(java.lang.String propertyId)

Parameters:

propertyId - the column propertyId

Returns:

true if the PropertyConditionModel behind column with index columnIndex is enabled

setEnabled

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

Enables/disables the search for the given property

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

rememberCurrentConditionState

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.

See Also:

getConditionStateObserver()

hasConditionStateChanged

boolean hasConditionStateChanged()

Returns:

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

See Also:

rememberCurrentConditionState()

getConjunction

Conjunction getConjunction()

Returns:

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

See Also:

Conjunction

setConjunction

void setConjunction(Conjunction conjunction)

Parameters:

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

See Also:

Conjunction

containsPropertyConditionModel

boolean containsPropertyConditionModel(java.lang.String propertyId)

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

getPropertyConditionModels

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

Returns:

a Collection containing the PropertyConditionModels available in this table condition model

getPropertyConditionModel

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

Parameters:

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

Returns:

the PropertyConditionModel associated with the property identified by propertyId

Throws:

java.lang.IllegalArgumentException - in case no condition model is found

See Also:

containsPropertyConditionModel(String)

clearPropertyConditionModels

void clearPropertyConditionModels()

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

getPropertyFilterModels

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

Returns:

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

getPropertyFilterModel

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

The PropertyFilterModel associated with the property identified by propertyId

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

isFilterEnabled

boolean isFilterEnabled(java.lang.String propertyId)

Parameters:

propertyId - column propertyId

Returns:

true if the PropertyFilterModel behind column with index columnIndex is enabled

getSimpleConditionString

java.lang.String getSimpleConditionString()

Returns:

the text used when performing a simple search

See Also:

performSimpleSearch()

setSimpleConditionString

void setSimpleConditionString(java.lang.String simpleSearchText)

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

Parameters:

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

See Also:

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

performSimpleSearch

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

See Also:

Entity.Definition#getSearchProperties()

getConditionStateObserver

StateObserver getConditionStateObserver()

Returns:

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

See Also:

rememberCurrentConditionState()

getSimpleConditionStringObserver

EventObserver<java.lang.String> getSimpleConditionStringObserver()

Returns:

an EventObserver notified each time the simple search text changes

addConditionStateListener

void addConditionStateListener(EventListener listener)

Parameters:

listener - a listener notified each time the search state changes

removeConditionStateListener

void removeConditionStateListener(EventListener listener)

Parameters:

listener - the listener to remove

addSimpleConditionListener

void addSimpleConditionListener(EventListener listener)

Parameters:

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

removeSimpleConditionListener

void removeSimpleConditionListener(EventListener listener)

Parameters:

listener - the listener to remove