You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@abdera.apache.org by jm...@apache.org on 2006/10/28 00:21:24 UTC
svn commit: r468562 -
/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/xpath/XPath.java
Author: jmsnell
Date: Fri Oct 27 15:21:24 2006
New Revision: 468562
URL: http://svn.apache.org/viewvc?view=rev&rev=468562
Log:
Javadoc improvements
Modified:
incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/xpath/XPath.java
Modified: incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/xpath/XPath.java
URL: http://svn.apache.org/viewvc/incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/xpath/XPath.java?view=diff&rev=468562&r1=468561&r2=468562
==============================================================================
--- incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/xpath/XPath.java (original)
+++ incubator/abdera/java/trunk/core/src/main/java/org/apache/abdera/xpath/XPath.java Fri Oct 27 15:21:24 2006
@@ -27,58 +27,103 @@
*/
public interface XPath {
+ /**
+ * Return the default mapping of Prefixes to XML Namespaces
+ */
Map<String,String> getDefaultNamespaces();
+ /**
+ * Return a listing of nodes matching the specified Path
+ */
List selectNodes(
String path,
Base base) throws XPathException;
+ /**
+ * Return the first node matching the specified Path
+ */
Object selectSingleNode(
String path,
Base base) throws XPathException;
+ /**
+ * Evaluate the specified XPath and return it's value
+ */
Object evaluate(
String path,
Base base) throws XPathException;
+ /**
+ * Return the text value of the specified Path
+ */
String valueOf(
String path,
Base base) throws XPathException;
+ /**
+ * Return a boolean representation of the specified Path
+ */
boolean booleanValueOf(
String path,
Base base) throws XPathException;
+ /**
+ * Return a numeric representation of the specified Path
+ */
Number numericValueOf(
String path,
Base base)
throws XPathException;
+ /**
+ * Return a listing of nodes matching the specified Path using the
+ * specified Namespaces mapping
+ */
List selectNodes(
String path,
Base base,
Map<String,String> namespaces) throws XPathException;
+ /**
+ * Return a the first node matching the specified Path using the
+ * specified Namespaces mapping
+ */
Object selectSingleNode(
String path,
Base base,
Map<String,String> namespaces) throws XPathException;
+ /**
+ * Evaluate the specified XPath and return it's value using
+ * the specified Namespaces mapping
+ */
Object evaluate(
String path,
Base base,
Map<String,String> namespaces) throws XPathException;
+ /**
+ * Return the text value of the specified Path using the
+ * specified Namespaces mapping
+ */
String valueOf(
String path,
Base base,
Map<String,String> namespaces) throws XPathException;
+ /**
+ * Return a boolean representation of the specified Path
+ * using the specified Namespaces mapping
+ */
boolean booleanValueOf(
String path,
Base base,
Map<String,String> namespaces) throws XPathException;
-
+
+ /**
+ * Return a numeric representation of the specified Path
+ * using the specified Namespaces mapping
+ */
Number numericValueOf(
String path,
Base base,