Modifications to Protege - nononing2014/repoProtege GitHub Wiki

//Package on which this file is included
package org.protege.editor.owl.ui.view.relation;

//Some imports. I don't want to clutter this documentation with all imports so I have include only one import. For complete set of imports see original file.
import org.protege.editor.owl.ui.list.OWLAxiomList;

// Every view component in Protege must extend AbstractOWLViewComponent. As it provides necessary APIs for proper working of view component in question.
public class OWLRelationViewComponent extends AbstractOWLViewComponent {

        // Version ID
        private static final long serialVersionUID = -4515710047558710080L;

        // java logger for debugging and outputting error messages. 
        private static final Logger log = Logger.getLogger(OWLRelationViewComponent.class);

        // OWLRelationList is extension to JList of swing library created by us display a list of relations.
        private OWLRelationList list;

        // Holds current ontology.
        private OWLOntology actOnt;
	
        // Declares a relation change listener which will be called when a relation is changed. This is explained in section concerning OWLAPI.
	private OWLRelationChangeListener relListner = new OWLRelationChangeListener(){
		public void relationChanged(String changeType, OWLRelation rel){
			reload();
		}
	};
	
        // Listener that will be called when selection in a list will be changed. This is standard listener provided by swing library of java.
	private ListSelectionListener relSelListener = new ListSelectionListener(){
        
        // Function that is called when a selection is changed
        public void valueChanged(ListSelectionEvent e) {
           
            // Selection Model in protege stores which entity is selected in UI. I have made some modifications to selection model also I will explain it later. In this line I am telling selection model to store selected relation in it's memory.
            getOWLWorkspace().getOWLSelectionModel().setSelectedRelation(list.getSelectedValue());
        }
    };
	

// Called when initializing this view.	
    @Override
    protected void initialiseOWLView() throws Exception {

        // See swing documentation for this line.
        setLayout(new BorderLayout());

	// Create a new OWLRelationList that is extension to JList of swing. It is created by us and I will explain it later.
	list = new OWLRelationList(getOWLEditorKit());

        // Get active ontology from protege editor kit.
	actOnt = getOWLEditorKit().getOWLModelManager().getActiveOntology();

        // Add relation chnage listener in current ontology. I explained this in explanation of OWLAPI.
	actOnt.addRelationChangeListner(relListner);

        // Function declared later int this file to reload our UI.
	reload();

        // Our UI has two buttons in top they are to delete a relation and add a relation setup both buttons.
	setupActions();

        // Create a scroll pane from list of relation. See documentation of swing library.
	add(ComponentFactory.createScrollPane(list));

        // Add selection listener to given list. It is API provided by JList of swing. It will be triggered when a selcetion is changed
	list.addListSelectionListener(relSelListener);
    }

       // Called when this view is being deleted.
	@Override
	protected void disposeOWLView() {

                //Remove all selection listener
		list.removeListSelectionListener(relSelListener);
		actOnt.removeRelationChangeListner(relListner);
	}
	
        // Reload our UI
	private void reload(){

        // Get active ontology
        actOnt = getOWLModelManager().getActiveOntology();

        // Get set of relations from active ontology.
        java.util.List<OWLRelation> relationList = actOnt.getAllRelations();

        // Include all these relations in our list thereby displaying all relations in active ontology.
        list.setListData(relationList.toArray(new OWLRelation[relationList.size()]));
    }
	
	    private void setupActions() {

            // Add new relation button. Provided by swing in java.
        final DisposableAction addDatatypeAction = new DisposableAction("Add relation", OWLIcons.getIcon("datarange.add.png")) {
            
            private static final long serialVersionUID = 7152977701137488187L;

            // Create a new relation.
            public void actionPerformed(ActionEvent event) {
                createNewRelation();
            }

            public void dispose() {
                // do nothing
            }
        };

        // Create a delete button.
        final OWLSelectionViewAction deleteDatatypeAction = new OWLSelectionViewAction("Delete relation", OWLIcons.getIcon("datarange.remove.png")) {

            /**
             * 
             */
            private static final long serialVersionUID = 5359788681251086828L;

            // Delete selected relation
            public void actionPerformed(ActionEvent event) {
                deleteRelation();
            }

            // Don't activate this button unless something is selected/highlighted
            public void updateState() {
                // @@TODO should check if this is a built in datatype
                setEnabled(list.getSelectedIndex() != -1);
            }


            public void dispose() {
                // do nothing
            }
        };

        // Add both buttons in our view
        addAction(addDatatypeAction, "A", "A");
        addAction(deleteDatatypeAction, "B", "A");
    }

        // Called when a new relation button is pressed.
	public void createNewRelation(){
                // Invoke newRelationCreationPanel. I will explain this later.
		newRelationCreationPanel.showDialog(getOWLEditorKit(), "Please enter a datatype name");
	}
	
        // Delete all selected relations.
	public void deleteRelation(){
		for(OWLRelation rel : list.getSelectedOWLObjects())
                        // Remove relation is explained in OWLAPI documentation.
			actOnt.removeRelation(rel.toString());
	}
}

//Package on which this file is included.
package org.protege.editor.owl.ui.view.relation;

//Some imports. I don't want to clutter this documentation with all imports so I have include only one import. For complete set of imports see original file.
import org.protege.editor.owl.OWLEditorKit;

// Extends JList of swing library.
public class OWLRelationList extends JList<OWLRelation> {
    private static final long serialVersionUID = -817749022854204056L;


    public OWLRelationList(OWLEditorKit owlEditorKit) {
        // Get simple cell renderer. This function is provided by protege to create a renderer for JList. We slightly modified it to render our relations, we will explain this later.
        setCellRenderer(new OWLCellRendererSimple(owlEditorKit));
    }

//Get tool tip message for a relation in a list.
    public String getToolTipText(MouseEvent event) {
        int index = locationToIndex(event.getPoint());
        if (index >= 0){
            Object element = getModel().getElementAt(index);
            if (element != null && element instanceof OWLRelation){
                return ((OWLRelation)element).getName();
            }
        }
        return null;
    }


// Set selected values in given list
    public void setSelectedValues(Set<OWLRelation> owlRelations, boolean shouldScroll) {
        getSelectionModel().clearSelection();
        if (getSelectionMode() == ListSelectionModel.MULTIPLE_INTERVAL_SELECTION){
            int firstIndex = -1;
            for (int i=0; i<getModel().getSize(); i++){
                if (owlRelations.contains(getModel().getElementAt(i))){
                    getSelectionModel().addSelectionInterval(i, i);
                    if (firstIndex == -1){
                        firstIndex = i;
                    }
                }
            }
            if (shouldScroll && firstIndex != -1){
                scrollRectToVisible(new Rectangle(getCellBounds(firstIndex, firstIndex)));
            }
        }
    }

// Get selected objects in given list
    @SuppressWarnings("unchecked")
    public java.util.List<OWLRelation> getSelectedOWLObjects(){
        List<OWLRelation> sel = new ArrayList<OWLRelation>();
        for (Object o : getSelectedValues()){
            sel.add((OWLRelation) o);
        }
        return sel;
    }
}

// Import this as it is required.
import org.protege.editor.owl.model.selection.OWLRelationSelectionListener;

// Panel name for relations
private static final String RELATIONS_PANEL = "Relations";

//Create a listener that will be called when a selection is changed in relation panel.
private OWLRelationSelectionListener RelSelListener = new OWLRelationSelectionListener() {
				public void selectionChanged() throws Exception {
                processRelationSelection();
            }
	};

 protected void initialiseOWLView() throws Exception {
         ::
         // Add our relation selection listener
	 getOWLWorkspace().getOWLSelectionModel().addListener(RelSelListener);
         ::
         // Add characteristic view component that we created earlier to list of panels. 
         addPane(RELATIONS_PANEL,
                "/selected-entity-view-relation-panel.xml",
                "org.protege.editor.owl.ui.view.selectedentityview.relations",
                reset);

 }

// Whenever a relation selection change occur select our relation panel
private void processRelationSelection(){
	selectPanel(RELATIONS_PANEL);
}

// When this view is deleted remove out list selection change listener
  protected void disposeOWLView() {
        ::
	getOWLWorkspace().getOWLSelectionModel().removeListener(RelSelListener);
  }

// Import these libraries as we will use it later
import org.protege.editor.owl.ui.OWLIcons;
import org.semanticweb.owlapi.model.OWLRelation;

private void setText(Object value, JLabel renderer) {
        ::
        // If entity you are rendering is a OWLRelation display its name as text
	else if(value instanceof OWLRelation){
		OWLRelation obj = (OWLRelation) value;
		renderer.setText(obj.getName());
	}
}

private void setIcon(Object value, JLabel renderer) {
        ::
        // If entity you are rendering is OWLRelation put "datarange.png" as its icon.
	else if(value instanceof OWLRelation){
		renderer.setIcon(OWLIcons.getIcon("datarange.png"));
	}
}

// A list maintaining listeners that need to be triggered when a selection is changed
private List<OWLRelationSelectionListener> relListeners;

//Last selected relation
private OWLRelation lastRelation;

public OWLSelectionModelImpl() {
     ::
     // Initialize list of selection listeners.
     relListeners = new ArrayList<OWLRelationSelectionListener>();
     ::
}

// Add a listener to list of listener
public void addListener(OWLRelationSelectionListener listener) {
        if (listener == null) {
            throw new IllegalArgumentException("Listener must not be null!");
        }
        relListeners.add(listener);
}

// Remove a listener
public void removeListener(OWLRelationSelectionListener listener) {
     relListeners.remove(listener);
}

// Set last selected relation
public void setSelectedRelation(OWLRelation rel){
	if (rel == null) {
            if (lastRelation != null) {
                updateSelectedRelation(null);
            }
        }
        else {
            if (lastRelation == null) {
                updateSelectedRelation(rel);
            }
            else if (!rel.toString().equals(lastRelation.toString())) {
                updateSelectedRelation(rel);
            }
        }
}

// Set last selected relation and fire all change listeners
private void updateSelectedRelation(OWLRelation rel){
	lastRelation = rel;
	fireRelationSelectionChanged();
}

// Fire all relation selection listeners added in this model
private void fireRelationSelectionChanged(){
		for (OWLRelationSelectionListener listener : new ArrayList<OWLRelationSelectionListener>(relListeners)) {
            try {
                listener.selectionChanged();
            }
            catch (Exception e) {
                logger.warn("BAD LISTENER: (" + listener.getClass().getSimpleName() + ") ");
                ProtegeApplication.getErrorLog().handleError(Thread.currentThread(), e);
            }
        }
}