org.semanticweb.owlapi.reasoner.OWLReasonerFactoryRegistry Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of owlapi-api Show documentation
The newest version!
/**
 * 
 */
package org.semanticweb.owlapi.reasoner;

import java.util.ArrayList;
import java.util.Collection;
import java.util.HashSet;
import java.util.List;

import org.semanticweb.owlapi.profiles.OWLProfile;

import com.github.ansell.abstractserviceloader.AbstractServiceLoader;

/**
 * Provides a registry for reasoners so they can be accessed using Service Provider Interface
 * methods.
 * 
 * @author Peter Ansell [email protected]
 * 
 */
public class OWLReasonerFactoryRegistry extends AbstractServiceLoader
{
    private static final OWLReasonerFactoryRegistry instance = new OWLReasonerFactoryRegistry();
    
    public OWLReasonerFactoryRegistry()
    {
        super(OWLReasonerFactory.class);
    }
    
    /**
     * NOTE: This singleton instance is not mandatory, and users are encouraged to create additional
     * instances if they do not want to use all of the reasoners available on the classpath for
     * particular applications.
     * 
     * @return the reasoner factory registry
     */
    public static OWLReasonerFactoryRegistry getInstance()
    {
        return instance;
    }
    
    /**
     * clear all registered reasoner factories
     */
    public void clearReasonerFactories()
    {
        this.clear();
    }
    
    /**
     * @return the list of reasoners - changes will not be backed by the factory
     */
    public List getReasonerFactories()
    {
        return new ArrayList(this.getAll());
    }
    
    public OWLReasonerFactory getReasonerFactory(String key)
    {
        Collection collection = get(key);
        
        if(collection.isEmpty())
        {
            return null;
        }
        else
        {
            return collection.iterator().next();
        }
    }
    
    /**
     * Returns all of the registered OWLReasonerFactory objects that support the given OWLProfile.
     * 
     * @param profile
     *            The OWLProfile to support.
     * @return A collection of reasoner factories that can create reasoners which support the given
     *         profiles.
     */
    public Collection getReasonerFactoriesByProfile(OWLProfile profile)
    {
        Collection results = new HashSet();
        
        for(OWLReasonerFactory nextFactory : getAll())
        {
            if(nextFactory.getSupportedProfiles().contains(profile))
            {
                results.add(nextFactory);
            }
        }
        
        return results;
    }
    
    /**
     * @param reasonerFactory
     *            the reasoner factory to register
     */
    public void registerReasonerFactory(OWLReasonerFactory reasonerFactory)
    {
        this.add(reasonerFactory);
    }
    
    /**
     * @param reasonerFactory
     *            the reasoner factory to remove
     */
    public void unregisterReasonerFactory(OWLReasonerFactory reasonerFactory)
    {
        this.remove(reasonerFactory);
    }
    
    @Override
    public String getKey(OWLReasonerFactory service)
    {
        return service.getReasonerName();
    }
    
}