org.jminor.swing.framework.model

Class SwingEntityComboBoxModel

java.lang.Object

org.jminor.swing.common.model.combobox.SwingFilteredComboBoxModel<Entity>

org.jminor.swing.framework.model.SwingEntityComboBoxModel

All Implemented Interfaces:

javax.swing.ComboBoxModel<Entity>, javax.swing.ListModel<Entity>, FilteredComboBoxModel<Entity>, FilteredModel<Entity>, Refreshable, EntityComboBoxModel, EntityDataProvider

public class SwingEntityComboBoxModel
extends SwingFilteredComboBoxModel<Entity>
implements EntityComboBoxModel

A ComboBoxModel based on an Entity, showing by default all the entities in the underlying table.

Constructor Summary

Constructors

Constructor and Description
SwingEntityComboBoxModel(java.lang.String entityId, EntityConnectionProvider connectionProvider)

Method Summary

Modifier and Type	Method and Description
void	addRefreshListener(EventListener listener)
EntityComboBoxModel	createForeignKeyFilterComboBoxModel(java.lang.String foreignKeyPropertyId) Returns a combo box model for selecting a foreign key value for filtering this model
void	forceRefresh() Forces a refresh of this model, disregarding the staticData directive
EntityConnectionProvider	getConnectionProvider()
Entity	getEntity(Entity.Key primaryKey)
java.lang.String	getEntityId()
FilterCondition<Entity>	getForeignKeyFilterCondition() Use this method to retrieve the default foreign key filter condition model if you want to add a custom FilterCondition to this model via FilteredModel.setFilterCondition(FilterCondition).
java.util.Collection<Entity>	getForeignKeyFilterEntities(java.lang.String foreignKeyPropertyId)
Condition.Provider	getSelectConditionProvider()
protected java.util.List<Entity>	initializeContents()
boolean	isStaticData()
boolean	isStrictForeignKeyFiltering()
void	linkForeignKeyComboBoxModel(java.lang.String foreignKeyPropertyId, EntityComboBoxModel foreignKeyModel) Links the given combo box model representing master entities to this combo box model so that selection in the master model filters this model according to the selected master entity
protected java.util.List<Entity>	performQuery() Retrieves the entities to present in this EntityComboBoxModel, taking into account the getSelectConditionProvider() specified for this model
void	removeRefreshListener(EventListener listener)
void	setForeignKeyFilterEntities(java.lang.String foreignKeyPropertyId, java.util.Collection<Entity> entities) Filters this combo box model so that only entities referencing the given foreign key entities via the given foreign key property are shown.
void	setSelectConditionProvider(Condition.Provider selectConditionProvider) Sets the condition provider to use when querying data
void	setSelectedEntityByKey(Entity.Key key) Selects the entity with the given primary key, if the entity is not available in the model this method returns silently without changing the selection
EntityComboBoxModel	setStaticData(boolean staticData) Specifies whether or not this models data should be considered static, that is, only fetched once.
void	setStrictForeignKeyFiltering(boolean strictForeignKeyFiltering) Specifies whether foreign key filtering should be strict or not.
java.lang.String	toString()
protected Entity	translateSelectionItem(java.lang.Object item)

Methods inherited from class org.jminor.swing.common.model.combobox.SwingFilteredComboBoxModel

addFilteringListener, addItem, addListDataListener, addSelectionListener, allowSelectionChange, clear, contains, filterContents, fireContentsChanged, getAllItems, getElementAt, getFilterCondition, getFilteredItemCount, getFilteredItems, getNullValue, getSelectedItem, getSelectedValue, getSize, getSortComparator, getVisibleItemCount, getVisibleItems, isCleared, isFiltered, isFilterSelectedItem, isNullValueSelected, isSelectionEmpty, isVisible, refresh, removeFilteringListener, removeItem, removeListDataListener, removeSelectionListener, setContents, setFilterCondition, setFilterSelectedItem, setNullValue, setSelectedItem, setSortComparator

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.jminor.common.model.combobox.FilteredComboBoxModel

addItem, addSelectionListener, getElementAt, getNullValue, getSelectedItem, getSelectedValue, getSize, getSortComparator, isCleared, isFilterSelectedItem, isNullValueSelected, isSelectionEmpty, removeItem, removeSelectionListener, setContents, setFilterSelectedItem, setNullValue, setSelectedItem, setSortComparator

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

addFilteringListener, contains, filterContents, getAllItems, getFilterCondition, getFilteredItemCount, getFilteredItems, getVisibleItemCount, getVisibleItems, isFiltered, isVisible, removeFilteringListener, setFilterCondition

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

clear, refresh

Constructor Detail

SwingEntityComboBoxModel

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

Parameters:

entityId - the id of the entity this combo box model should represent

connectionProvider - a EntityConnectionProvider instance

Method Detail

toString

public final java.lang.String toString()

Overrides:

toString in class java.lang.Object

getConnectionProvider

public final EntityConnectionProvider getConnectionProvider()

Specified by:

getConnectionProvider in interface EntityDataProvider

Returns:

the connection provider used by this data provider

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

forceRefresh

public final void forceRefresh()

Forces a refresh of this model, disregarding the staticData directive

Specified by:

forceRefresh in interface EntityComboBoxModel

See Also:

EntityComboBoxModel.setStaticData(boolean)

isStaticData

public final boolean isStaticData()

Specified by:

isStaticData in interface EntityComboBoxModel

Returns:

true if the data for this model should only be fetched once

See Also:

EntityComboBoxModel.forceRefresh()

setStaticData

public final EntityComboBoxModel setStaticData(boolean staticData)

Specifies whether or not this models data should be considered static, that is, only fetched once. Note that EntityComboBoxModel.forceRefresh() disregards this directive.

Specified by:

setStaticData in interface EntityComboBoxModel

Parameters:

staticData - the value

Returns:

this EntityComboBoxModel instance

getEntity

public final Entity getEntity(Entity.Key primaryKey)

Specified by:

getEntity in interface EntityComboBoxModel

Parameters:

primaryKey - the primary key of the entity to fetch from this model

Returns:

the entity with the given key if found in the model, null otherwise

setSelectedEntityByKey

public final void setSelectedEntityByKey(Entity.Key key)

Selects the entity with the given primary key, if the entity is not available in the model this method returns silently without changing the selection

Specified by:

setSelectedEntityByKey in interface EntityComboBoxModel

Parameters:

key - the primary key of the entity to select

setSelectConditionProvider

public final void setSelectConditionProvider(Condition.Provider selectConditionProvider)

Sets the condition provider to use when querying data

Specified by:

setSelectConditionProvider in interface EntityComboBoxModel

Parameters:

selectConditionProvider - the condition provider

getSelectConditionProvider

public final Condition.Provider getSelectConditionProvider()

Specified by:

getSelectConditionProvider in interface EntityComboBoxModel

Returns:

the select condition provider, null if none is specified

getForeignKeyFilterCondition

public final FilterCondition<Entity> getForeignKeyFilterCondition()

Use this method to retrieve the default foreign key filter condition model if you want to add a custom FilterCondition to this model via FilteredModel.setFilterCondition(FilterCondition).

   FilterCondition fkCondition = model.getForeignKeyFilterCondition();
   model.setFilterCondition(new FilterCondition() {
     public boolean include(Entity item) {
       return fkCondition.include(item) && ...;
     }
   });
 

Specified by:

getForeignKeyFilterCondition in interface EntityComboBoxModel

Returns:

the FilterCondition based on the foreign key filter entities

See Also:

EntityComboBoxModel.setForeignKeyFilterEntities(String, Collection)

setForeignKeyFilterEntities

public final void setForeignKeyFilterEntities(java.lang.String foreignKeyPropertyId,
                                              java.util.Collection<Entity> entities)

Filters this combo box model so that only entities referencing the given foreign key entities via the given foreign key property are shown.

Specified by:

setForeignKeyFilterEntities in interface EntityComboBoxModel

Parameters:

foreignKeyPropertyId - the property ID

entities - the entities

getForeignKeyFilterEntities

public final java.util.Collection<Entity> getForeignKeyFilterEntities(java.lang.String foreignKeyPropertyId)

Specified by:

getForeignKeyFilterEntities in interface EntityComboBoxModel

Parameters:

foreignKeyPropertyId - the ID of the foreign key property

Returns:

the entity values currently used to filter the contents of this model

setStrictForeignKeyFiltering

public final void setStrictForeignKeyFiltering(boolean strictForeignKeyFiltering)

Specifies whether foreign key filtering should be strict or not. When the filtering is strict only entities with the correct reference are included, that is, entities with null values for the given foreign key are filtered. Non-strict simply means that entities with null references are not filtered.

Specified by:

setStrictForeignKeyFiltering in interface EntityComboBoxModel

Parameters:

strictForeignKeyFiltering - the value

See Also:

EntityComboBoxModel.setForeignKeyFilterEntities(String, Collection)

isStrictForeignKeyFiltering

public final boolean isStrictForeignKeyFiltering()

Specified by:

isStrictForeignKeyFiltering in interface EntityComboBoxModel

Returns:

true if strict foreign key filtering is enabled

createForeignKeyFilterComboBoxModel

public final EntityComboBoxModel createForeignKeyFilterComboBoxModel(java.lang.String foreignKeyPropertyId)

Returns a combo box model for selecting a foreign key value for filtering this model

Specified by:

createForeignKeyFilterComboBoxModel in interface EntityComboBoxModel

Parameters:

foreignKeyPropertyId - the ID of the property with which values to create the combo box model

Returns:

a combo box model for selecting a filtering value for this combo box model

See Also:

EntityComboBoxModel.linkForeignKeyComboBoxModel(String, EntityComboBoxModel)

linkForeignKeyComboBoxModel

public final void linkForeignKeyComboBoxModel(java.lang.String foreignKeyPropertyId,
                                              EntityComboBoxModel foreignKeyModel)

Links the given combo box model representing master entities to this combo box model so that selection in the master model filters this model according to the selected master entity

Specified by:

linkForeignKeyComboBoxModel in interface EntityComboBoxModel

Parameters:

foreignKeyPropertyId - the ID of the foreign key property

foreignKeyModel - the combo box model to link

addRefreshListener

public final void addRefreshListener(EventListener listener)

Specified by:

addRefreshListener in interface EntityComboBoxModel

Parameters:

listener - a listener to be notified each time this model is refreshed

removeRefreshListener

public final void removeRefreshListener(EventListener listener)

Specified by:

removeRefreshListener in interface EntityComboBoxModel

Parameters:

listener - the listener to remove

translateSelectionItem

protected final Entity translateSelectionItem(java.lang.Object item)

Overrides:

translateSelectionItem in class SwingFilteredComboBoxModel<Entity>

Parameters:

item - the item to be selected

Returns:

the actual item to select

initializeContents

protected final java.util.List<Entity> initializeContents()

Overrides:

initializeContents in class SwingFilteredComboBoxModel<Entity>

Returns:

a List containing the items to be shown in this combo box model, by default it simply returns a list containing the items currently contained in the model, both filtered and visible, excluding the null value.

performQuery

protected java.util.List<Entity> performQuery()

Retrieves the entities to present in this EntityComboBoxModel, taking into account the getSelectConditionProvider() specified for this model

Returns:

the entities to present in this EntityComboBoxModel

See Also:

getSelectConditionProvider()