org.coode.patterns.AbstractPatternModelFactory Maven / Gradle / Ivy
/**
* Copyright (C) 2008, University of Manchester
*
* Modifications to the initial code base are copyright of their
* respective authors, or their employers as appropriate. Authorship
* of the modifications may be determined from the ChangeLog placed at
* the end of this file.
*
* This library is free software; you can redistribute it and/or
* modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2.1 of the License, or (at your option) any later version.
* This library is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
* Lesser General Public License for more details.
* You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the Free Software
* Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
*/
package org.coode.patterns;
import java.util.List;
import java.util.Set;
import org.coode.oppl.ConstraintSystem;
import org.coode.oppl.OPPLAbstractFactory;
import org.coode.oppl.OPPLScript;
import org.coode.oppl.Variable;
import org.coode.oppl.exceptions.RuntimeExceptionHandler;
import org.coode.oppl.rendering.ManchesterSyntaxRenderer;
import org.coode.parsers.ErrorListener;
import org.semanticweb.owlapi.model.OWLAnnotation;
import org.semanticweb.owlapi.model.OWLAxiomChange;
/** @author Luigi Iannone Jun 16, 2008 */
public interface AbstractPatternModelFactory {
/** Creates a PatternModel using the input (name, variables, actions, return
* value, rendering, and constraint system) returnClause can be {@code null}
* variables and actions must be non empty Lists
*
* @param name
* name
* @param variables
* variables
* @param actions
* actions
* @param returnClause
* returnClause
* @param rendering
* rendering
* @param constraintSystem
* constraintSystem
* @return a PatternModel
* @throws EmptyVariableListException
* EmptyVariableListException
* @throws EmptyActionListException
* EmptyActionListException
* @throws UnsuitableOPPLScriptException
* UnsuitableOPPLScriptException */
PatternModel createPatternModel(String name, List> variables,
List actions, Variable returnClause, String rendering,
ConstraintSystem constraintSystem) throws EmptyVariableListException,
EmptyActionListException, UnsuitableOPPLScriptException;
/** Builds a PatternModel instance starting from the input opplScript
*
* @param opplScript
* opplScript
* @return a PatternModel
* @throws UnsuitableOPPLScriptException
* when the input OPPLScript is not suitable for creating a
* pattern model out of it */
PatternModel createPatternModel(OPPLScript opplScript)
throws UnsuitableOPPLScriptException;
/** @param patternModel
* patternModel
* @param handler
* handler
* @return a InstantiatedPatternModel instance created from the input
* patternModel */
InstantiatedPatternModel createInstantiatedPatternModel(PatternModel patternModel,
RuntimeExceptionHandler handler);
/** Retrieves a PatternExtractor for extracting patterns from annotations.
*
* @param errorListener
* The error listener cannot be {@code null}.
* @return a PatternVisitor that extracts patterns from annotations.
* @throws NullPointerException
* if the input is {@code null}. */
PatternExtractor getPatternExtractor(ErrorListener errorListener);
/** Retrieves a PatternExtractor that takes into account already visited
* patterns.
*
* @param visitedAnnotations
* The annotations containing already visited patterns as their
* values. Cannot be {@code null}.
* @param errorListener
* The error listener. Cannot be {@code null}.
* @return a PatternVisitor that extracts patterns from annotations
* excluding the input visited ones.
* @throws NullPointerException
* if either input is {@code null}. */
PatternExtractor getPatternExtractor(Set visitedAnnotations,
ErrorListener errorListener);
/** @return a fresh instance of a PatternConstraintSystem */
PatternConstraintSystem createConstraintSystem();
/** @param patternConstraintSystem
* patternConstraintSystem
* @return renderer */
ManchesterSyntaxRenderer getRenderer(PatternConstraintSystem patternConstraintSystem);
/** @return the oppl factory */
OPPLAbstractFactory getOPPLFactory();
}