org.jminor.framework.model

Interface EntityComboBoxModel

All Superinterfaces:

EntityDataProvider, FilteredComboBoxModel<Entity>, FilteredModel<Entity>, Refreshable

All Known Implementing Classes:

SwingEntityComboBoxModel

public interface EntityComboBoxModel
extends FilteredComboBoxModel<Entity>, EntityDataProvider

A ComboBoxModel based on Entity instances.

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
Entity	getEntity(Entity.Key primaryKey)
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()
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
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 primaryKey) 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.

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

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

getConnectionProvider, getEntityId

Method Detail

getEntity

Entity getEntity(Entity.Key primaryKey)

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

getForeignKeyFilterCondition

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) && ...;
     }
   });
 

Returns:

the FilterCondition based on the foreign key filter entities

See Also:

setForeignKeyFilterEntities(String, Collection)

getForeignKeyFilterEntities

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

Parameters:

foreignKeyPropertyId - the ID of the foreign key property

Returns:

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

setForeignKeyFilterEntities

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.

Parameters:

foreignKeyPropertyId - the property ID

entities - the entities

setStrictForeignKeyFiltering

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.

Parameters:

strictForeignKeyFiltering - the value

See Also:

setForeignKeyFilterEntities(String, Collection)

isStrictForeignKeyFiltering

boolean isStrictForeignKeyFiltering()

Returns:

true if strict foreign key filtering is enabled

createForeignKeyFilterComboBoxModel

EntityComboBoxModel createForeignKeyFilterComboBoxModel(java.lang.String foreignKeyPropertyId)

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

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:

linkForeignKeyComboBoxModel(String, EntityComboBoxModel)

linkForeignKeyComboBoxModel

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

Parameters:

foreignKeyPropertyId - the ID of the foreign key property

foreignKeyModel - the combo box model to link

setSelectedEntityByKey

void setSelectedEntityByKey(Entity.Key primaryKey)

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

Parameters:

primaryKey - the primary key of the entity to select

forceRefresh

void forceRefresh()

Forces a refresh of this model, disregarding the staticData directive

See Also:

setStaticData(boolean)

setStaticData

EntityComboBoxModel setStaticData(boolean staticData)

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

Parameters:

staticData - the value

Returns:

this EntityComboBoxModel instance

isStaticData

boolean isStaticData()

Returns:

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

See Also:

forceRefresh()

setSelectConditionProvider

void setSelectConditionProvider(Condition.Provider selectConditionProvider)

Sets the condition provider to use when querying data

Parameters:

selectConditionProvider - the condition provider

getSelectConditionProvider

Condition.Provider getSelectConditionProvider()

Returns:

the select condition provider, null if none is specified

addRefreshListener

void addRefreshListener(EventListener listener)

Parameters:

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

removeRefreshListener

void removeRefreshListener(EventListener listener)

Parameters:

listener - the listener to remove