au.csiro.ontology.classification.IReasoner Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of ontology-model Show documentation
The newest version!
package au.csiro.ontology.classification;

import java.io.OutputStream;
import java.util.Iterator;
import java.util.Set;

import au.csiro.ontology.Ontology;
import au.csiro.ontology.model.Axiom;

/**
 * This interface represents the functionality of a reasoner. It uses the internal ontology model. This interface is 
 * included in this package because it could have several implementations.
 * 
 * @author Alejandro Metke
 *
 */
public interface IReasoner {
    
    /**
     * Loads and indexes the supplied axioms.
     * 
     * @param axioms
     */
    public void loadAxioms(Set axioms);
    
    /**
     * Loads and indexes the supplied axioms.
     * 
     * @param axioms
     */
    public void loadAxioms(Iterator axioms);
    
    /**
     * Loads and indexes the supplied axioms.
     * 
     * @param axioms
     */
    public void loadAxioms(Ontology ont);
    
    /**
     * Classifies the current axioms.
     * 
     * @return
     */
    public IReasoner classify();
    
    /**
     * Removes all the state in the classifier except the taxonomy generated
     * after classification. If the classification process has not been run then
     * this method has no effect. Once pruned, it is no longer possible to run
     * an incremental classification. Doing so will generate a 
     * {@link RuntimeException}.
     */
    public void prune();
    
    /**
     * Returns an {@link IOntology} that represents the generated taxonomy. 
     * If no axioms have yet been classified it throws a 
     * {@link RuntimeException}.
     * 
     * @return The classified ontology.
     */
    public Ontology getClassifiedOntology();
    
    /**
     * Returns an {@link IOntology} that represents the generated taxonomy. 
     * If no axioms have yet been classified it throws a 
     * {@link RuntimeException}.
     * 
     * @return The classified ontology.
     */
    public Ontology getClassifiedOntology(Ontology ont);
    
    /**
     * Saves this reasoner to the specified {@link OutputStream}.
     * 
     * @param out The {@link OutputStream}.
     */
    public void save(OutputStream out);
    
    /**
     * Determines if the ontology has been classified.
     * 
     * @return boolean True if the ontology has been classified or false if it
     * hasn't.
     */
    public boolean isClassified();

}