org.apache.jackrabbit.taglib.traverser
Class AbstractTraverser

java.lang.Object
  extended byorg.apache.jackrabbit.taglib.traverser.AbstractTraverser
All Implemented Interfaces:
Traverser
Direct Known Subclasses:
AncestorsTraverser, ExpandedNodesTraverser, ExpandedNodeTraverser, LevelByLevelTraverser, PostorderTraverser, PreorderTraverser

public abstract class AbstractTraverser
extends java.lang.Object
implements Traverser

Abstract Traverser

Author:
Edgar Poce

Field Summary
protected  int depth
          Max depth from the relative root node
protected  org.apache.commons.collections.Predicate filter
          Predicate (filter)
protected  javax.jcr.Node node
          Traverse root
protected  java.util.Collection nodes
          Container of traversed nodes
protected  java.util.Comparator order
          Per Children order
protected  java.lang.Object parameter
          Parameter that affects the Traverser behaviour
 
Constructor Summary
AbstractTraverser()
          Constructor
 
Method Summary
protected  java.util.Iterator getChildren(javax.jcr.Node node)
          Get the children for the given node.
 int getDepth()
           
 javax.jcr.Node getNode()
           
 java.util.Collection getNodes()
          Get the nodes
protected abstract  void internalTraverse()
           
 void setDepth(int depth)
          Set the depth
 void setFilter(org.apache.commons.collections.Predicate predicate)
          Set a node filter
 void setNode(javax.jcr.Node node)
          Set the node to traverse from
 void setOrder(java.util.Comparator comparator)
          Set the comparator to order the nodes
 void setParameter(java.lang.Object parameter)
          Parameter that optionally affect the Traverser behaviour.
 void traverse()
          Perform traverse
protected  void visit(javax.jcr.Node node)
          Visit node
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

node

protected javax.jcr.Node node
Traverse root


nodes

protected java.util.Collection nodes
Container of traversed nodes


depth

protected int depth
Max depth from the relative root node


order

protected java.util.Comparator order
Per Children order


filter

protected org.apache.commons.collections.Predicate filter
Predicate (filter)


parameter

protected java.lang.Object parameter
Parameter that affects the Traverser behaviour

Constructor Detail

AbstractTraverser

public AbstractTraverser()
Constructor

Method Detail

getNodes

public java.util.Collection getNodes()
Description copied from interface: Traverser
Get the nodes

Specified by:
getNodes in interface Traverser
Returns:
travesed nodes

visit

protected void visit(javax.jcr.Node node)
Visit node

Parameters:
node -

getDepth

public int getDepth()

setDepth

public void setDepth(int depth)
Description copied from interface: Traverser
Set the depth

Specified by:
setDepth in interface Traverser
Parameters:
depth -

getNode

public javax.jcr.Node getNode()

setNode

public void setNode(javax.jcr.Node node)
Description copied from interface: Traverser
Set the node to traverse from

Specified by:
setNode in interface Traverser
Parameters:
node -

setFilter

public void setFilter(org.apache.commons.collections.Predicate predicate)
Description copied from interface: Traverser
Set a node filter

Specified by:
setFilter in interface Traverser

setOrder

public void setOrder(java.util.Comparator comparator)
Description copied from interface: Traverser
Set the comparator to order the nodes

Specified by:
setOrder in interface Traverser

getChildren

protected java.util.Iterator getChildren(javax.jcr.Node node)
                                  throws org.apache.jackrabbit.taglib.traverser.DepthExceededException,
                                         javax.jcr.RepositoryException
Get the children for the given node.
Filtered and sorted if necesary.

Parameters:
node -
Returns:
@throws DepthExceededException
Throws:
org.apache.jackrabbit.taglib.traverser.DepthExceededException
javax.jcr.RepositoryException

traverse

public void traverse()
              throws javax.jcr.RepositoryException
Description copied from interface: Traverser
Perform traverse

Specified by:
traverse in interface Traverser
Throws:
javax.jcr.RepositoryException

internalTraverse

protected abstract void internalTraverse()
                                  throws javax.jcr.RepositoryException
Throws:
javax.jcr.RepositoryException

setParameter

public void setParameter(java.lang.Object parameter)
Description copied from interface: Traverser
Parameter that optionally affect the Traverser behaviour.

Specified by:
setParameter in interface Traverser


Copyright © 2005 . All Rights Reserved.