org.biopax.paxtools.controller

Class Traverser

java.lang.Object

org.biopax.paxtools.controller.Traverser

Direct Known Subclasses:

AbstractTraverser, TraverserBilinked

public class Traverser
extends Object

This is a utility class for traversing over the dependent objects of a biopax element, based on property editors

Field Summary

Fields

Modifier and Type	Field and Description
protected EditorMap	editorMap
protected Filter<PropertyEditor>[]	filters
protected Visitor	visitor

Constructor Summary

Constructors

Constructor and Description
Traverser(EditorMap editorMap, Visitor visitor, Filter<PropertyEditor>... filters) The full constructor.

Method Summary

Modifier and Type	Method and Description
protected boolean	filter(PropertyEditor<?,?> editor)
Visitor	getVisitor()
void	setVisitor(Visitor visitor)
<D extends BioPAXElement> void	traverse(D element, Model model) Traverse and visit Visitor all properties of the element.
protected void	traverseElements(BioPAXElement element, Model model, PropertyEditor<?,?> editor, Set<?> valueSet)

Methods inherited from class java.lang.Object

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

Field Detail

editorMap

protected final EditorMap editorMap

visitor

protected Visitor visitor

filters

protected Filter<PropertyEditor>[] filters

Constructor Detail

Traverser

public Traverser(EditorMap editorMap,
                 Visitor visitor,
                 Filter<PropertyEditor>... filters)

The full constructor.

Parameters:

editorMap - is used for looking up properties to traverse

visitor - is a visitor element that determines the action on reaching a biopax element during traversal

filters - limits the type of properties that are traversed.

Method Detail

setVisitor

public void setVisitor(Visitor visitor)

getVisitor

public Visitor getVisitor()

traverse

public <D extends BioPAXElement> void traverse(D element,
                                               Model model)

Traverse and visit Visitor all properties of the element. This method does not traverse iteratively to the values.

Type Parameters:

D - actual BioPAX type which properties and inherited properties will be used

Parameters:

element - BioPAX element to be traversed

model - to be traversed, but not necessarily (depends on the Visitor implementation).

traverseElements

protected void traverseElements(BioPAXElement element,
                                Model model,
                                PropertyEditor<?,?> editor,
                                Set<?> valueSet)

filter

protected boolean filter(PropertyEditor<?,?> editor)