org.semanticweb.elk.reasoner.taxonomy.impl.UpdateableTaxonomyNode Maven / Gradle / Ivy

Go to download
/*
 * #%L
 * ELK Reasoner
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2012 Department of Computer Science, University of Oxford
 * %%
 * 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%
 */
package org.semanticweb.elk.reasoner.taxonomy.impl;

import java.util.Set;

import org.semanticweb.elk.owl.interfaces.ElkEntity;
import org.semanticweb.elk.reasoner.taxonomy.model.GenericTaxonomyNode;
import org.semanticweb.elk.reasoner.taxonomy.model.NonBottomTaxonomyNode;

/**
 * Updateable generic taxonomy node that can be related with other nodes.
 * 
 * @author Pavel Klinov
 * 
 *         [email protected]
 * @author Peter Skocovsky
 *
 * @param 
 *            The type of members of this nodes.
 * @param 
 *            The immutable type of nodes with which this node may be
 *            associated.
 * @param 
 *            The mutable type of nodes with which this node may be associated.
 */
public interface UpdateableTaxonomyNode<
				T extends ElkEntity,
				N extends GenericTaxonomyNode,
				UN extends UpdateableTaxonomyNode
		>
		extends UpdateableNode, NonBottomTaxonomyNode {

	@Override
	Set getDirectNonBottomSuperNodes();
	
	@Override
	Set getDirectNonBottomSubNodes();
	
	/**
	 * Associates this node with its direct super-node.
	 * 
	 * @param superNode
	 *            The super-node with which this node should be associated.
	 */
	void addDirectSuperNode(UN superNode);

	/**
	 * Associates this node with its direct sub-node.
	 * 
	 * @param subNode
	 *            The sub-node with which this node should be associated.
	 */
	void addDirectSubNode(UN subNode);

	/**
	 * Deletes the association between this node and the specified sub-node.
	 * 
	 * @param subNode
	 *            The sub-node with which this node should not be associated.
	 * @return true if and only if this node changed.
	 */
	boolean removeDirectSubNode(UN subNode);

	/**
	 * Deletes the association between this node and the specified super-node.
	 * 
	 * @param superNode
	 *            The super-node with which this node should not be associated.
	 * @return true if and only if this node changed.
	 */
	boolean removeDirectSuperNode(UN superNode);

}