org.apache.xpath.jaxp

Class XPathFactoryImpl

java.lang.Object

javax.xml.xpath.XPathFactory

org.apache.xpath.jaxp.XPathFactoryImpl

public class XPathFactoryImpl
extends XPathFactory

The XPathFactory builds XPaths.

Version:

$Revision$

Author:

Ramesh Mandava

Field Summary

Fields inherited from class javax.xml.xpath.XPathFactory

DEFAULT_OBJECT_MODEL_URI, DEFAULT_PROPERTY_NAME

Constructor Summary

Constructors

Constructor and Description
XPathFactoryImpl()

Method Summary

Modifier and Type	Method and Description
boolean	getFeature(String name) Get the state of the named feature.
boolean	isObjectModelSupported(String objectModel) Is specified object model supported by this XPathFactory?
XPath	newXPath() Returns a new XPath object using the underlying object model determined when the factory was instantiated.
void	setFeature(String name, boolean value) Set a feature for this XPathFactory and XPaths created by this factory.
void	setXPathFunctionResolver(XPathFunctionResolver resolver) Establish a default function resolver.
void	setXPathVariableResolver(XPathVariableResolver resolver) Establish a default variable resolver.

Methods inherited from class javax.xml.xpath.XPathFactory

newInstance, newInstance, newInstance

Methods inherited from class java.lang.Object

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

Constructor Detail

XPathFactoryImpl

public XPathFactoryImpl()

Method Detail

isObjectModelSupported

public boolean isObjectModelSupported(String objectModel)

Is specified object model supported by this XPathFactory?

Specified by:

isObjectModelSupported in class XPathFactory

Parameters:

objectModel - Specifies the object model which the returned XPathFactory will understand.

Returns:

true if XPathFactory supports objectModel, else false.

Throws:

NullPointerException - If objectModel is null.

IllegalArgumentException - If objectModel.length() == 0.

newXPath

public XPath newXPath()

Returns a new XPath object using the underlying object model determined when the factory was instantiated.

Specified by:

newXPath in class XPathFactory

Returns:

New XPath

setFeature

public void setFeature(String name,
                       boolean value)
                throws XPathFactoryConfigurationException

Set a feature for this XPathFactory and XPaths created by this factory.

Feature names are fully qualified URIs. Implementations may define their own features. An XPathFactoryConfigurationException is thrown if this XPathFactory or the XPaths it creates cannot support the feature. It is possible for an XPathFactory to expose a feature value but be unable to change its state.

See XPathFactory for full documentation of specific features.

Specified by:

setFeature in class XPathFactory

Parameters:

name - Feature name.

value - Is feature state true or false.

Throws:

XPathFactoryConfigurationException - if this XPathFactory or the XPaths it creates cannot support this feature.

NullPointerException - if name is null.

getFeature

public boolean getFeature(String name)
                   throws XPathFactoryConfigurationException

Get the state of the named feature.

Feature names are fully qualified URIs. Implementations may define their own features. An XPathFactoryConfigurationException is thrown if this XPathFactory or the XPaths it creates cannot support the feature. It is possible for an XPathFactory to expose a feature value but be unable to change its state.

Specified by:

getFeature in class XPathFactory

Parameters:

name - Feature name.

Returns:

State of the named feature.

Throws:

XPathFactoryConfigurationException - if this XPathFactory or the XPaths it creates cannot support this feature.

NullPointerException - if name is null.

setXPathFunctionResolver

public void setXPathFunctionResolver(XPathFunctionResolver resolver)

Establish a default function resolver.

Any XPath objects constructed from this factory will use the specified resolver by default.

A NullPointerException is thrown if resolver is null.

Specified by:

setXPathFunctionResolver in class XPathFactory

Parameters:

resolver - XPath function resolver.

Throws:

NullPointerException - If resolver is null.

setXPathVariableResolver

public void setXPathVariableResolver(XPathVariableResolver resolver)

Establish a default variable resolver.

Any XPath objects constructed from this factory will use the specified resolver by default.

A NullPointerException is thrown if resolver is null.

Specified by:

setXPathVariableResolver in class XPathFactory

Parameters:

resolver - Variable resolver.

Throws:

NullPointerException - If resolver is null.