/*****************************************************************
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
****************************************************************/
package org.apache.cayenne.modeler.editor.dbentity;
import java.awt.BorderLayout;
import java.awt.CardLayout;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.awt.event.ItemEvent;
import java.awt.event.ItemListener;
import java.util.ArrayList;
import java.util.Collection;
import java.util.EventObject;
import java.util.Iterator;
import javax.swing.DefaultComboBoxModel;
import javax.swing.JButton;
import javax.swing.JComboBox;
import javax.swing.JLabel;
import javax.swing.JPanel;
import javax.swing.JTextField;
import javax.swing.JToolBar;
import org.apache.cayenne.access.DataDomain;
import org.apache.cayenne.map.DataMap;
import org.apache.cayenne.map.DbAttribute;
import org.apache.cayenne.map.DbEntity;
import org.apache.cayenne.map.DerivedDbEntity;
import org.apache.cayenne.map.event.EntityEvent;
import org.apache.cayenne.modeler.Application;
import org.apache.cayenne.modeler.ProjectController;
import org.apache.cayenne.modeler.action.CreateAttributeAction;
import org.apache.cayenne.modeler.action.CreateObjEntityAction;
import org.apache.cayenne.modeler.action.CreateRelationshipAction;
import org.apache.cayenne.modeler.action.DbEntitySyncAction;
import org.apache.cayenne.modeler.editor.ExistingSelectionProcessor;
import org.apache.cayenne.modeler.event.DbEntityDisplayListener;
import org.apache.cayenne.modeler.event.EntityDisplayEvent;
import org.apache.cayenne.modeler.util.CayenneWidgetFactory;
import org.apache.cayenne.modeler.util.CellRenderers;
import org.apache.cayenne.modeler.util.ProjectUtil;
import org.apache.cayenne.modeler.util.TextAdapter;
import org.apache.cayenne.util.Util;
import org.apache.cayenne.validation.ValidationException;
import com.jgoodies.forms.builder.DefaultFormBuilder;
import com.jgoodies.forms.layout.FormLayout;
/**
* Detail view of the DbEntity properties.
*
* @author Michael Misha Shengaout
* @author Andrei Adamchik
*/
public class DbEntityTab extends JPanel implements ExistingSelectionProcessor,
DbEntityDisplayListener {
static final String PK_DEFAULT_GENERATOR = "Default";
static final String PK_DB_GENERATOR = "Database-Generated";
static final String PK_CUSTOM_SEQUENCE_GENERATOR = "Custom Sequence";
static final String[] PK_GENERATOR_TYPES = new String[] {
PK_DEFAULT_GENERATOR, PK_DB_GENERATOR, PK_CUSTOM_SEQUENCE_GENERATOR
};
protected ProjectController mediator;
protected TextAdapter name;
protected TextAdapter schema;
protected JComboBox parentEntities;
protected JButton parentLabel;
protected JLabel schemaLabel;
protected JComboBox pkGeneratorType;
protected JPanel pkGeneratorDetail;
protected CardLayout pkGeneratorDetailLayout;
public DbEntityTab(ProjectController mediator) {
super();
this.mediator = mediator;
initView();
initController();
}
private void initView() {
JToolBar toolBar = new JToolBar();
Application app = Application.getInstance();
toolBar.add(app.getAction(CreateObjEntityAction.getActionName()).buildButton());
toolBar.add(app.getAction(DbEntitySyncAction.getActionName()).buildButton());
toolBar.addSeparator();
toolBar.add(app.getAction(CreateAttributeAction.getActionName()).buildButton());
toolBar
.add(app
.getAction(CreateRelationshipAction.getActionName())
.buildButton());
// create widgets
name = new TextAdapter(new JTextField()) {
protected void updateModel(String text) {
setEntityName(text);
}
};
schemaLabel = new JLabel("Schema:");
schema = new TextAdapter(new JTextField()) {
protected void updateModel(String text) throws ValidationException {
setSchema(text);
}
};
parentLabel = CayenneWidgetFactory.createLabelButton("Parent DbEntity:");
parentLabel.setEnabled(false);
parentEntities = CayenneWidgetFactory.createComboBox();
parentEntities.setEditable(false);
parentEntities.setEnabled(false);
pkGeneratorType = new JComboBox();
pkGeneratorType.setEditable(false);
pkGeneratorType.setModel(new DefaultComboBoxModel(PK_GENERATOR_TYPES));
pkGeneratorDetailLayout = new CardLayout();
pkGeneratorDetail = new JPanel(pkGeneratorDetailLayout);
pkGeneratorDetail
.add(new PKDefaultGeneratorPanel(mediator), PK_DEFAULT_GENERATOR);
pkGeneratorDetail.add(new PKDBGeneratorPanel(mediator), PK_DB_GENERATOR);
pkGeneratorDetail.add(
new PKCustomSequenceGeneratorPanel(mediator),
PK_CUSTOM_SEQUENCE_GENERATOR);
// assemble
FormLayout layout = new FormLayout("right:pref, 3dlu, fill:200dlu", "");
DefaultFormBuilder builder = new DefaultFormBuilder(layout);
builder.setDefaultDialogBorder();
builder.appendSeparator("DbEntity Configuration");
builder.append("DbEntity Name:", name.getComponent());
builder.append(schemaLabel, schema.getComponent());
builder.append(parentLabel, parentEntities);
builder.appendSeparator("Primary Key");
builder.append("PK Generation Strategy:", pkGeneratorType);
JPanel mainPanel = new JPanel();
mainPanel.setLayout(new BorderLayout());
mainPanel.add(builder.getPanel(), BorderLayout.NORTH);
mainPanel.add(pkGeneratorDetail, BorderLayout.CENTER);
setLayout(new BorderLayout());
add(toolBar, BorderLayout.NORTH);
add(mainPanel, BorderLayout.CENTER);
}
private void initController() {
mediator.addDbEntityDisplayListener(this);
parentEntities.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
DbEntity current = mediator.getCurrentDbEntity();
if (current instanceof DerivedDbEntity) {
DerivedDbEntity derived = (DerivedDbEntity) current;
DbEntity parent = (DbEntity) parentEntities.getSelectedItem();
if (parent != derived.getParentEntity()) {
derived.setParentEntity(parent);
derived.resetToParentView();
ProjectUtil.cleanObjMappings(mediator.getCurrentDataMap());
EntityEvent event = new EntityEvent(this, current);
mediator.fireDbEntityEvent(event);
}
}
}
});
parentLabel.addActionListener(new ActionListener() {
public void actionPerformed(ActionEvent e) {
DbEntity current = mediator.getCurrentDbEntity();
if (current instanceof DerivedDbEntity) {
DbEntity parent = ((DerivedDbEntity) current).getParentEntity();
if (parent != null) {
DataDomain dom = mediator.getCurrentDataDomain();
mediator.fireDbEntityDisplayEvent(new EntityDisplayEvent(
this,
parent,
parent.getDataMap(),
dom));
}
}
}
});
pkGeneratorType.addItemListener(new ItemListener() {
public void itemStateChanged(ItemEvent e) {
pkGeneratorDetailLayout.show(pkGeneratorDetail, (String) pkGeneratorType
.getSelectedItem());
for (int i = 0; i < pkGeneratorDetail.getComponentCount(); i++) {
if (pkGeneratorDetail.getComponent(i).isVisible()) {
DbEntity entity = mediator.getCurrentDbEntity();
PKGeneratorPanel panel = (PKGeneratorPanel) pkGeneratorDetail
.getComponent(i);
panel.onInit(entity);
break;
}
}
}
});
}
public void processExistingSelection(EventObject e) {
EntityDisplayEvent ede = new EntityDisplayEvent(this, mediator
.getCurrentDbEntity(), mediator.getCurrentDataMap(), mediator
.getCurrentDataDomain());
mediator.fireDbEntityDisplayEvent(ede);
}
public void currentDbEntityChanged(EntityDisplayEvent e) {
DbEntity entity = (DbEntity) e.getEntity();
if (entity == null) {
return;
}
// if entity hasn't changed, still notify PK Generator panels, as entity PK may
// have changed...
for (int i = 0; i < pkGeneratorDetail.getComponentCount(); i++) {
((PKGeneratorPanel) pkGeneratorDetail.getComponent(i)).setDbEntity(entity);
}
if (!e.isEntityChanged()) {
return;
}
name.setText(entity.getName());
schema.setText(entity.getSchema());
if (entity instanceof DerivedDbEntity) {
updateState(true);
// build a list consisting of non-derived entities
DataMap map = mediator.getCurrentDataMap();
Collection allEntities = map.getNamespace().getDbEntities();
java.util.List entities = new ArrayList(allEntities.size());
Iterator it = allEntities.iterator();
while (it.hasNext()) {
DbEntity parentEntity = (DbEntity) it.next();
if (!(parentEntity instanceof DerivedDbEntity)) {
entities.add(parentEntity);
}
}
DefaultComboBoxModel model = new DefaultComboBoxModel(entities.toArray());
model.setSelectedItem(((DerivedDbEntity) entity).getParentEntity());
parentEntities.setRenderer(CellRenderers.entityListRendererWithIcons(map));
parentEntities.setModel(model);
}
else {
String type = PK_DEFAULT_GENERATOR;
if (entity.getPrimaryKeyGenerator() != null) {
type = PK_CUSTOM_SEQUENCE_GENERATOR;
}
else {
Iterator it = entity.getPrimaryKey().iterator();
while (it.hasNext()) {
DbAttribute a = (DbAttribute) it.next();
if (a.isGenerated()) {
type = PK_DB_GENERATOR;
break;
}
}
}
updateState(false);
pkGeneratorType.setSelectedItem(type);
pkGeneratorDetailLayout.show(pkGeneratorDetail, type);
parentEntities.setSelectedIndex(-1);
}
}
/**
* Enables or disbales form fields depending on the type of entity shown.
*/
protected void updateState(boolean isDerivedEntity) {
schemaLabel.setEnabled(!isDerivedEntity);
schema.getComponent().setEnabled(!isDerivedEntity);
parentLabel.setEnabled(isDerivedEntity);
parentEntities.setEnabled(isDerivedEntity);
parentLabel.setVisible(isDerivedEntity);
parentEntities.setVisible(isDerivedEntity);
pkGeneratorDetail.setVisible(!isDerivedEntity);
pkGeneratorType.setVisible(!isDerivedEntity);
}
void setEntityName(String newName) {
if (newName != null && newName.trim().length() == 0) {
newName = null;
}
DbEntity entity = mediator.getCurrentDbEntity();
if (entity == null || Util.nullSafeEquals(newName, entity.getName())) {
return;
}
if (newName == null) {
throw new ValidationException("Entity name is required.");
}
else if (entity.getDataMap().getDbEntity(newName) == null) {
// completely new name, set new name for entity
EntityEvent e = new EntityEvent(this, entity, entity.getName());
entity.setName(newName);
// ProjectUtil.setDbEntityName(entity, newName);
mediator.fireDbEntityEvent(e);
}
else {
// there is an entity with the same name
throw new ValidationException("There is another entity with name '"
+ newName
+ "'.");
}
}
void setSchema(String text) {
if (text != null && text.trim().length() == 0) {
text = null;
}
DbEntity ent = mediator.getCurrentDbEntity();
if (ent != null && !Util.nullSafeEquals(ent.getSchema(), text)) {
ent.setSchema(text);
mediator.fireDbEntityEvent(new EntityEvent(this, ent));
}
}
}