org.semanticweb.elk.reasoner.taxonomy.model.Taxonomy Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of elk-reasoner Show documentation

ELK consequence-based reasoning engine

There is a newer version: 0.4.3

/*
 * #%L
 * elk-reasoner
 * 
 * $Id$
 * $HeadURL$
 * %%
 * Copyright (C) 2011 Oxford University Computing Laboratory
 * %%
 * Licensed 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.
 * #L%
 */
/**
 * @author Yevgeny Kazakov, May 15, 2011
 */
package org.semanticweb.elk.reasoner.taxonomy.model;

import java.util.Set;

import org.semanticweb.elk.owl.interfaces.ElkObject;

/**
 * A hierarchy of certain ElkObjects. For each such object, the taxonomy holds a
 * {@link TaxonomyNode} object from which direct sub- and super- nodes can be
 * retrieved.
 * 
 * @author Yevgeny Kazakov
 * @author Markus Kroetzsch
 * @author Frantisek Simancik
 * @param 
 *            the type of objects stored in this taxonomy
 */
public interface Taxonomy {

	/**
	 * Returns the {@link TaxonomyNode} containing the given {@link ElkObject}
	 * as a member or {@code null} if the input does not occur in the taxonomy.
	 * 
	 * @param elkObject
	 *            the {@link ElkObject} for which to return the
	 *            {@link TaxonomyNode}
	 * @return the {@link TaxonomyNode} for the specified input
	 *         {@link ElkObject}
	 */
	public TaxonomyNode getNode(T elkObject);

	/**
	 * Obtain an unmodifiable Set of all nodes in this taxonomy.
	 * 
	 * @return an unmodifiable Collection
	 */
	public Set> getNodes();

	/**
	 * 
	 * @return the node of this taxonomy that has no parent nodes
	 */
	public TaxonomyNode getTopNode();

	/**
	 * 
	 * @return the node of this taxonomy that has no child nodes
	 */
	public TaxonomyNode getBottomNode();

}