org.semanticweb.elk.reasoner.taxonomy.model.TaxonomyNodeUtils 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
/**
 * 
 */
package org.semanticweb.elk.reasoner.taxonomy.model;
/*
 * #%L
 * ELK Reasoner
 * $Id:$
 * $HeadURL:$
 * %%
 * Copyright (C) 2011 - 2013 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%
 */

import java.util.Collection;
import java.util.Collections;
import java.util.LinkedList;
import java.util.Queue;
import java.util.Set;

import org.semanticweb.elk.owl.interfaces.ElkObject;
import org.semanticweb.elk.util.collections.ArrayHashSet;

/**
 * A collection of utility methods, mostly for the frequent use case of
 * recursive traversal
 * 
 * @author Pavel Klinov
 * 
 *         [email protected]
 */
public class TaxonomyNodeUtils {
	
	/**
	 * 
	 * @author Pavel Klinov
	 *
	 * [email protected]
	 */
	interface GetSuccessors> {
		
		Set get(O node);
	}

	private static > Set getAllReachable(Collection direct, GetSuccessors succ) {		
		Set result = new ArrayHashSet(direct.size());
		Queue todo = new LinkedList();
		
		todo.addAll(direct);
		
		while (!todo.isEmpty()) {
			O next = todo.poll();
			
			if (result.add(next)) {
				for (O nextSuperNode : succ.get(next)) {
					todo.add(nextSuperNode);
				}
			}
		}
		
		return Collections.unmodifiableSet(result);
	}
	
	public static  Set> getAllSuperNodes(TaxonomyNode node) {
		return getAllReachable(node.getDirectSuperNodes(), new GetSuccessors> () {

			@Override
			public Set> get(TaxonomyNode node) {
				return node.getDirectSuperNodes();
			}});
	}
	
	public static  Set> getAllSubNodes(TaxonomyNode node) {
		return getAllReachable(node.getDirectSubNodes(), new GetSuccessors> () {

			@Override
			public Set> get(TaxonomyNode node) {
				return node.getDirectSubNodes();
			}});
	}	
	
	public static  Set> getAllUpdateableSubNodes(UpdateableTaxonomyNode node) {
		return getAllReachable(node.getDirectUpdateableSubNodes(), new GetSuccessors> () {

			@Override
			public Set> get(UpdateableTaxonomyNode node) {
				return node.getDirectUpdateableSubNodes();
			}});
	}
	
	public static  Set> getAllUpdateableSuperNodes(UpdateableTaxonomyNode node) {
		return getAllReachable(node.getDirectUpdateableSuperNodes(), new GetSuccessors> () {

			@Override
			public Set> get(UpdateableTaxonomyNode node) {
				return node.getDirectUpdateableSuperNodes();
			}});
	}	
	
	public static  Set> getAllUpdateableSuperNodes(UpdateableBottomNode node) {
		return getAllReachable(node.getDirectUpdateableSuperNodes(), new GetSuccessors> () {

			@Override
			public Set> get(UpdateableTaxonomyNode node) {
				return node.getDirectUpdateableSuperNodes();
			}});
	}

}