c_normalisation.java

normkit is a set of tools supporting ontology learning. from xml,xsd to rdfs.

package it.itc.ectrl.normkit.cnorm.api;

import edu.unika.aifb.kaon.api.oimodel.OIModel;
import it.itc.ectrl.normkit.common.NormalisationException;

/**
 * Represents interface to the automated C-Normalisation tool for extraction of RDFS conceptual model (ontology) out of an XML Schema document.
 * 
 * This interface defines the operations for conceptual normalisation. Each XML Schema normalisation should instanciate one object implementing the C-Normalisation  interface, by means of the C-NormalisationFactory.
 *  Then the C-Normalisation provides the functions for RDFS extraction, Normalisation Map production and storage of the outputs.
 * @author Oliver Fodor ([e-mail])
 */
public interface C_Normalisation {

/*    public void run() throws Exception;*/

    /**
     * Starts the execution of the C-Normalisation process. Extract an RDFS ontology and creates a Normalisation Map.
     * @param rootElement top level element of the XML Schema which is ment to be root of the associated documents
     */
    public void run(String rootElement) throws NormalisationException;

    /**
     * Returns the RDFS conceptual model extracted out of the given XML Schema.
     * @return		the extracted (re-engineered) conceptual model as KAON OIModel (ontology).
     */
    public OIModel getNormalizedModel();

    /**
     * Returns the Normalisation Map produced within C-Normalisation process.
     * @return		the produced Normalisation Map as KAON OIModel (instance).
     */
    public OIModel getNormMap();

    /**
     * Saves the produced RDFS conceptual model into the location defined by its physical URI.
     */
    public void saveNormalizedModel() throws NormalisationException;

    /**
     * Saves the produced RDFS conceptual model into the specified location (file).
     * @param strPhysicalURI 		physical URI target ontology file location
     */
    public void saveNormalizedModel(String strPhysicalURI) throws NormalisationException;

    /**
     * Saves the produced Normalisation Map into the location defined by its physical URI.
     */
    public void saveNormMap() throws NormalisationException;

    /**
     * Saves the produced RDFS conceptual model into the specified location (file).
     * @param strPhysicalURI 		physical URI target map file location
     */
    public void saveNormMap(String strPhysicalURI) throws NormalisationException;
}