xpathfactory.java

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

/*
 * XPathFactory.java
 *
 * Created on 22 mei 2003, 22:40
 */

package org.dom4j;

import org.dom4j.rule.Pattern;
import org.jaxen.VariableContext;

import java.util.Map;

/**
 *
 * @author  Maarten
 */
public interface XPathFactory {

    /** Sets the namespace URIs to be used by XPath expressions created by this factory
     * or by nodes associated with this factory. The keys are namespace prefixes and the
     * values are namespace URIs.
     */
    void setXPathNamespaceURIs(Map xpathNamespaceURIs);

    /** <p><code>createXPath</code> parses an XPath expression
      * and creates a new XPath <code>XPath</code> instance.</p>
      *
      * @param xpathExpression is the XPath expression to create
      * @return a new <code>XPath</code> instance
      * @throws InvalidXPathException if the XPath expression is invalid
      */
    XPath createXPath(String xpathExpression) throws InvalidXPathException;

    /** <p><code>createXPath</code> parses an XPath expression
      * and creates a new XPath <code>XPath</code> instance.</p>
      *
      * @param xpathExpression is the XPath expression to create
      * @param variableContext is the variable context to use when evaluating the XPath
      * @return a new <code>XPath</code> instance
      * @throws InvalidXPathException if the XPath expression is invalid
      */
    XPath createXPath(String xpathExpression, VariableContext variableContext);

    /** <p><code>createXPathFilter</code> parses a NodeFilter
      * from the given XPath filter expression.
      * XPath filter expressions occur within XPath expressions such as
      * <code>self::node()[ filterExpression ]</code></p>
      *
      * @param xpathFilterExpression is the XPath filter expression
      * to create
      * @param variableContext is the variable context to use when evaluating the XPath
      * @return a new <code>NodeFilter</code> instance
      */
    NodeFilter createXPathFilter(String xpathFilterExpression, VariableContext variableContext);

    /** <p><code>createXPathFilter</code> parses a NodeFilter
      * from the given XPath filter expression.
      * XPath filter expressions occur within XPath expressions such as
      * <code>self::node()[ filterExpression ]</code></p>
      *
      * @param xpathFilterExpression is the XPath filter expression
      * to create
      * @return a new <code>NodeFilter</code> instance
      */
    NodeFilter createXPathFilter(String xpathFilterExpression);

    /** <p><code>createPattern</code> parses the given
      * XPath expression to create an XSLT style {@link Pattern} instance
      * which can then be used in an XSLT processing model.</p>
      *
      * @param xpathPattern is the XPath pattern expression
      * to create
      * @return a new <code>Pattern</code> instance
      */
    Pattern createPattern(String xpathPattern);

}