Package org.dom4j
Interface ElementPath
public interface ElementPath
This interface is used by
ElementHandler
instances to retrieve
information about the current path hierarchy they are to process. It's
primary use is to retrieve the current Element
being processed.- Version:
- $Revision: 1.6 $
- Author:
- Dave White
-
Method Summary
Modifier and TypeMethodDescriptionvoid
addHandler
(String path, ElementHandler handler) Adds theElementHandler
to be called when the specified path is encounted.DOCUMENT ME!getElement
(int depth) DOCUMENT ME!getPath()
DOCUMENT ME!void
removeHandler
(String path) Removes theElementHandler
from the event based processor, for the specified path.int
size()
DOCUMENT ME!
-
Method Details
-
size
int size()DOCUMENT ME!- Returns:
- the number of elements in the path
-
getElement
DOCUMENT ME!- Parameters:
depth
- DOCUMENT ME!- Returns:
- the element at the specified depth index, 0 = root element
-
getPath
String getPath()DOCUMENT ME!- Returns:
- the path as a string
-
getCurrent
Element getCurrent()DOCUMENT ME!- Returns:
- the current element
-
addHandler
Adds theElementHandler
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 handledhandler
- is theElementHandler
to be called by the event based processor.
-
removeHandler
Removes theElementHandler
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 theElementHandler
for.
-