is.codion.swing.framework.model.SwingEntityEditModel Maven / Gradle / Ivy
/*
* This file is part of Codion.
*
* Codion is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* Codion is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with Codion. If not, see , FilteredComboBoxModel> comboBoxModels = new HashMap<>();
/**
* Instantiates a new {@link SwingEntityEditModel} based on the given entity type.
* @param entityType the type of the entity to base this {@link SwingEntityEditModel} on
* @param connectionProvider the {@link EntityConnectionProvider} instance
*/
public SwingEntityEditModel(EntityType entityType, EntityConnectionProvider connectionProvider) {
this(entityType, requireNonNull(connectionProvider), connectionProvider.entities().definition(entityType).validator());
}
/**
* Instantiates a new {@link SwingEntityEditModel} based on the given entity type.
* @param entityType the type of the entity to base this {@link SwingEntityEditModel} on
* @param connectionProvider the {@link EntityConnectionProvider} instance
* @param validator the validator to use
*/
public SwingEntityEditModel(EntityType entityType, EntityConnectionProvider connectionProvider, EntityValidator validator) {
super(entityType, connectionProvider, validator);
}
/**
* Creates and refreshes combo box models for the given attributes. Doing this avoids refreshing the
* data on the EDT when the actual combo boxes are initialized.
* In case of {@link ForeignKey} a foreign key combo box model and in
* case of a {@link Attribute} a attribute combo box model.
* @param attributes the attributes for which to initialize combo box models
* @see #createComboBoxModel(Column)
* @see #createForeignKeyComboBoxModel(ForeignKey)
*/
public final void initializeComboBoxModels(Attribute... attributes) {
requireNonNull(attributes);
for (Attribute attribute : attributes) {
if (attribute instanceof ForeignKey) {
foreignKeyComboBoxModel((ForeignKey) attribute).refresh();
}
else if (attribute instanceof Column) {
comboBoxModel((Column) attribute).refresh();
}
}
}
/**
* Refreshes all foreign key combobox models
*/
public final void refreshForeignKeyComboBoxModels() {
synchronized (comboBoxModels) {
for (FilteredComboBoxModel comboBoxModel : comboBoxModels.values()) {
if (comboBoxModel instanceof EntityComboBoxModel) {
comboBoxModel.refresh();
}
}
}
}
/**
* Refreshes all combobox models
*/
public final void refreshComboBoxModels() {
synchronized (comboBoxModels) {
for (FilteredComboBoxModel comboBoxModel : comboBoxModels.values()) {
comboBoxModel.refresh();
}
}
}
/**
* Clears all combobox models
*/
public final void clearComboBoxModels() {
synchronized (comboBoxModels) {
for (FilteredComboBoxModel comboBoxModel : comboBoxModels.values()) {
comboBoxModel.clear();
}
}
}
/**
* Returns the {@link EntityComboBoxModel} for the given foreign key attribute. If one does not exist one is created.
* @param foreignKey the foreign key attribute
* @return a {@link EntityComboBoxModel} based on the entity referenced by the given foreign key attribute
* @see #createForeignKeyComboBoxModel(ForeignKey)
*/
public final EntityComboBoxModel foreignKeyComboBoxModel(ForeignKey foreignKey) {
entityDefinition().foreignKeys().definition(foreignKey);
synchronized (comboBoxModels) {
// can't use computeIfAbsent() here, since that prevents recursive initialization of interdepending combo
// box models, createForeignKeyComboBoxModel() may for example call this function
// see javadoc: must not attempt to update any other mappings of this map
EntityComboBoxModel comboBoxModel = (EntityComboBoxModel) comboBoxModels.get(foreignKey);
if (comboBoxModel == null) {
comboBoxModel = createForeignKeyComboBoxModel(foreignKey);
comboBoxModels.put(foreignKey, comboBoxModel);
}
return comboBoxModel;
}
}
/**
* Returns the {@link FilteredComboBoxModel} for the given column. If one does not exist one is created.
* @param column the column
* @param the value type
* @return a {@link FilteredComboBoxModel} for the given column
* @see #createComboBoxModel(Column)
*/
public final FilteredComboBoxModel comboBoxModel(Column column) {
entityDefinition().columns().definition(column);
synchronized (comboBoxModels) {
// can't use computeIfAbsent here, see foreignKeyComboBoxModel() comment
FilteredComboBoxModel comboBoxModel = (FilteredComboBoxModel) comboBoxModels.get(column);
if (comboBoxModel == null) {
comboBoxModel = createComboBoxModel(column);
comboBoxModels.put(column, comboBoxModel);
}
return comboBoxModel;
}
}
/**
* @param attribute the attribute
* @return true if this edit model contains a combobox model for the attribute
*/
public final boolean containsComboBoxModel(Attribute attribute) {
synchronized (comboBoxModels) {
return comboBoxModels.containsKey(attribute);
}
}
/**
* Creates a {@link EntityComboBoxModel} for the given foreign key, override to
* provide a custom {@link EntityComboBoxModel} implementation.
* This method is called when creating a foreign key {@link EntityComboBoxModel} for the edit
* fields used when editing a single record.
* This default implementation returns a sorted {@link EntityComboBoxModel} with the default
* nullValueCaption if the underlying attribute is nullable.
* If the foreign key has select attributes defined, those are set in the combo box model.
* @param foreignKey the foreign key for which to create a {@link EntityComboBoxModel}
* @return a {@link EntityComboBoxModel} for the given foreign key
* @see FilteredComboBoxModel#COMBO_BOX_NULL_CAPTION
* @see AttributeDefinition#nullable()
* @see EntityComboBoxModel#attributes()
* @see ForeignKeyDefinition#attributes()
*/
public EntityComboBoxModel createForeignKeyComboBoxModel(ForeignKey foreignKey) {
ForeignKeyDefinition foreignKeyDefinition = entityDefinition().foreignKeys().definition(foreignKey);
EntityComboBoxModel comboBoxModel = new EntityComboBoxModel(foreignKey.referencedType(), connectionProvider());
comboBoxModel.attributes().set(foreignKeyDefinition.attributes());
if (nullable(foreignKey)) {
comboBoxModel.setNullCaption(FilteredComboBoxModel.COMBO_BOX_NULL_CAPTION.get());
}
return comboBoxModel;
}
/**
* Creates a combo box model containing the current values of the given column.
* This default implementation returns a sorted {@link FilteredComboBoxModel} with the default nullValueItem
* if the underlying column is nullable
* @param column the column
* @param the value type
* @return a combo box model based on the given column
*/
public FilteredComboBoxModel createComboBoxModel(Column column) {
requireNonNull(column, "column");
FilteredComboBoxModel comboBoxModel = createColumnComboBoxModel(column);
if (nullable(column)) {
comboBoxModel.includeNull().set(true);
if (column.type().valueClass().isInterface()) {
comboBoxModel.nullItem().set(ProxyBuilder.builder(column.type().valueClass())
.method("toString", parameters -> FilteredComboBoxModel.COMBO_BOX_NULL_CAPTION.get())
.build());
}
}
addInsertUpdateOrDeleteListener(comboBoxModel::refresh);
return comboBoxModel;
}
@Override
public final void add(ForeignKey foreignKey, Collection entities) {
requireNonNull(foreignKey);
requireNonNull(entities);
if (containsComboBoxModel(foreignKey)) {
EntityComboBoxModel comboBoxModel = foreignKeyComboBoxModel(foreignKey);
for (Entity inserted : entities) {
comboBoxModel.add(inserted);
}
}
}
@Override
public final void remove(ForeignKey foreignKey, Collection entities) {
requireNonNull(foreignKey);
requireNonNull(entities);
clearForeignKeyReferences(foreignKey, entities);
if (containsComboBoxModel(foreignKey)) {
EntityComboBoxModel comboBoxModel = foreignKeyComboBoxModel(foreignKey);
Entity selectedEntity = comboBoxModel.selectedValue();
entities.forEach(comboBoxModel::remove);
if (comboBoxModel.visible(selectedEntity)) {
comboBoxModel.setSelectedItem(selectedEntity);
}//if the null value is selected we're fine, otherwise select topmost item
else if (!comboBoxModel.nullSelected() && comboBoxModel.getSize() > 0) {
comboBoxModel.setSelectedItem(comboBoxModel.getElementAt(0));
}
else {
comboBoxModel.setSelectedItem(null);
}
}
}
@Override
protected void replaceForeignKey(ForeignKey foreignKey, Collection entities) {
super.replaceForeignKey(foreignKey, entities);
if (containsComboBoxModel(foreignKey)) {
EntityComboBoxModel comboBoxModel = foreignKeyComboBoxModel(foreignKey);
entities.forEach(foreignKeyValue -> comboBoxModel.replace(foreignKeyValue, foreignKeyValue));
}
}
private void clearForeignKeyReferences(ForeignKey foreignKey, Collection entities) {
entities.forEach(entity -> {
if (Objects.equals(entity, get(foreignKey))) {
put(foreignKey, null);
}
});
}
private FilteredComboBoxModel createColumnComboBoxModel(Column column) {
FilteredComboBoxModel comboBoxModel = new FilteredComboBoxModel<>();
comboBoxModel.refresher().itemSupplier().set(column.type().isEnum() ?
new EnumAttributeItemSupplier<>(column) :
new ColumnItemSupplier<>(connectionProvider(), column));
return comboBoxModel;
}
private static final class EnumAttributeItemSupplier implements Supplier> {
private final Collection items;
private EnumAttributeItemSupplier(Column column) {
items = asList(column.type().valueClass().getEnumConstants());
}
@Override
public Collection get() {
return items;
}
}
private static final class ColumnItemSupplier implements Supplier> {
private final EntityConnectionProvider connectionProvider;
private final Column column;
private ColumnItemSupplier(EntityConnectionProvider connectionProvider, Column column) {
this.connectionProvider = connectionProvider;
this.column = column;
}
@Override
public Collection get() {
try {
return connectionProvider.connection().select(column);
}
catch (DatabaseException e) {
throw new RuntimeException(e);
}
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy