org.coode.patterns

Class PatternModel

java.lang.Object

org.coode.patterns.PatternModel

All Implemented Interfaces:

OPPLScript, Renderable, PatternOPPLScript

public class PatternModel
extends Object
implements OPPLScript, PatternOPPLScript

Author:

Luigi Iannone Jun 10, 2008

Field Summary

Fields

Modifier and Type	Field and Description
static String	NAMESPACE
protected org.semanticweb.owlapi.model.OWLOntologyManager	ontologyManager

Constructor Summary

Constructors

Constructor and Description
PatternModel(OPPLScript opplScript, org.semanticweb.owlapi.model.OWLOntologyManager ontologyManager, AbstractPatternModelFactory f)

Method Summary

Modifier and Type	Method and Description
void	accept(OPPLScriptVisitor visitor)
<P> P	accept(OPPLScriptVisitorEx<P> visitor)
void	addChangeListener(PatternModelChangeListener l)
void	addDependency(PatternOPPLScript dependency) Adds a dependency from this Script to towards the input one
void	addVariable(Variable<?> variable) Deprecated.
boolean	dependsOn(PatternOPPLScript patternModel)
boolean	equals(Object obj)
List<org.semanticweb.owlapi.model.OWLAxiomChange>	getActions()
PatternConstraintSystem	getConstraintSystem()
org.semanticweb.owlapi.model.OWLObject	getDefinitorialPortion(Collection<? extends BindingNode> bindingNodes, RuntimeExceptionHandler runtimeExceptionHandler)
Set<PatternOPPLScript>	getDependingPatterns(Set<org.semanticweb.owlapi.model.OWLOntology> ontologies, ErrorListener errorListener)
List<InputVariable<?>>	getInputVariables()
Set<InstantiatedPatternModel>	getInstantiations(ErrorListener errorListener)
org.semanticweb.owlapi.model.IRI	getIRI()
String	getName()
OPPLScript	getOpplStatement()
org.semanticweb.owlapi.model.OWLOntology	getOriginatingOntology()
Set<org.semanticweb.owlapi.model.OWLObject>	getOWLObjects(org.semanticweb.owlapi.model.OWLOntology ontology, ErrorListener errorListener)
org.semanticweb.owlapi.model.OWLOntologyManager	getOWLOntologyManager()
String	getPatternLocalName()
AbstractPatternModelFactory	getPatternModelFactory()
OPPLQuery	getQuery()
String	getRendering()
Variable<?>	getReturnVariable()
static OPPLScriptValidator	getScriptValidator()
List<Variable<?>>	getVariables()
int	hashCode()
boolean	hasScopedVariables()
boolean	isClassPattern()
boolean	isDependent()
boolean	isFunctional()
boolean	isValid()
void	removeChangeListener(PatternModelChangeListener l)
String	render()
String	render(ConstraintSystem constraintSystem)
String	render(org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider)
void	setIRI(org.semanticweb.owlapi.model.IRI iri) Sets the pattern URI
void	setRendering(String rendering)
void	setReturnVariable(Variable<?> returnVariable) Sets the return variable
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

ontologyManager

protected final org.semanticweb.owlapi.model.OWLOntologyManager ontologyManager

NAMESPACE

public static final String NAMESPACE

See Also:

Constant Field Values

Constructor Detail

PatternModel

public PatternModel(OPPLScript opplScript,
                    org.semanticweb.owlapi.model.OWLOntologyManager ontologyManager,
                    AbstractPatternModelFactory f)
             throws UnsuitableOPPLScriptException

Parameters:

opplScript - opplScript

ontologyManager - ontologyManager

f - f

Throws:

UnsuitableOPPLScriptException - UnsuitableOPPLScriptException

Method Detail

getPatternModelFactory

public AbstractPatternModelFactory getPatternModelFactory()

Returns:

pattern model factory

getOWLOntologyManager

public org.semanticweb.owlapi.model.OWLOntologyManager getOWLOntologyManager()

Returns:

ontology manager

getVariables

public List<Variable<?>> getVariables()

Specified by:

getVariables in interface OPPLScript

toString

public String toString()

Overrides:

toString in class Object

render

public String render()

Specified by:

render in interface OPPLScript

Returns:

the string rendering of this PatternModel. Override/use this method in tools like Protege that have different strategies to render OWL objects

render

public String render(ConstraintSystem constraintSystem)

Specified by:

render in interface Renderable

render

public String render(org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider)

Specified by:

render in interface OPPLScript

getRendering

public String getRendering()

Specified by:

getRendering in interface PatternOPPLScript

Returns:

rendering

setRendering

public void setRendering(String rendering)

Parameters:

rendering - the rendering to set

isValid

public boolean isValid()

Returns:

the valid

addChangeListener

public void addChangeListener(PatternModelChangeListener l)

Parameters:

l - l

removeChangeListener

public void removeChangeListener(PatternModelChangeListener l)

Parameters:

l - l

getIRI

public org.semanticweb.owlapi.model.IRI getIRI()

Specified by:

getIRI in interface PatternOPPLScript

Returns:

the pattern URI

setIRI

public void setIRI(org.semanticweb.owlapi.model.IRI iri)

Description copied from interface: PatternOPPLScript

Sets the pattern URI

Specified by:

setIRI in interface PatternOPPLScript

Parameters:

iri - anURI

getOpplStatement

public OPPLScript getOpplStatement()

Returns:

the opplStatement

getPatternLocalName

public String getPatternLocalName()

Returns:

pattern local name

getConstraintSystem

public PatternConstraintSystem getConstraintSystem()

Specified by:

getConstraintSystem in interface OPPLScript

getDefinitorialPortion

public org.semanticweb.owlapi.model.OWLObject getDefinitorialPortion(Collection<? extends BindingNode> bindingNodes,
                                                                     RuntimeExceptionHandler runtimeExceptionHandler)
                                                              throws PatternException

Specified by:

getDefinitorialPortion in interface PatternOPPLScript

Parameters:

bindingNodes - bindingNodes

runtimeExceptionHandler - runtimeExceptionHandler

Returns:

definitiorial portion

Throws:

PatternException - PatternException

dependsOn

public boolean dependsOn(PatternOPPLScript patternModel)

Specified by:

dependsOn in interface PatternOPPLScript

Parameters:

patternModel - patternModel

Returns:

true if this PatternModel instance depends on the input one, false otherwise

isDependent

public boolean isDependent()

Returns:

true if there are dependencies

getDependingPatterns

public Set<PatternOPPLScript> getDependingPatterns(Set<org.semanticweb.owlapi.model.OWLOntology> ontologies,
                                                   ErrorListener errorListener)

Parameters:

ontologies - ontologies

errorListener - errorListener

Returns:

the set of PatternModel instances that depend on this. Please notice that InstantiatedPatternModel instances will be returned as well

getInstantiations

public Set<InstantiatedPatternModel> getInstantiations(ErrorListener errorListener)

Parameters:

errorListener - errorListener

Returns:

instantiations

getOWLObjects

public Set<org.semanticweb.owlapi.model.OWLObject> getOWLObjects(org.semanticweb.owlapi.model.OWLOntology ontology,
                                                                 ErrorListener errorListener)

Specified by:

getOWLObjects in interface PatternOPPLScript

Parameters:

ontology - ontology

errorListener - errorListener

Returns:

the Set containing the OWLObject elements generated by the serialisation of this OPPScript

getOriginatingOntology

public org.semanticweb.owlapi.model.OWLOntology getOriginatingOntology()

Returns:

originating ontology

setReturnVariable

public void setReturnVariable(Variable<?> returnVariable)

Sets the return variable

Parameters:

returnVariable - returnVariable

getReturnVariable

public Variable<?> getReturnVariable()

Returns:

the returnVariable

isFunctional

public boolean isFunctional()

Returns:

true if the patterns returns a value, false otherwise

isClassPattern

public boolean isClassPattern()

Specified by:

isClassPattern in interface PatternOPPLScript

Returns:

true if the pattern is applicable to OWL classes (must edit the semantics of the class it applies to), false otherwise

getName

public String getName()

Specified by:

getName in interface PatternOPPLScript

Returns:

the name for this PatternOPPLScript

addDependency

public void addDependency(PatternOPPLScript dependency)

Description copied from interface: PatternOPPLScript

Adds a dependency from this Script to towards the input one

Specified by:

addDependency in interface PatternOPPLScript

Parameters:

dependency - script

getInputVariables

public List<InputVariable<?>> getInputVariables()

Specified by:

getInputVariables in interface OPPLScript

hasScopedVariables

public boolean hasScopedVariables()

Specified by:

hasScopedVariables in interface PatternOPPLScript

Returns:

true is any of the variables used in this PatternOPPLScript is scoped, false otherwise

accept

public void accept(OPPLScriptVisitor visitor)

Specified by:

accept in interface OPPLScript

accept

public <P> P accept(OPPLScriptVisitorEx<P> visitor)

Specified by:

accept in interface OPPLScript

getActions

public List<org.semanticweb.owlapi.model.OWLAxiomChange> getActions()

Specified by:

getActions in interface OPPLScript

getQuery

public OPPLQuery getQuery()

Specified by:

getQuery in interface OPPLScript

addVariable

@Deprecated
public void addVariable(Variable<?> variable)

Deprecated.

Specified by:

addVariable in interface OPPLScript

getScriptValidator

public static final OPPLScriptValidator getScriptValidator()

Returns:

the scriptValidator

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object