org.jminor.framework.model

Class DefaultEntityLookupModel

java.lang.Object

org.jminor.framework.model.DefaultEntityLookupModel

All Implemented Interfaces:

EntityDataProvider, EntityLookupModel

public class DefaultEntityLookupModel
extends java.lang.Object
implements EntityLookupModel

A default EntityLookupModel implementation

Nested Class Summary

Nested classes/interfaces inherited from interface org.jminor.framework.model.EntityLookupModel

EntityLookupModel.LookupSettings

Constructor Summary

Constructors

Constructor and Description
DefaultEntityLookupModel(java.lang.String entityId, EntityConnectionProvider connectionProvider) Instantiates a new EntityLookupModel, using the search properties for the given entity type
DefaultEntityLookupModel(java.lang.String entityId, EntityConnectionProvider connectionProvider, java.util.Collection<ColumnProperty> lookupProperties) Instantiates a new EntityLookupModel

Method Summary

Modifier and Type	Method and Description
void	addSelectedEntitiesListener(EventDataListener<java.util.Collection<Entity>> listener)
EntityConnectionProvider	getConnectionProvider()
java.lang.String	getDescription()
java.lang.String	getEntityId()
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 class java.lang.Object

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

Constructor Detail

DefaultEntityLookupModel

public DefaultEntityLookupModel(java.lang.String entityId,
                                EntityConnectionProvider connectionProvider)

Instantiates a new EntityLookupModel, using the search properties for the given entity type

Parameters:

entityId - the ID of the entity to lookup

connectionProvider - the EntityConnectionProvider to use when performing the lookup

See Also:

Entity.Definition#getSearchProperties()

DefaultEntityLookupModel

public DefaultEntityLookupModel(java.lang.String entityId,
                                EntityConnectionProvider connectionProvider,
                                java.util.Collection<ColumnProperty> lookupProperties)

Instantiates a new EntityLookupModel

Parameters:

entityId - the ID of the entity to lookup

connectionProvider - the EntityConnectionProvider to use when performing the lookup

lookupProperties - the properties to search by, these must be string based

Method Detail

getEntityId

public final java.lang.String getEntityId()

Specified by:

getEntityId in interface EntityDataProvider

Returns:

the ID of the entity this data provider is based on

getConnectionProvider

public final EntityConnectionProvider getConnectionProvider()

Specified by:

getConnectionProvider in interface EntityDataProvider

Returns:

the connection provider used by this data provider

getLookupProperties

public final java.util.Collection<ColumnProperty> getLookupProperties()

Specified by:

getLookupProperties in interface EntityLookupModel

Returns:

a list containing the properties used when performing a lookup

setResultSorter

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

Specified by:

setResultSorter in interface EntityLookupModel

Parameters:

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

getDescription

public final java.lang.String getDescription()

Specified by:

getDescription in interface EntityLookupModel

Returns:

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

setDescription

public final void setDescription(java.lang.String description)

Specified by:

setDescription in interface EntityLookupModel

Parameters:

description - a string describing this lookup model

setSelectedEntity

public final void setSelectedEntity(Entity entity)

Sets the given entity as the selected entity

Specified by:

setSelectedEntity in interface EntityLookupModel

Parameters:

entity - the entity to set as the selected entity

setSelectedEntities

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

Sets the selected entities

Specified by:

setSelectedEntities in interface EntityLookupModel

Parameters:

entities - the entities to set as selected

getSelectedEntities

public final java.util.Collection<Entity> getSelectedEntities()

Specified by:

getSelectedEntities in interface EntityLookupModel

Returns:

an unmodifiable view of the selected entities

getPropertyLookupSettings

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

Specified by:

getPropertyLookupSettings in interface EntityLookupModel

Returns:

the settings associated with the lookup properties

getWildcard

public final java.lang.String getWildcard()

Specified by:

getWildcard in interface EntityLookupModel

Returns:

the wildcard being used by this model

setWildcard

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

Sets the wildcard to use

Specified by:

setWildcard in interface EntityLookupModel

Parameters:

wildcard - the wildcard

Returns:

this EntityLookupModel instance

setAdditionalConditionProvider

public final 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.

Specified by:

setAdditionalConditionProvider in interface EntityLookupModel

Parameters:

additionalConditionProvider - the additional lookup condition provider

Returns:

this EntityLookupModel instance

getToStringProvider

public final Entity.ToString getToStringProvider()

Specified by:

getToStringProvider in interface EntityLookupModel

Returns:

the toString provider, null if none is specified

setToStringProvider

public final EntityLookupModel setToStringProvider(Entity.ToString toStringProvider)

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

Specified by:

setToStringProvider in interface EntityLookupModel

Parameters:

toStringProvider - provides string representations

Returns:

this EntityLookupModel instance

refreshSearchText

public final void refreshSearchText()

Refreshes the search text so that is represents the selected entities

Specified by:

refreshSearchText in interface EntityLookupModel

setSearchString

public final void setSearchString(java.lang.String searchString)

Sets the search string to use when performing the next lookup

Specified by:

setSearchString in interface EntityLookupModel

Parameters:

searchString - the search string

getSearchString

public final java.lang.String getSearchString()

Specified by:

getSearchString in interface EntityLookupModel

Returns:

the current search string value

searchStringRepresentsSelected

public final boolean searchStringRepresentsSelected()

Specified by:

searchStringRepresentsSelected in interface EntityLookupModel

Returns:

true if the current search string represents the selected entities

performQuery

public final java.util.List<Entity> performQuery()

Performs a query based on the select condition

Specified by:

performQuery in interface EntityLookupModel

Returns:

a list containing the entities fulfilling the current condition

getSearchStringValue

public final Value<java.lang.String> getSearchStringValue()

Specified by:

getSearchStringValue in interface EntityLookupModel

Returns:

the Value representing the search string

getMultipleItemSeparatorValue

public final Value<java.lang.String> getMultipleItemSeparatorValue()

Specified by:

getMultipleItemSeparatorValue in interface EntityLookupModel

Returns:

the Value representing the multiple item separator setting

getMultipleSelectionAllowedValue

public final Value<java.lang.Boolean> getMultipleSelectionAllowedValue()

Specified by:

getMultipleSelectionAllowedValue in interface EntityLookupModel

Returns:

the Value representing the multiple selection allowed setting

addSelectedEntitiesListener

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

Specified by:

addSelectedEntitiesListener in interface EntityLookupModel

Parameters:

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

getSearchStringRepresentsSelectedObserver

public final StateObserver getSearchStringRepresentsSelectedObserver()

Specified by:

getSearchStringRepresentsSelectedObserver in interface EntityLookupModel

Returns:

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