edu.stanford.smi.protege.widget.TemplateSlotsWidget Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of protege Show documentation
Show all versions of protege Show documentation
Core code for the Protege ontology editor. Serves as the basis for the Protege-Frames and Protege-OWL editors.
package edu.stanford.smi.protege.widget;
import java.awt.datatransfer.Transferable;
import java.awt.event.ActionEvent;
import java.util.ArrayList;
import java.util.Collection;
import java.util.Collections;
import java.util.Iterator;
import java.util.List;
import javax.swing.AbstractAction;
import javax.swing.Action;
import javax.swing.JComponent;
import javax.swing.JPopupMenu;
import javax.swing.TransferHandler;
import javax.swing.table.TableModel;
import edu.stanford.smi.protege.event.ClsAdapter;
import edu.stanford.smi.protege.event.ClsEvent;
import edu.stanford.smi.protege.event.ClsListener;
import edu.stanford.smi.protege.event.FrameAdapter;
import edu.stanford.smi.protege.event.FrameEvent;
import edu.stanford.smi.protege.event.FrameListener;
import edu.stanford.smi.protege.event.KnowledgeBaseAdapter;
import edu.stanford.smi.protege.event.KnowledgeBaseEvent;
import edu.stanford.smi.protege.event.KnowledgeBaseListener;
import edu.stanford.smi.protege.model.Cls;
import edu.stanford.smi.protege.model.Facet;
import edu.stanford.smi.protege.model.FrameSlotCombination;
import edu.stanford.smi.protege.model.Instance;
import edu.stanford.smi.protege.model.KnowledgeBase;
import edu.stanford.smi.protege.model.Model;
import edu.stanford.smi.protege.model.Slot;
import edu.stanford.smi.protege.resource.Icons;
import edu.stanford.smi.protege.resource.ResourceKey;
import edu.stanford.smi.protege.ui.CardinalityFacetRenderer;
import edu.stanford.smi.protege.ui.DisplayUtilities;
import edu.stanford.smi.protege.ui.OtherFacetsRenderer;
import edu.stanford.smi.protege.ui.SlotPairRenderer;
import edu.stanford.smi.protege.ui.TypeFacetRenderer;
import edu.stanford.smi.protege.util.AddAction;
import edu.stanford.smi.protege.util.AllowableAction;
import edu.stanford.smi.protege.util.CollectionUtilities;
import edu.stanford.smi.protege.util.CreateAction;
import edu.stanford.smi.protege.util.Log;
import edu.stanford.smi.protege.util.ModalDialog;
import edu.stanford.smi.protege.util.RemoveAction;
import edu.stanford.smi.protege.util.RowTableModel;
import edu.stanford.smi.protege.util.TransferableCollection;
import edu.stanford.smi.protege.util.ViewAction;
/**
* Slot widget for displaying the template slots. We try to display as much facet information as possible.
*
* @author Ray Fergerson
*/
public class TemplateSlotsWidget extends AbstractTableWidget {
private static final long serialVersionUID = 2572403293207051303L;
private AllowableAction _viewAction;
private AllowableAction _viewAtClsAction;
protected AllowableAction _createAction;
private AllowableAction _addAction;
private AllowableAction _removeAction;
private AllowableAction _removeOverrideAction;
private Collection _currentClsTemplateSlots;
private ClsListener _clsListener = new ClsAdapter() {
public void templateSlotAdded(ClsEvent event) {
Slot slot = event.getSlot();
slot.addFrameListener(_slotListener);
_currentClsTemplateSlots.add(slot);
reload();
}
public void templateSlotRemoved(ClsEvent event) {
Slot slot = event.getSlot();
slot.removeFrameListener(_slotListener);
_currentClsTemplateSlots.remove(slot);
reload();
}
public void templateFacetValueChanged(ClsEvent event) {
repaint();
}
public void directSuperclassAdded(ClsEvent event) {
reload();
}
public void directSuperclassRemoved(ClsEvent event) {
reload();
}
};
private FrameListener _slotListener = new FrameAdapter() {
public void ownSlotValueChanged(FrameEvent event) {
super.ownSlotValueChanged(event);
repaint();
}
};
private KnowledgeBaseListener _knowledgeBaseListener = new KnowledgeBaseAdapter() {
public void frameReplaced(KnowledgeBaseEvent event) {
reload();
}
};
protected void addInheritedTemplateSlots(Collection slots, Cls cls) {
// TODO we really want the superclasses breath first. getSuperclasses() returns an unordered set instead
Iterator i = cls.getSuperclasses().iterator();
while (i.hasNext()) {
Cls superclass = (Cls) i.next();
addDirectTemplateSlots(slots, superclass);
}
}
private void addSlots(Collection c) {
Cls cls = getBoundCls();
Iterator i = c.iterator();
while (i.hasNext()) {
Slot slot = (Slot) i.next();
addDirectTemplateSlot(cls, slot);
}
}
private void addDirectTemplateSlot(Cls cls, Slot slot) {
cls.addDirectTemplateSlot(slot);
// allow this "slot on a slot" to be overriden
if (cls.isSlotMetaCls() && slot.getAssociatedFacet() == null) {
Facet facet = getKnowledgeBase().createFacet(null);
slot.setAssociatedFacet(facet);
}
}
private boolean isSorting() {
return !hasButton(Icons.getUpIcon());
}
protected void addTemplateSlots(Collection slots, Cls cls) {
List templateSlots = new ArrayList(cls.getVisibleTemplateSlots());
if (isSorting()) {
Collections.sort(templateSlots);
}
slots.addAll(templateSlots);
}
private static void addDirectTemplateSlots(Collection slots, Cls cls) {
Iterator i = getDirectTemplateSlots(cls).iterator();
while (i.hasNext()) {
Slot slot = (Slot) i.next();
if (!slots.contains(slot)) {
slots.add(slot);
}
}
}
private static Collection getDirectTemplateSlots(Cls cls) {
return cls.getDirectTemplateSlots();
// return cls.getOwnSlotValues(getSlot());
}
private void changeSlotIndex(Slot slot, int delta) {
List slots = (List) getBoundCls().getDirectTemplateSlots();
int oldIndex = slots.indexOf(slot);
int newIndex = oldIndex + delta;
if (0 <= newIndex && newIndex < slots.size()) {
getBoundCls().moveDirectTemplateSlot(slot, newIndex);
reload();
}
}
private Action createMoveDownAction() {
return new AbstractAction("Move down", Icons.getDownIcon()) {
private static final long serialVersionUID = -2706470541341140481L;
{
putValue(Action.SHORT_DESCRIPTION, "Move selected slot down");
}
public void actionPerformed(ActionEvent event) {
handleMoveDownAction();
}
};
}
private Action createMoveUpAction() {
return new AbstractAction("Move up", Icons.getUpIcon()) {
private static final long serialVersionUID = -5564065775845561448L;
{
putValue(Action.SHORT_DESCRIPTION, "Move selected slot up");
}
public void actionPerformed(ActionEvent event) {
handleMoveUpAction();
}
};
}
public TableModel createTableModel() {
List slots;
Cls cls = (Cls) getInstance();
if (cls == null) {
slots = Collections.EMPTY_LIST;
} else {
slots = getSlots(cls);
}
RowTableModel model = new RowTableModel(getTable());
Iterator i = slots.iterator();
while (i.hasNext()) {
Slot slot = (Slot) i.next();
FrameSlotCombination o = new FrameSlotCombination(cls, slot);
model.addRow(o);
}
return model;
}
public void dispose() {
super.dispose();
getKnowledgeBase().removeKnowledgeBaseListener(_knowledgeBaseListener);
Cls cls = (Cls) getInstance();
if (cls != null) {
cls.removeClsListener(_clsListener);
}
}
public Action getAddSlotsAction() {
_addAction = new AddAction(ResourceKey.SLOT_ADD) {
private static final long serialVersionUID = 1413481816474864898L;
public void onAdd() {
Cls slotMetaCls = getBaseAllowedSlotMetaCls();
List slots = new ArrayList(getKnowledgeBase().getInstances(slotMetaCls));
slots.removeAll(getBoundCls().getTemplateSlots());
String label = "Select " + getLabel();
addSlots(DisplayUtilities.pickSlots(TemplateSlotsWidget.this, slots, label));
}
};
return _addAction;
}
@SuppressWarnings("unchecked")
private Cls getBaseAllowedSlotMetaCls() {
Collection allowedClses = getBoundCls().getDirectType().getTemplateSlotAllowedClses(getSlot());
return (Cls) CollectionUtilities.getFirstItem(allowedClses);
}
protected Cls getBaseSlotMetaCls() {
Cls baseSlotMetaCls;
Cls kbSlotMetaCls = getKnowledgeBase().getDefaultSlotMetaCls();
Cls facetSlotMetaCls = getBaseAllowedSlotMetaCls();
if (kbSlotMetaCls.hasSuperclass(facetSlotMetaCls)) {
baseSlotMetaCls = kbSlotMetaCls;
} else {
baseSlotMetaCls = facetSlotMetaCls;
}
return baseSlotMetaCls;
}
private Cls getBoundCls() {
return (Cls) getInstance();
}
protected Action getCreateSlotAction() {
_createAction = new CreateAction(ResourceKey.SLOT_CREATE) {
private static final long serialVersionUID = 2685200630532658984L;
public void onCreate() {
Cls cls = getBoundCls();
if (cls.isEditable()) {
KnowledgeBase kb = getKnowledgeBase();
Cls slotMetaCls = kb.getDefaultSlotMetaCls();
if (slotMetaCls == null || !getBaseSlotMetaCls().equals(slotMetaCls)) {
Collection allowedClses = cls.getDirectType().getTemplateSlotAllowedClses(getSlot());
slotMetaCls = DisplayUtilities.pickConcreteCls(TemplateSlotsWidget.this, getKnowledgeBase(),
allowedClses);
}
if (slotMetaCls != null) {
Slot slot = getKnowledgeBase().createSlot(null, slotMetaCls);
addDirectTemplateSlot(cls, slot);
showInstance(slot);
}
}
}
};
return _createAction;
}
public Action getDoubleClickAction() {
return new AbstractAction() {
private static final long serialVersionUID = 940934952598817850L;
public void actionPerformed(ActionEvent event) {
FrameSlotCombination c = (FrameSlotCombination) CollectionUtilities.getFirstItem(getSelection());
if (c != null) {
SlotViewPanel panel = new SlotViewPanel();
int result = ModalDialog.showDialog(TemplateSlotsWidget.this, panel, "Select Slot View",
ModalDialog.MODE_OK_CANCEL);
if (result == ModalDialog.OPTION_OK) {
if (panel.viewTopLevelSlot()) {
_viewAction.actionPerformed(event);
} else {
_viewAtClsAction.actionPerformed(event);
}
}
}
}
};
}
// private int getInitialMaxWidth() {
// int tableWidth = getTable().getWidth();
// int viewPortWidth = getWidth() - (getInsets().left + getInsets().right + 3);
// int currentWidth = getTable().getColumnModel().getColumn(4).getWidth();
// int initialWidth = currentWidth + (viewPortWidth - tableWidth);
// return initialWidth;
// }
public JPopupMenu getPopupMenu() {
JPopupMenu menu = new JPopupMenu();
menu.add(_viewAction);
menu.add(_viewAtClsAction);
menu.add(_createAction);
menu.add(_addAction);
menu.add(_removeAction);
return menu;
}
public Action getRemoveOverrideAction() {
_removeOverrideAction = new AllowableAction(ResourceKey.SLOT_REMOVE_FACET_OVERRIDES, this) {
private static final long serialVersionUID = -4145394593794210979L;
public void actionPerformed(ActionEvent event) {
Iterator i = this.getSelection().iterator();
while (i.hasNext()) {
FrameSlotCombination pair = (FrameSlotCombination) i.next();
((Cls) pair.getFrame()).removeTemplateFacetOverrides(pair.getSlot());
}
}
};
return _removeOverrideAction;
}
public Action getRemoveSlotsAction() {
_removeAction = new RemoveAction(ResourceKey.SLOT_REMOVE, this) {
private static final long serialVersionUID = -5482243741134967499L;
public void onRemove(Collection combinations) {
handleRemoveCombinations(combinations);
}
public void onSelectionChange() {
Object o = CollectionUtilities.getFirstItem(this.getSelection());
FrameSlotCombination combination = (FrameSlotCombination) o;
Slot slot = (combination == null) ? (Slot) null : combination.getSlot();
setAllowed(slot != null && getBoundCls().hasDirectTemplateSlot(slot));
}
};
return _removeAction;
}
protected void handleRemoveCombinations(Collection combinations) {
try {
Cls cls = getCls();
beginTransaction("Remove slots from " + cls, (cls == null ? null : cls.getName()));
Iterator i = combinations.iterator();
while (i.hasNext()) {
FrameSlotCombination combination = (FrameSlotCombination) i.next();
handleRemoveCombination(combination);
}
commitTransaction();
} catch (Exception e) {
rollbackTransaction();
Log.getLogger().warning("Problem at removing slots from " + getCls());
}
}
private static void handleRemoveCombination(FrameSlotCombination combination) {
Cls cls = (Cls) combination.getFrame();
Slot slot = combination.getSlot();
cls.removeDirectTemplateSlot(slot);
}
private Slot getSelectedDirectSlot() {
Slot slot = getSelectedSlot();
boolean isDirect = getBoundCls().hasDirectTemplateSlot(slot);
return isDirect ? slot : null;
}
private Slot getSelectedSlot() {
Slot slot = null;
Collection c = getSelection();
if (c.size() == 1) {
FrameSlotCombination combo = (FrameSlotCombination) CollectionUtilities.getFirstItem(c);
slot = combo.getSlot();
}
return slot;
}
protected List getSlots(Cls cls) {
List slots = new ArrayList();
addTemplateSlots(slots, cls);
return slots;
}
private Action getViewSlotAction() {
_viewAction = new ViewAction(ResourceKey.SLOT_VIEW_TOP_LEVEL, this) {
private static final long serialVersionUID = 7903942567777207326L;
public void onView(Object o) {
FrameSlotCombination combination = (FrameSlotCombination) o;
showInstance(combination.getSlot());
}
};
return _viewAction;
}
private Action getViewSlotAtClassAction() {
_viewAtClsAction = new ViewAction(ResourceKey.SLOT_VIEW_FACET_OVERRIDES, this) {
private static final long serialVersionUID = -309920053960064704L;
public void onView(Object o) {
FrameSlotCombination combination = (FrameSlotCombination) o;
show((Cls) combination.getFrame(), combination.getSlot());
}
};
return _viewAtClsAction;
}
protected void handleMoveDownAction() {
Slot slot = getSelectedDirectSlot();
if (slot != null) {
changeSlotIndex(slot, +1);
}
}
protected void handleMoveUpAction() {
Slot slot = getSelectedDirectSlot();
if (slot != null) {
changeSlotIndex(slot, -1);
}
}
public void initialize() {
Action viewSlotAction = getViewSlotAction();
super.initialize(getDoubleClickAction());
addButton(viewSlotAction);
addButton(getViewSlotAtClassAction());
addButton(getCreateSlotAction());
addButton(getRemoveOverrideAction());
addButton(getAddSlotsAction());
addButton(getRemoveSlotsAction());
addButton(createMoveUpAction(), false);
addButton(createMoveDownAction(), false);
addColumn(200, ResourceKey.TEMPLATE_SLOTS_SLOT_WIDGET_NAME, SlotPairRenderer.createInstance());
addColumn(80, ResourceKey.TEMPLATE_SLOTS_SLOT_WIDGET_CARDINALITY, new CardinalityFacetRenderer(
getKnowledgeBase()));
addColumn(200, ResourceKey.TEMPLATE_SLOTS_SLOT_WIDGET_TYPE, new TypeFacetRenderer());
addColumn(400, ResourceKey.TEMPLATE_SLOTS_SLOT_WIDGET_OTHER_FACETS, new OtherFacetsRenderer());
getTable().setAutoCreateColumnsFromModel(false);
getKnowledgeBase().addKnowledgeBaseListener(_knowledgeBaseListener);
setupDragAndDrop();
}
private void setupDragAndDrop() {
getTable().setDragEnabled(true);
getTable().setTransferHandler(new MyTransferHandler());
}
private class MyTransferHandler extends TransferHandler {
private static final long serialVersionUID = -3916638445633449129L;
private Collection getTransferableCombinations() {
Collection transferableCombinations = new ArrayList(getSelection());
Iterator i = transferableCombinations.iterator();
while (i.hasNext()) {
FrameSlotCombination combo = (FrameSlotCombination) i.next();
Cls cls = (Cls) combo.getFrame();
Slot slot = combo.getSlot();
if (!cls.hasDirectTemplateSlot(slot)) {
transferableCombinations.clear();
break;
}
}
return transferableCombinations;
}
protected Transferable createTransferable(JComponent c) {
Collection collection = getTransferableCombinations();
return collection.isEmpty() ? null : new TransferableCollection(collection);
}
protected void exportDone(JComponent source, Transferable data, int action) {
if (action == MOVE) {
Iterator i = getTransferableCombinations().iterator();
while (i.hasNext()) {
FrameSlotCombination combo = (FrameSlotCombination) i.next();
((Cls) combo.getFrame()).removeDirectTemplateSlot(combo.getSlot());
}
}
}
public int getSourceActions(JComponent c) {
return COPY_OR_MOVE;
}
};
public static boolean isSuitable(Cls cls, Slot slot, Facet facet) {
boolean isMetacls = cls.isClsMetaCls();
Slot templateSlotsSlot = slot.getKnowledgeBase().getSlot(Model.Slot.DIRECT_TEMPLATE_SLOTS);
return isMetacls && (slot.equals(templateSlotsSlot) || slot.hasSuperslot(templateSlotsSlot));
}
public void setEditable(boolean b) {
_createAction.setAllowed(b);
_addAction.setAllowed(b);
_removeAction.setAllowed(b);
_removeOverrideAction.setAllowed(b);
}
public void setInstance(Instance instance) {
Cls currentCls = (Cls) getInstance();
if (currentCls != null) {
currentCls.removeClsListener(_clsListener);
Iterator i = _currentClsTemplateSlots.iterator();
while (i.hasNext()) {
Slot slot = (Slot) i.next();
slot.removeFrameListener(this._slotListener);
}
}
super.setInstance(instance);
if (instance != null) {
Cls cls = (Cls) instance;
cls.addClsListener(_clsListener);
_currentClsTemplateSlots = new ArrayList(cls.getTemplateSlots());
Iterator i = _currentClsTemplateSlots.iterator();
while (i.hasNext()) {
Slot slot = (Slot) i.next();
slot.addFrameListener(this._slotListener);
}
}
}
public String getLabel() {
return localizeStandardLabel(super.getLabel(), "Template Slots", ResourceKey.TEMPLATE_SLOTS_SLOT_WIDGET_LABEL);
}
public String toString() {
return "TemplateSlotsWidget";
}
} © 2015 - 2025 Weber Informatics LLC | Privacy Policy