org.apache.commons.jxpath.ri.model.beans
Class PropertyIterator

java.lang.Object
  extended by org.apache.commons.jxpath.ri.model.beans.PropertyIterator
All Implemented Interfaces:
NodeIterator
Direct Known Subclasses:
BeanAttributeIterator, DynamicPropertyIterator

public class PropertyIterator
extends java.lang.Object
implements NodeIterator

Iterates property values of an object pointed at with a PropertyOwnerPointer. Examples of such objects are JavaBeans and objects with Dynamic Properties.

Version:
$Revision: 652845 $ $Date: 2008-05-02 12:46:46 -0500 (Fri, 02 May 2008) $
Author:
Dmitri Plotnikov

Constructor Summary
PropertyIterator(PropertyOwnerPointer pointer, java.lang.String name, boolean reverse, NodePointer startWith)
          Create a new PropertyIterator.
 
Method Summary
 NodePointer getNodePointer()
          Get the NodePointer at the current position.
 int getPosition()
          Get the current iterator position.
protected  NodePointer getPropertyPointer()
          Get the property pointer.
protected  void prepareForIndividualProperty(java.lang.String name)
          Prepare for an individual property.
 void reset()
          Reset property iteration.
 boolean setPosition(int position)
          Set the new current position.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

PropertyIterator

public PropertyIterator(PropertyOwnerPointer pointer,
                        java.lang.String name,
                        boolean reverse,
                        NodePointer startWith)
Create a new PropertyIterator.

Parameters:
pointer - owning pointer
name - property name
reverse - iteration order
startWith - beginning pointer
Method Detail

getPropertyPointer

protected NodePointer getPropertyPointer()
Get the property pointer.

Returns:
NodePointer

reset

public void reset()
Reset property iteration.


getNodePointer

public NodePointer getNodePointer()
Description copied from interface: NodeIterator
Get the NodePointer at the current position.

Specified by:
getNodePointer in interface NodeIterator
Returns:
NodePointer

getPosition

public int getPosition()
Description copied from interface: NodeIterator
Get the current iterator position.

Specified by:
getPosition in interface NodeIterator
Returns:
int position

setPosition

public boolean setPosition(int position)
Description copied from interface: NodeIterator
Set the new current position.

Specified by:
setPosition in interface NodeIterator
Parameters:
position - the position to set
Returns:
true if there is a node at position.

prepareForIndividualProperty

protected void prepareForIndividualProperty(java.lang.String name)
Prepare for an individual property.

Parameters:
name - property name


Copyright © 2001-2011 Apache Software Foundation. All Rights Reserved.