org.coode.patterns

Class InstantiatedPatternModel

java.lang.Object

org.coode.patterns.InstantiatedPatternModel

All Implemented Interfaces:

InstantiatedOPPLScript, OPPLScript, Renderable, HasPatternModel, PatternOPPLScript

public class InstantiatedPatternModel
extends Object
implements InstantiatedOPPLScript, PatternOPPLScript, HasPatternModel

Author:

Luigi Iannone Jun 11, 2008

Constructor Summary

Constructors

Constructor and Description
InstantiatedPatternModel(PatternModel patternModel, RuntimeExceptionHandler handler) Creates an InstantiatedPatternModel instance starting from the input PatternModel

Method Summary

Modifier and Type	Method and Description
void	accept(OPPLScriptVisitor visitor)
<P> P	accept(OPPLScriptVisitorEx<P> visitor)
void	addDependency(PatternOPPLScript script) Adds a dependency from this Script to towards the input one
void	addVariable(Variable<?> v) Adds the input Variable to this InstantiatedPatternModel.
boolean	dependsOn(PatternOPPLScript patternOPPLScript)
Set<BindingNode>	extractBindingNodes()
List<org.semanticweb.owlapi.model.OWLAxiomChange>	getActions()
PatternConstraintSystem	getConstraintSystem()
org.semanticweb.owlapi.model.OWLObject	getDefinitorialPortion(Collection<? extends BindingNode> bindingNodes, RuntimeExceptionHandler reh)
List<InputVariable<?>>	getInputVariables()
PatternModel	getInstantiatedPattern()
String	getInstantiatedPatternLocalName()
Set<org.semanticweb.owlapi.model.OWLObject>	getInstantiations(Variable<?> variable)
org.semanticweb.owlapi.model.IRI	getIRI()
String	getName()
org.semanticweb.owlapi.model.OWLOntology	getOriginatingOntology()
Set<org.semanticweb.owlapi.model.OWLObject>	getOWLObjects(org.semanticweb.owlapi.model.OWLOntology ontology, ErrorListener errorListener)
PatternModel	getPatternModel()
OPPLQuery	getQuery()
String	getRendering()
RuntimeExceptionHandler	getRuntimeExceptionHandler()
String	gettUnresolvedOPPLStatement()
List<Variable<?>>	getVariables()
boolean	hasScopedVariables()
void	instantiate(Variable<?> variable, org.semanticweb.owlapi.model.OWLObject value) Assigns the input value to the input variable, if the variable is already in the InstantiatedPatternModel.
boolean	isClassPattern()
boolean	isValid()
boolean	removeInstantiation(Variable<?> variable, org.semanticweb.owlapi.model.OWLObject owlObject)
String	render()
String	render(ConstraintSystem constraintSystem)
protected String	render(org.semanticweb.owlapi.model.OWLObject owlObject)
String	render(org.semanticweb.owlapi.util.ShortFormProvider shortFormProvider)
void	setIRI(org.semanticweb.owlapi.model.IRI uri) Sets the pattern URI
void	setUnresolvedOPPLStatement(String unresolvedString)
String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

InstantiatedPatternModel

public InstantiatedPatternModel(PatternModel patternModel,
                                RuntimeExceptionHandler handler)

Creates an InstantiatedPatternModel instance starting from the input PatternModel

Parameters:

patternModel - the Pattern on which the this instantiated pattern will be built. Cannot be null.

handler - handler

Method Detail

getInstantiations

public Set<org.semanticweb.owlapi.model.OWLObject> getInstantiations(Variable<?> variable)

Parameters:

variable - variable

Returns:

instantiations

removeInstantiation

public boolean removeInstantiation(Variable<?> variable,
                                   org.semanticweb.owlapi.model.OWLObject owlObject)

Parameters:

variable - variable

owlObject - owlObject

Returns:

true if any instantiation removed

instantiate

public void instantiate(Variable<?> variable,
                        org.semanticweb.owlapi.model.OWLObject value)

Assigns the input value to the input variable, if the variable is already in the InstantiatedPatternModel. To add a Variable instance use addVariable(Variable)

Specified by:

instantiate in interface InstantiatedOPPLScript

Parameters:

variable - variable

value - value

isValid

public boolean isValid()

Specified by:

isValid in interface InstantiatedOPPLScript

getRendering

public String getRendering()

Specified by:

getRendering in interface PatternOPPLScript

Returns:

rendering

toString

public String toString()

Overrides:

toString in class Object

render

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

Specified by:

render in interface OPPLScript

render

protected String render(org.semanticweb.owlapi.model.OWLObject owlObject)

getInstantiatedPatternLocalName

public String getInstantiatedPatternLocalName()

Returns:

the instantiatedPatternLocalName

extractBindingNodes

public Set<BindingNode> extractBindingNodes()

Returns:

binding nodes

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

addVariable

public void addVariable(Variable<?> v)

Adds the input Variable to this InstantiatedPatternModel. The instantiations after the addition will be null

Specified by:

addVariable in interface OPPLScript

Parameters:

v - v

getName

public String getName()

Specified by:

getName in interface PatternOPPLScript

Returns:

the name for this PatternOPPLScript

getVariables

public List<Variable<?>> getVariables()

Specified by:

getVariables in interface OPPLScript

getConstraintSystem

public PatternConstraintSystem getConstraintSystem()

Specified by:

getConstraintSystem in interface OPPLScript

getInstantiatedPattern

public PatternModel getInstantiatedPattern()

Returns:

instantiated pattern

addDependency

public void addDependency(PatternOPPLScript script)

Description copied from interface: PatternOPPLScript

Adds a dependency from this Script to towards the input one

Specified by:

addDependency in interface PatternOPPLScript

Parameters:

script - script

dependsOn

public boolean dependsOn(PatternOPPLScript patternOPPLScript)

Specified by:

dependsOn in interface PatternOPPLScript

Parameters:

patternOPPLScript - aPatternOPPLScript

Returns:

true if this PatternOPPLScript depends on the input one, false otherwise

setUnresolvedOPPLStatement

public void setUnresolvedOPPLStatement(String unresolvedString)

Parameters:

unresolvedString - unresolvedString

gettUnresolvedOPPLStatement

public String gettUnresolvedOPPLStatement()

Returns:

unresolved oppl statement

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 uri)

Description copied from interface: PatternOPPLScript

Sets the pattern URI

Specified by:

setIRI in interface PatternOPPLScript

Parameters:

uri - anURI

render

public String render(ConstraintSystem constraintSystem)

Specified by:

render in interface Renderable

render

public String render()

Specified by:

render in interface OPPLScript

getPatternModel

public PatternModel getPatternModel()

Specified by:

getPatternModel in interface HasPatternModel

Returns:

the patternModel

isClassPattern

public boolean isClassPattern()

Specified by:

isClassPattern in interface PatternOPPLScript

Returns:

true if this pattern script can be applied to an OWLClass

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

getDefinitorialPortion

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

Specified by:

getDefinitorialPortion in interface PatternOPPLScript

Parameters:

bindingNodes - bindingNodes

reh - runtimeExceptionHandler

Returns:

definitiorial portion

Throws:

PatternException - PatternException

getRuntimeExceptionHandler

public RuntimeExceptionHandler getRuntimeExceptionHandler()

Returns:

the runtimeExceptionHandler