org.coode.patterns

Interface AbstractPatternModelFactory

All Known Implementing Classes:

PatternModelFactory

public interface AbstractPatternModelFactory

Author:

Luigi Iannone Jun 16, 2008

Method Summary

Modifier and Type	Method and Description
PatternConstraintSystem	createConstraintSystem()
InstantiatedPatternModel	createInstantiatedPatternModel(PatternModel patternModel, RuntimeExceptionHandler handler)
PatternModel	createPatternModel(OPPLScript opplScript) Builds a PatternModel instance starting from the input opplScript
PatternModel	createPatternModel(String name, List<Variable<?>> variables, List<org.semanticweb.owlapi.model.OWLAxiomChange> actions, Variable<?> returnClause, String rendering, ConstraintSystem constraintSystem) Creates a PatternModel using the input (name, variables, actions, return value, rendering, and constraint system) returnClause can be null variables and actions must be non empty Lists
OPPLAbstractFactory	getOPPLFactory()
PatternExtractor	getPatternExtractor(ErrorListener errorListener) Retrieves a PatternExtractor for extracting patterns from annotations.
PatternExtractor	getPatternExtractor(Set<org.semanticweb.owlapi.model.OWLAnnotation> visitedAnnotations, ErrorListener errorListener) Retrieves a PatternExtractor that takes into account already visited patterns.
ManchesterSyntaxRenderer	getRenderer(PatternConstraintSystem patternConstraintSystem)

Method Detail

createPatternModel

PatternModel createPatternModel(String name,
                                List<Variable<?>> variables,
                                List<org.semanticweb.owlapi.model.OWLAxiomChange> actions,
                                Variable<?> returnClause,
                                String rendering,
                                ConstraintSystem constraintSystem)
                         throws EmptyVariableListException,
                                EmptyActionListException,
                                UnsuitableOPPLScriptException

Creates a PatternModel using the input (name, variables, actions, return value, rendering, and constraint system) returnClause can be null variables and actions must be non empty Lists

Parameters:

name - name

variables - variables

actions - actions

returnClause - returnClause

rendering - rendering

constraintSystem - constraintSystem

Returns:

a PatternModel

Throws:

EmptyVariableListException - EmptyVariableListException

EmptyActionListException - EmptyActionListException

UnsuitableOPPLScriptException - UnsuitableOPPLScriptException

createPatternModel

PatternModel createPatternModel(OPPLScript opplScript)
                         throws UnsuitableOPPLScriptException

Builds a PatternModel instance starting from the input opplScript

Parameters:

opplScript - opplScript

Returns:

a PatternModel

Throws:

UnsuitableOPPLScriptException - when the input OPPLScript is not suitable for creating a pattern model out of it

createInstantiatedPatternModel

InstantiatedPatternModel createInstantiatedPatternModel(PatternModel patternModel,
                                                        RuntimeExceptionHandler handler)

Parameters:

patternModel - patternModel

handler - handler

Returns:

a InstantiatedPatternModel instance created from the input patternModel

getPatternExtractor

PatternExtractor getPatternExtractor(ErrorListener errorListener)

Retrieves a PatternExtractor for extracting patterns from annotations.

Parameters:

errorListener - The error listener cannot be null.

Returns:

a PatternVisitor that extracts patterns from annotations.

Throws:

NullPointerException - if the input is null.

getPatternExtractor

PatternExtractor getPatternExtractor(Set<org.semanticweb.owlapi.model.OWLAnnotation> visitedAnnotations,
                                     ErrorListener errorListener)

Retrieves a PatternExtractor that takes into account already visited patterns.

Parameters:

visitedAnnotations - The annotations containing already visited patterns as their values. Cannot be null.

errorListener - The error listener. Cannot be null.

Returns:

a PatternVisitor that extracts patterns from annotations excluding the input visited ones.

Throws:

NullPointerException - if either input is null.

createConstraintSystem

PatternConstraintSystem createConstraintSystem()

Returns:

a fresh instance of a PatternConstraintSystem

getRenderer

ManchesterSyntaxRenderer getRenderer(PatternConstraintSystem patternConstraintSystem)

Parameters:

patternConstraintSystem - patternConstraintSystem

Returns:

renderer

getOPPLFactory

OPPLAbstractFactory getOPPLFactory()

Returns:

the oppl factory