nodeiteratorlistener.java

Java的面向对象数据库系统的源代码

/**
 * The contents of this file are subject to the OpenXML Public
 * License Version 1.0; you may not use this file except in
 * compliance with the License. You may obtain a copy of the
 * License at http://www.openxml.org/license/
 *
 * THIS SOFTWARE AND DOCUMENTATION IS PROVIDED ON AN "AS IS" BASIS
 * WITHOUT WARRANTY OF ANY KIND EITHER EXPRESSED OR IMPLIED,
 * INCLUDING AND WITHOUT LIMITATION, WARRANTIES THAT THE SOFTWARE
 * AND DOCUMENTATION IS FREE OF DEFECTS, MERCHANTABLE, FIT FOR A
 * PARTICULAR PURPOSE OR NON-INFRINGING. SEE THE LICENSE FOR THE
 * SPECIFIC LANGUAGE GOVERNING RIGHTS AND LIMITATIONS UNDER THE
 * LICENSE.
 *
 * The Initial Developer of this code under the License is
 * OpenXML.org. Portions created by OpenXML.org and/or Assaf Arkin
 * are Copyright (C) 1998, 1999 OpenXML.org. All Rights Reserved.
 */

package org.ozoneDB.xml.dom.iterator;

import org.w3c.dom.*;


/**
 * Listener interface allows node to notify iterator when a child is removed,
 * so iterator may adjust accordingly. When an iterator is created on a node
 * tree, the iterator is registered as a listener on that tree. When a node
 * is removed from that tree, the iterator is notified by the tree top node,
 * and if pointing to that node will adjust itself to point to a different node
 * that still belongs to the tree,
 *
 * @version $Revision: 1.2 $ $Date: 2003/11/20 23:18:42 $
 * @author <a href="mailto:[e-mail]">Assaf Arkin</a>
 */
public interface NodeIteratorListener  {


    /**
     * Called to notify this iterator that a particular node has been removed.
     * If the iterator is pointing at that node, or one of its childern, it must
     * adjust accordingly.
     * <P>
     * This method only affects the iterator if it is pointing at the removed node
     * or a child of the removed node. It does not affect the iterator if it is
     * pointing to a parent of the removed node, or the removed node is on some
     * other branch of the document tree.
     *
     * @param node The node being removed
     */
    public void removeNode( Node node );

}