javax.xml.xpath

Class XPathFactory

Known Direct Subclasses:
XPathFactoryImpl

public abstract class XPathFactory
extends Object

Factory for creating XPath environments.
Since:
1.3

Field Summary

static String
DEFAULT_OBJECT_MODEL_URI
The default object model URI.
static String
DEFAULT_PROPERTY_NAME
The default property name according to the JAXP specification.

Constructor Summary

XPathFactory()
The basic constructor.

Method Summary

abstract boolean
getFeature(String name)
Returns the state of the named feature.
abstract boolean
isObjectModelSupported(String objectModel)
Indicates whether the specified object model URI is supported by this factory.
static XPathFactory
newInstance()
Returns a new factory for the default (DOM) object model.
static XPathFactory
newInstance(String uri)
Returns a new factory for the given object model URI.
abstract XPath
newXPath()
Returns a new XPath evaluation environment.
abstract void
setFeature(String name, boolean value)
Sets the state of the named feature.
abstract void
setXPathFunctionResolver(XPathFunctionResolver resolver)
Sets the XPath extension function resolver calback.
abstract void
setXPathVariableResolver(XPathVariableResolver resolver)
Sets the XPath variable resolver calback.

Methods inherited from class java.lang.Object

clone, equals, extends Object> getClass, finalize, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

DEFAULT_OBJECT_MODEL_URI

public static final String DEFAULT_OBJECT_MODEL_URI
The default object model URI.
Field Value:
"http://java.sun.com/jaxp/xpath/dom"

DEFAULT_PROPERTY_NAME

public static final String DEFAULT_PROPERTY_NAME
The default property name according to the JAXP specification.
Field Value:
"javax.xml.xpath.XPathFactory"

Constructor Details

XPathFactory

protected XPathFactory()
The basic constructor. Object is special, because it has no superclass, so there is no call to super().

Method Details

getFeature

public abstract boolean getFeature(String name)
            throws XPathFactoryConfigurationException
Returns the state of the named feature.

isObjectModelSupported

public abstract boolean isObjectModelSupported(String objectModel)
Indicates whether the specified object model URI is supported by this factory.

newInstance

public static final XPathFactory newInstance()
Returns a new factory for the default (DOM) object model.

newInstance

public static final XPathFactory newInstance(String uri)
            throws XPathFactoryConfigurationException
Returns a new factory for the given object model URI. The implementation class to load is the first found in the following locations that advertises support for the given model URI:
  1. the javax.xml.xpath.XPathFactory system property
  2. the above named property value in the $JAVA_HOME/lib/jaxp.properties file
  3. the class name specified in the META-INF/services/javax.xml.xpath.XPathFactory system resource
  4. the default factory class
Parameters:
uri - the object model URI

newXPath

public abstract XPath newXPath()
Returns a new XPath evaluation environment.

setFeature

public abstract void setFeature(String name,
                                boolean value)
            throws XPathFactoryConfigurationException
Sets the state of the named feature.

setXPathFunctionResolver

public abstract void setXPathFunctionResolver(XPathFunctionResolver resolver)
Sets the XPath extension function resolver calback.

setXPathVariableResolver

public abstract void setXPathVariableResolver(XPathVariableResolver resolver)
Sets the XPath variable resolver calback.

XPathFactory.java -- Copyright (C) 2004, 2005 Free Software Foundation, Inc. This file is part of GNU Classpath. GNU Classpath is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. GNU Classpath is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with GNU Classpath; see the file COPYING. If not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA. Linking this library statically or dynamically with other modules is making a combined work based on this library. Thus, the terms and conditions of the GNU General Public License cover the whole combination. As a special exception, the copyright holders of this library give you permission to link this library with independent modules to produce an executable, regardless of the license terms of these independent modules, and to copy and distribute the resulting executable under terms of your choice, provided that you also meet, for each linked independent module, the terms and conditions of the license of that module. An independent module is a module which is not derived from or based on this library. If you modify this library, you may extend this exception to your version of the library, but you are not obligated to do so. If you do not wish to do so, delete this exception statement from your version.