Package org.dom4j

Interface ElementPath

  • public interface ElementPath
    This interface is used by ElementHandlerinstances to retrieve information about the current path hierarchy they are to process. It's primary use is to retrieve the current Elementbeing processed.

    • Method Detail

      • size

        int size()
        DOCUMENT ME!
        Returns:
        the number of elements in the path

      • getElement

        Element getElement​(int depth)
        DOCUMENT ME!
        Parameters:
        depth - DOCUMENT ME!
        Returns:
        the element at the specified depth index, 0 = root element

      • getPath

        java.lang.String getPath()
        DOCUMENT ME!
        Returns:
        the path as a string

      • getCurrent

        Element getCurrent()
        DOCUMENT ME!
        Returns:
        the current element

      • addHandler

        void addHandler​(java.lang.String path,
                ElementHandler handler)
        Adds the ElementHandler to be called when the specified path is encounted. The path can be either an absolute path (i.e. prefixed with "/") or a relative path (i.e. assummed to be a child of the current path as retrieved by getPath .
        Parameters:
        path - is the path to be handled
        handler - is the ElementHandler to be called by the event based processor.

      • removeHandler

        void removeHandler​(java.lang.String path)
        Removes the ElementHandler from the event based processor, for the specified path. The path can be either an absolute path (i.e. prefixed with "/") or a relative path (i.e. assummed to be a child of the current path as retrieved by getPath .
        Parameters:
        path - is the path to remove the ElementHandler for.