org.jminor.framework.model

Interface EntityLookupModel

All Superinterfaces:

EntityDataProvider

All Known Implementing Classes:

DefaultEntityLookupModel

public interface EntityLookupModel
extends EntityDataProvider

A interface responsible for doing entity lookups based on a set of condition properties.

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static interface	EntityLookupModel.LookupSettings Property lookup settings

Method Summary

Modifier and Type	Method and Description
void	addSelectedEntitiesListener(EventDataListener<java.util.Collection<Entity>> listener)
java.lang.String	getDescription()
java.util.Collection<ColumnProperty>	getLookupProperties()
Value<java.lang.String>	getMultipleItemSeparatorValue()
Value<java.lang.Boolean>	getMultipleSelectionAllowedValue()
java.util.Map<ColumnProperty,EntityLookupModel.LookupSettings>	getPropertyLookupSettings()
java.lang.String	getSearchString()
StateObserver	getSearchStringRepresentsSelectedObserver()
Value<java.lang.String>	getSearchStringValue()
java.util.Collection<Entity>	getSelectedEntities()
Entity.ToString	getToStringProvider()
java.lang.String	getWildcard()
java.util.List<Entity>	performQuery() Performs a query based on the select condition
void	refreshSearchText() Refreshes the search text so that is represents the selected entities
boolean	searchStringRepresentsSelected()
EntityLookupModel	setAdditionalConditionProvider(Condition.Provider additionalConditionProvider) Sets the additional lookup condition provider to use when performing the next lookup.
void	setDescription(java.lang.String description)
void	setResultSorter(java.util.Comparator<Entity> resultSorter)
void	setSearchString(java.lang.String searchString) Sets the search string to use when performing the next lookup
void	setSelectedEntities(java.util.Collection<Entity> entities) Sets the selected entities
void	setSelectedEntity(Entity entity) Sets the given entity as the selected entity
EntityLookupModel	setToStringProvider(Entity.ToString toStringProvider) Override the default toString() for lookup elements when displayed in a field based on this model
EntityLookupModel	setWildcard(java.lang.String wildcard) Sets the wildcard to use

Methods inherited from interface org.jminor.framework.model.EntityDataProvider

getConnectionProvider, getEntityId

Method Detail

getSelectedEntities

java.util.Collection<Entity> getSelectedEntities()

Returns:

an unmodifiable view of the selected entities

setSelectedEntity

void setSelectedEntity(Entity entity)

Sets the given entity as the selected entity

Parameters:

entity - the entity to set as the selected entity

setSelectedEntities

void setSelectedEntities(java.util.Collection<Entity> entities)

Sets the selected entities

Parameters:

entities - the entities to set as selected

Throws:

java.lang.IllegalArgumentException - if this lookup model does not allow multiple selections and entities.size() is larger than 1

getDescription

java.lang.String getDescription()

Returns:

a string describing this lookup model, by default a comma separated list of search property names

setDescription

void setDescription(java.lang.String description)

Parameters:

description - a string describing this lookup model

getLookupProperties

java.util.Collection<ColumnProperty> getLookupProperties()

Returns:

a list containing the properties used when performing a lookup

setResultSorter

void setResultSorter(java.util.Comparator<Entity> resultSorter)

Parameters:

resultSorter - the comparator used to sort the lookup result, null if the result should not be sorted

refreshSearchText

void refreshSearchText()

Refreshes the search text so that is represents the selected entities

setSearchString

void setSearchString(java.lang.String searchString)

Sets the search string to use when performing the next lookup

Parameters:

searchString - the search string

getSearchString

java.lang.String getSearchString()

Returns:

the current search string value

setWildcard

EntityLookupModel setWildcard(java.lang.String wildcard)

Sets the wildcard to use

Parameters:

wildcard - the wildcard

Returns:

this EntityLookupModel instance

getWildcard

java.lang.String getWildcard()

Returns:

the wildcard being used by this model

searchStringRepresentsSelected

boolean searchStringRepresentsSelected()

Returns:

true if the current search string represents the selected entities

performQuery

java.util.List<Entity> performQuery()

Performs a query based on the select condition

Returns:

a list containing the entities fulfilling the current condition

Throws:

java.lang.IllegalStateException - in case no lookup properties are specified

setAdditionalConditionProvider

EntityLookupModel setAdditionalConditionProvider(Condition.Provider additionalConditionProvider)

Sets the additional lookup condition provider to use when performing the next lookup. This condition is AND'ed to the actual lookup condition. NOTE, this does not affect the currently selected value(s), if any.

Parameters:

additionalConditionProvider - the additional lookup condition provider

Returns:

this EntityLookupModel instance

setToStringProvider

EntityLookupModel setToStringProvider(Entity.ToString toStringProvider)

Override the default toString() for lookup elements when displayed in a field based on this model

Parameters:

toStringProvider - provides string representations

Returns:

this EntityLookupModel instance

getToStringProvider

Entity.ToString getToStringProvider()

Returns:

the toString provider, null if none is specified

addSelectedEntitiesListener

void addSelectedEntitiesListener(EventDataListener<java.util.Collection<Entity>> listener)

Parameters:

listener - a listener to be notified each time the selected entities are changed

getSearchStringRepresentsSelectedObserver

StateObserver getSearchStringRepresentsSelectedObserver()

Returns:

a StateObserver indicating whether or not the search string represents the selected entities

getPropertyLookupSettings

java.util.Map<ColumnProperty,EntityLookupModel.LookupSettings> getPropertyLookupSettings()

Returns:

the settings associated with the lookup properties

getSearchStringValue

Value<java.lang.String> getSearchStringValue()

Returns:

the Value representing the search string

getMultipleItemSeparatorValue

Value<java.lang.String> getMultipleItemSeparatorValue()

Returns:

the Value representing the multiple item separator setting

getMultipleSelectionAllowedValue

Value<java.lang.Boolean> getMultipleSelectionAllowedValue()

Returns:

the Value representing the multiple selection allowed setting