openllet.examples.ClassTree Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of openllet-examples Show documentation
Examples of Openllet Usage
There is a newer version: 2.6.5
package openllet.examples;

import java.awt.Color;
import java.awt.Component;
import java.util.Collections;
import java.util.HashSet;
import java.util.Iterator;
import java.util.Set;
import javax.swing.JFrame;
import javax.swing.JScrollPane;
import javax.swing.JTree;
import javax.swing.WindowConstants;
import javax.swing.tree.DefaultMutableTreeNode;
import javax.swing.tree.DefaultTreeCellRenderer;
import javax.swing.tree.DefaultTreeModel;
import javax.swing.tree.TreeCellRenderer;
import openllet.jena.PelletInfGraph;
import openllet.jena.PelletReasonerFactory;
import org.apache.jena.ontology.OntClass;
import org.apache.jena.ontology.OntModel;
import org.apache.jena.ontology.OntResource;
import org.apache.jena.rdf.model.ModelFactory;
import org.apache.jena.vocabulary.OWL;

/**
 * An example to show how to use OWLReasoner class. This example creates a JTree that displays the class hierarchy. This is a simplified version of the class
 * tree displayed in SWOOP. usage: java ClassTree 
 *
 * @author Evren Sirin
 */
public class ClassTree
{
	private final OntModel _model;

	private Set _unsatConcepts;

	// render the classes using the prefixes from the _model
	private final TreeCellRenderer _treeCellRenderer = new DefaultTreeCellRenderer()
	{
		private static final long serialVersionUID = 5769333442039176739L;

		@Override
		@SuppressWarnings("unchecked")
		public Component getTreeCellRendererComponent(final JTree tree, final Object value, final boolean sel, final boolean expanded, final boolean leaf, final int row, final boolean hasFocusParam)
		{

			super.getTreeCellRendererComponent(tree, value, sel, expanded, leaf, row, hasFocusParam);

			final DefaultMutableTreeNode node = (DefaultMutableTreeNode) value;

			// each _node represents a set of classes
			final Set set = (Set) node.getUserObject();
			final StringBuffer label = new StringBuffer();

			// a set may contain one or more elements
			if (set.size() > 1)
				label.append("[");
			final Iterator i = set.iterator();

			// get the first one and add it to the label
			final OntResource first = i.next();
			label.append(_model.shortForm(first.getURI()));
			// add the rest (if they exist)
			while (i.hasNext())
			{
				final OntResource c = i.next();

				label.append(" = ");
				label.append(_model.shortForm(c.getURI()));
			}
			if (set.size() > 1)
				label.append("]");

			// show unsatisfiable concepts red
			if (_unsatConcepts.contains(first))
				setForeground(Color.RED);

			setText(label.toString());
			setIcon(getDefaultClosedIcon());

			return this;
		}

	};

	public ClassTree(final String ontology)
	{
		// create a reasoner
		_model = ModelFactory.createOntologyModel(PelletReasonerFactory.THE_SPEC);

		// create a _model for the ontology
		System.out.print("Reading...");
		_model.read(ontology);
		System.out.println("done");

		// load the _model to the reasoner
		System.out.print("Preparing...");
		_model.prepare();
		System.out.println("done");

		// compute the classification tree
		System.out.print("Classifying...");
		((PelletInfGraph) _model.getGraph()).getKB().classify();
		System.out.println("done");
	}

	public Set collect(final Iterator i)
	{
		final Set set = new HashSet<>();
		while (i.hasNext())
		{
			final OntResource res = (OntResource) i.next();
			if (res.isAnon())
				continue;

			set.add(res);
		}

		return set;
	}

	public JTree getJTree()
	{
		// Use OntClass for convenience
		final OntClass owlThing = _model.getOntClass(OWL.Thing.getURI());
		final OntClass owlNothing = _model.getOntClass(OWL.Nothing.getURI());

		// Find all unsatisfiable concepts, i.e classes equivalent
		// to owl:Nothing
		_unsatConcepts = collect(owlNothing.listEquivalentClasses());

		// create a tree starting with owl:Thing _node as the root
		final DefaultMutableTreeNode thing = createTree(owlThing);

		final Iterator i = _unsatConcepts.iterator();
		if (i.hasNext())
		{
			// We want to display every unsatisfiable concept as a
			// different _node in the tree
			final DefaultMutableTreeNode nothing = createSingletonNode(owlNothing);
			// iterate through unsatisfiable concepts and add them to
			// the tree
			while (i.hasNext())
			{
				final OntClass unsat = (OntClass) i.next();

				if (unsat.equals(owlNothing))
					continue;

				final DefaultMutableTreeNode node = createSingletonNode(unsat);
				nothing.add(node);
			}

			// add nothing as a child _node to owl:Thing
			thing.add(nothing);
		}

		// create the tree
		final JTree classTree = new JTree(new DefaultTreeModel(thing));
		classTree.setCellRenderer(_treeCellRenderer);

		// expand everything
		for (int r = 0; r < classTree.getRowCount(); r++)
			classTree.expandRow(r);

		return classTree;
	}

	/**
	 * Create a root node for the given concepts and add child nodes for the subclasses.
	 * 
	 * @param cls are classes of the tree.
	 * @return null for owl:Nothing
	 */
	private DefaultMutableTreeNode createTree(final OntClass cls)
	{
		if (_unsatConcepts.contains(cls))
			return null;

		final DefaultMutableTreeNode root = createNode(cls);

		final Set processedSubs = new HashSet<>();

		// get only direct subclasses
		final Iterator subs = cls.listSubClasses(true);
		while (subs.hasNext())
		{
			final OntClass sub = (OntClass) subs.next();

			if (sub.isAnon())
				continue;

			if (processedSubs.contains(sub))
				continue;

			final DefaultMutableTreeNode node = createTree(sub);
			// if set contains owl:Nothing tree will be null
			if (node != null)
			{
				root.add(node);
				add(processedSubs, node.getUserObject());
			}
		}

		return root;
	}

	@SuppressWarnings({ "rawtypes", "unchecked" })
	private void add(final Set processedSubs, Object set)
	{
		processedSubs.addAll((Set) set);
	}

	/**
	 * @param entity
	 * @return a new TreeNode for the given class
	 */
	private DefaultMutableTreeNode createSingletonNode(final OntResource cls)
	{
		return new DefaultMutableTreeNode(Collections.singleton(cls));
	}

	/**
	 * @param entity
	 * @return a new TreeNode for the given set of classes
	 */
	private DefaultMutableTreeNode createNode(final OntClass cls)
	{
		final Set eqs = collect(cls.listEquivalentClasses());

		return new DefaultMutableTreeNode(eqs);
	}

	public static void main(final String[] args) throws Exception
	{
		if (args.length == 0)
		{
			System.out.println("ERROR: No ontology URI given!");
			System.out.println("");
			System.out.println("usage: java ClassTree ");
			System.exit(0);
		}
		final ClassTree tree = new ClassTree(args[0]);

		final JFrame frame = new JFrame("Ontology Hierarchy");
		frame.getContentPane().add(new JScrollPane(tree.getJTree()));
		frame.setSize(800, 600);
		frame.setVisible(true);
		frame.setDefaultCloseOperation(WindowConstants.EXIT_ON_CLOSE);
	}
}