2005/5/9

org::w3c::dom::xpath Namespace Reference

Detailed Description

Compounds
class	XPathEvaluator
	The evaluation of XPath expressions is provided by XPathEvaluator. More...
class	XPathException
	API: org.w3c.dom<br>. More...
class	XPathExpression
class	XPathNamespace
	The XPathNamespace interface is returned by XPathResult interfaces to represent the XPath namespace node type that DOM lacks. More...
class	XPathNSResolver
	The XPathNSResolver interface permit prefix strings in the expression to be properly bound to namespaceURI strings. More...
class	XPathResult
class	XPathResultNodeList
	Helper class to wrapp a XPathResult with a NodeList. More...
Enumerations
enum	XPathExceptionCode {   XPATH_NUMBER_ERROR = 1201, XPATH_UNFINISHED_LITERAL_ERROR, XPATH_START_LITERAL_ERROR, XPATH_VARIABLE_REF_ERROR,   XPATH_UNDEF_VARIABLE_ERROR, XPATH_INVALID_PREDICATE_ERROR, XPATH_EXPR_ERROR, XPATH_UNCLOSED_ERROR,   XPATH_UNKNOWN_FUNC_ERROR, XPATH_INVALID_OPERAND, XPATH_INVALID_TYPE, XPATH_INVALID_ARITY,   XPATH_INVALID_CTXT_SIZE, XPATH_INVALID_CTXT_POSITION, XPATH_MEMORY_ERROR }
enum	XPathResultType {   ANY_TYPE = 0, NUMBER_TYPE = 1, STRING_TYPE = 2, BOOLEAN_TYPE = 3,   UNORDERED_NODE_ITERATOR_TYPE = 4, ORDERED_NODE_ITERATOR_TYPE = 5, UNORDERED_NODE_SNAPSHOT_TYPE = 6, ORDERED_NODE_SNAPSHOT_TYPE = 7,   ANY_UNORDERED_NODE_TYPE = 8, FIRST_ORDERED_NODE_TYPE = 9, XPATH_NAMESPACE_NODE = 13 }

Enumeration Type Documentation

enum org::w3c::dom::xpath::XPathExceptionCode

Enumeration values: XPATH_NUMBER_ERROR  XPATH_UNFINISHED_LITERAL_ERROR  XPATH_START_LITERAL_ERROR  XPATH_VARIABLE_REF_ERROR  XPATH_UNDEF_VARIABLE_ERROR  XPATH_INVALID_PREDICATE_ERROR  XPATH_EXPR_ERROR  XPATH_UNCLOSED_ERROR  XPATH_UNKNOWN_FUNC_ERROR  XPATH_INVALID_OPERAND  XPATH_INVALID_TYPE  XPATH_INVALID_ARITY  XPATH_INVALID_CTXT_SIZE  XPATH_INVALID_CTXT_POSITION  XPATH_MEMORY_ERROR

enum org::w3c::dom::xpath::XPathResultType

Enumeration values: ANY_TYPE  This code does not represent a specific type. An evaluation of an XPath expression will never produce this type. If this type is requested, then the evaluation returns whatever type naturally results from evaluation of the expression. If the natural result is a node set when ANY_TYPE was requested, then UNORDERED_NODE_ITERATOR_TYPE is always the resulting type. Any other representation of a node set must be explicitly requested. NUMBER_TYPE  The result is a number as defined by [XPath 1.0]. Document modification does not invalidate the number, but may mean that reevaluation would not yield the same number. STRING_TYPE  The result is a string as defined by [XPath 1.0]. Document modification does not invalidate the string, but may mean that the string no longer corresponds to the current document. BOOLEAN_TYPE  The result is a boolean as defined by [XPath 1.0]. Document modification does not invalidate the boolean, but may mean that reevaluation would not yield the same boolean. UNORDERED_NODE_ITERATOR_TYPE  The result is a node set as defined by [XPath 1.0] that will be accessed iteratively, which may not produce nodes in a particular order. Document modification invalidates the iteration. This is the default type returned if the result is a node set and ANY_TYPE is requested. ORDERED_NODE_ITERATOR_TYPE  The result is a node set as defined by [XPath 1.0] that will be accessed iteratively, which will produce document-ordered nodes. Document modification invalidates the iteration. UNORDERED_NODE_SNAPSHOT_TYPE  The result is a node set as defined by [XPath 1.0] that will be accessed as a snapshot list of nodes that may not be in a particular order. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes in the snapshot may have been altered, moved, or removed from the document. ORDERED_NODE_SNAPSHOT_TYPE  The result is a node set as defined by [XPath 1.0] that will be accessed as a snapshot list of nodes that will be in original document order. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes in the snapshot may have been altered, moved, or removed from the document. ANY_UNORDERED_NODE_TYPE  The result is a node set as defined by [XPath 1.0] and will be accessed as a single node, which may be nullif the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once any node in the resulting set has been found. If there is more than one node in the actual result, the single node returned might not be the first in document order. FIRST_ORDERED_NODE_TYPE  The result is a node set as defined by [XPath 1.0] and will be accessed as a single node, which may be null if the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once the first node in document order of the resulting set has been found. If there are more than one node in the actual result, the single node returned will be the first in document order. XPATH_NAMESPACE_NODE  The node is a Namespace.