org.xfp.filters.xml
Class XPathAbstractFilter

java.lang.Object
  org.xfp.AttributeContainer
      org.xfp.Filter
          org.xfp.filters.xml.XPathAbstractFilter

Direct Known Subclasses:

XPathNode, XPathNodeList, XPathString

public abstract class XPathAbstractFilter

extends Filter

Base class for filters performing XPath operations.

If you are not familiar with the XPath syntax, start with XPath Tutorial by W3Schools. Also see XML Path Language (XPath) Version 1.0 that's the official standard.

Version:

$Id: XPathAbstractFilter.java,v 1.1 2004/03/19 15:56:45 flaviotordini Exp $

Author:

Flavio Tordini

JAR Dependency:

Apache Xalan

Nested Class Summary

Nested classes inherited from class org.xfp.Filter

Filter.OnErrorEnum, Filter.OnLoopErrorEnum

Field Summary

protected org.w3c.dom.Node	node
protected java.lang.String	xpath
protected org.apache.xpath.CachedXPathAPI	xpathapi

Fields inherited from class org.xfp.AttributeContainer

name, parentContainer

Constructor Summary

XPathAbstractFilter()

Method Summary

void	reset() Resets filter status after execution.
void	setNode(org.w3c.dom.Node node) Sets the context node.
void	setXpath(java.lang.String xpath) Sets the XPath query.
protected abstract void	subreset() Subclasses must reset their status within this method.

Methods inherited from class org.xfp.Filter

getOnError, initialize, log, newInstance, perform, toString

Methods inherited from class org.xfp.AttributeContainer

configureAttributes, disposeAttributes, getAttributes, getFullName, getName, initializeAttributes

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

xpathapi

protected final org.apache.xpath.CachedXPathAPI xpathapi

node

protected org.w3c.dom.Node node

xpath

protected java.lang.String xpath

Constructor Detail

XPathAbstractFilter

public XPathAbstractFilter()

Method Detail

reset

public void reset()

Description copied from class: Filter

Resets filter status after execution. This method is called after execute(), even in case of exceptions. Since a Filter instance may be reused (and actually is), you must use this method to reset all your class members to their default value.

Specified by:

reset in class Filter

See Also:

Filter.reset()

subreset

protected abstract void subreset()

Subclasses must reset their status within this method.

setNode

public void setNode(org.w3c.dom.Node node)

Sets the context node.

Parameters:

node - The node to start searching from.

setXpath

public void setXpath(java.lang.String xpath)

Sets the XPath query.

Parameters:

xpath - A valid XPath string.