org.semanticweb.owlapi.util

Class OWLObjectWalker<O extends OWLObject>

java.lang.Object

org.semanticweb.owlapi.util.OWLObjectWalker<O>

Type Parameters:

O - the returned type

Direct Known Subclasses:

OWLClassLiteralCollector, OWLOntologyWalker

public class OWLObjectWalker<O extends OWLObject>
extends Object

Author:

Matthew Horridge, The University Of Manchester, Information Management Group, Date: 29-Jul-2008

Field Summary

Fields

Modifier and Type	Field and Description
protected OWLAnnotation	annotation
protected OWLAxiom	ax
protected OWLOntology	ontology
protected boolean	visitDuplicates
protected OWLObjectVisitorEx<?>	visitor

Constructor Summary

Constructors

Constructor and Description
OWLObjectWalker(Set<O> objects)
OWLObjectWalker(Set<O> objects, boolean visitDuplicates)

Method Summary

Modifier and Type	Method and Description
OWLAnnotation	getAnnotation() Gets the last annotation to be visited.
OWLAxiom	getAxiom() Gets the last axiom to be visited.
List<OWLClassExpression>	getClassExpressionPath() Gets the current class expression path.
List<OWLDataRange>	getDataRangePath() Gets the current data range path.
OWLOntology	getOntology() Gets the last ontology to be visited.
boolean	isFirstClassExpressionInPath(OWLClassExpression classExpression) Determines if a particular class expression is the first (or root) class expression in the current class expression path.
protected void	popClassExpression() Pops a class expression from the class expression path.
protected void	popDataRange() Pops a data range from the data range expression path.
protected void	pushClassExpression(OWLClassExpression ce) Pushes a class expression onto the class expression path.
protected void	pushDataRange(OWLDataRange dr) Pushes a data range on to the data range path.
void	setAnnotation(OWLAnnotation node) Allow the structure walker to set the current annotation
void	setAxiom(OWLAxiom axiom) Allow the structure walker to set the current axiom
void	setStructureWalker(StructureWalker<O> walker)
void	walkStructure(OWLObjectVisitorEx<?> v)

Methods inherited from class java.lang.Object

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

Field Detail

ontology

protected OWLOntology ontology

visitor

protected OWLObjectVisitorEx<?> visitor

visitDuplicates

protected final boolean visitDuplicates

ax

protected OWLAxiom ax

annotation

protected OWLAnnotation annotation

Constructor Detail

OWLObjectWalker

public OWLObjectWalker(Set<O> objects)

Parameters:

objects - the set of objects to visit

OWLObjectWalker

public OWLObjectWalker(Set<O> objects,
                       boolean visitDuplicates)

Parameters:

visitDuplicates - true if duplicates should be visited

objects - the set of objects to visit

Method Detail

setStructureWalker

public void setStructureWalker(StructureWalker<O> walker)

Parameters:

walker - the structure walker to use with this object walker

walkStructure

public void walkStructure(OWLObjectVisitorEx<?> v)

Parameters:

v - visitor to use over the objects

getOntology

public OWLOntology getOntology()

Gets the last ontology to be visited.

Returns:

The last ontology to be visited

getAxiom

public OWLAxiom getAxiom()

Gets the last axiom to be visited.

Returns:

The last axiom to be visited, or null if an axiom has not be visited

getAnnotation

public OWLAnnotation getAnnotation()

Gets the last annotation to be visited.

Returns:

The last annotation to be visited (may be null)

getClassExpressionPath

public List<OWLClassExpression> getClassExpressionPath()

Gets the current class expression path. The current class expression path is a list of class expressions that represents the containing expressions for the current class expressions. The first item in the path (list) is the root class expression that was visited. For i between 0 and pathLength, the item at index i+1 is a direct sub-expression of the item at index i. The last item in the path is the current class expression being visited.

Returns:

A list of class expressions that represents the path of class expressions, with the root of the class expression being the first element in the list.

isFirstClassExpressionInPath

public boolean isFirstClassExpressionInPath(OWLClassExpression classExpression)

Determines if a particular class expression is the first (or root) class expression in the current class expression path.

Parameters:

classExpression - The class expression

Returns:

true if the specified class expression is the first class expression in the current class expression path, otherwise false (false if the path is empty)

pushClassExpression

protected void pushClassExpression(OWLClassExpression ce)

Pushes a class expression onto the class expression path.

Parameters:

ce - The class expression to be pushed onto the path

popClassExpression

protected void popClassExpression()

Pops a class expression from the class expression path. If the path is empty then this method has no effect.

getDataRangePath

public List<OWLDataRange> getDataRangePath()

Gets the current data range path. The current data range path is a list of data ranges that represents the containing expressions for the current data ranges. The first item in the path (list) is the root data range that was visited. For i between 0 and pathLength, the item at index i+1 is a direct sub-expression of the item at index i. The last item in the path is the current data range being visited.

Returns:

A list of data ranges that represents the path of data ranges, with the root of the data range being the first element in the list.

pushDataRange

protected void pushDataRange(OWLDataRange dr)

Pushes a data range on to the data range path.

Parameters:

dr - The data range to be pushed onto the path

popDataRange

protected void popDataRange()

Pops a data range from the data range expression path. If the path is empty then this method has no effect.

setAxiom

public void setAxiom(OWLAxiom axiom)

Allow the structure walker to set the current axiom

Parameters:

axiom - the axiom to set

setAnnotation

public void setAnnotation(OWLAnnotation node)

Allow the structure walker to set the current annotation

Parameters:

node - the annotation to set