NodeIterator.java

Go to the documentation of this file.

/*
 * Project: Server for annotations sharing
 * Subproject: Position of fragment of text in XML document
 * Author: Michael Angelov
 * Edited by: Ing. Jaroslav Dytrych idytrych@fit.vutbr.cz
 * File: NodeIterator.java
 * Description: Generic class for node iterators
 */

/**
 * @file NodeIterator.java
 *
 * @brief Generic class for node iterators
 */

/**
 * @package cz.vutbr.fit.knot.annotations.fragmentUpdater.nodeIterators
 *
 * @brief Node iterators for iterating through XML document nodes
 */
package cz.vutbr.fit.knot.annotations.fragmentUpdater.nodeIterators;

import javax.xml.xpath.XPathExpression;
import javax.xml.xpath.XPathExpressionException;
import org.w3c.dom.Document;
import org.w3c.dom.Node;
import org.w3c.dom.NodeList;

/**
 * Generic class for node iterators
 *
 * @brief Generic class for node iterators
 * @author Michael Angelov
 */
public abstract class NodeIterator {

  protected Document document;
  public NodeList nodeList;
  public int currentNodeIndex;

  /**
   * Abstract method for node iterator initialization
   *
   * @param document document whose nodes will be iterated through
   * @param expr XPath expression according to which iterating will be provided
   */
  abstract public void init(Document document, XPathExpression expr) throws XPathExpressionException;

  /**
   * Method for getting iterator's next node
   *
   * @return iterator's next node
   */
  abstract public Node nextNode();

}