├── .gitignore ├── javadoc ├── resources │ ├── tab.gif │ ├── titlebar.gif │ ├── background.gif │ └── titlebar_end.gif ├── package-list ├── overview-frame.html ├── com │ └── elsevier │ │ └── spark_xml_utils │ │ ├── xpath │ │ ├── package-frame.html │ │ ├── package-tree.html │ │ ├── package-summary.html │ │ ├── package-use.html │ │ ├── class-use │ │ │ ├── XPathProcessor.html │ │ │ └── XPathException.html │ │ └── XPathException.html │ │ ├── xquery │ │ ├── package-frame.html │ │ ├── package-tree.html │ │ ├── package-summary.html │ │ ├── package-use.html │ │ ├── class-use │ │ │ ├── XQueryProcessor.html │ │ │ └── XQueryException.html │ │ └── XQueryException.html │ │ └── xslt │ │ ├── package-frame.html │ │ ├── class-use │ │ ├── S3URIResolver.html │ │ ├── XSLTProcessor.html │ │ └── XSLTException.html │ │ ├── package-tree.html │ │ ├── package-use.html │ │ └── package-summary.html ├── allclasses-noframe.html ├── allclasses-frame.html ├── index.html ├── deprecated-list.html ├── constant-values.html ├── overview-summary.html ├── index-files │ ├── index-7.html │ ├── index-5.html │ ├── index-3.html │ ├── index-1.html │ ├── index-6.html │ ├── index-2.html │ ├── index-4.html │ └── index-8.html ├── overview-tree.html └── help-doc.html ├── src └── main │ └── java │ └── com │ └── elsevier │ └── spark_xml_utils │ ├── common │ └── IgnoreDoctype.java │ ├── xslt │ ├── XSLTException.java │ └── S3URIResolver.java │ ├── xpath │ └── XPathException.java │ └── xquery │ └── XQueryException.java ├── NOTICE ├── README.md └── pom.xml /.gitignore: -------------------------------------------------------------------------------- 1 | 2 | .DS_Store 3 | .idea* 4 | target -------------------------------------------------------------------------------- /javadoc/resources/tab.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elsevierlabs-os/spark-xml-utils/HEAD/javadoc/resources/tab.gif -------------------------------------------------------------------------------- /javadoc/resources/titlebar.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elsevierlabs-os/spark-xml-utils/HEAD/javadoc/resources/titlebar.gif -------------------------------------------------------------------------------- /javadoc/resources/background.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elsevierlabs-os/spark-xml-utils/HEAD/javadoc/resources/background.gif -------------------------------------------------------------------------------- /javadoc/package-list: -------------------------------------------------------------------------------- 1 | com.elsevier.spark_xml_utils.xpath 2 | com.elsevier.spark_xml_utils.xquery 3 | com.elsevier.spark_xml_utils.xslt 4 | -------------------------------------------------------------------------------- /javadoc/resources/titlebar_end.gif: -------------------------------------------------------------------------------- https://raw.githubusercontent.com/elsevierlabs-os/spark-xml-utils/HEAD/javadoc/resources/titlebar_end.gif -------------------------------------------------------------------------------- /src/main/java/com/elsevier/spark_xml_utils/common/IgnoreDoctype.java: -------------------------------------------------------------------------------- 1 | package com.elsevier.spark_xml_utils.common; 2 | 3 | import java.io.ByteArrayInputStream; 4 | 5 | import org.xml.sax.EntityResolver; 6 | import org.xml.sax.InputSource; 7 | import org.xml.sax.SAXException; 8 | 9 | public class IgnoreDoctype implements EntityResolver { 10 | 11 | public InputSource resolveEntity(java.lang.String publicId, java.lang.String systemId) 12 | throws SAXException, java.io.IOException 13 | { 14 | // Ignore everything 15 | return new InputSource(new ByteArrayInputStream("".getBytes())); 16 | 17 | } 18 | 19 | } 20 | -------------------------------------------------------------------------------- /src/main/java/com/elsevier/spark_xml_utils/xslt/XSLTException.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c)2015 Elsevier, Inc. 3 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | * 16 | */ 17 | package com.elsevier.spark_xml_utils.xslt; 18 | 19 | /** 20 | * XSLT Exception 21 | * 22 | * @author Darin McBeath 23 | * 24 | */ 25 | public class XSLTException extends Exception { 26 | 27 | private static final long serialVersionUID = 2400267865440323215L; 28 | 29 | public XSLTException(String msg) { 30 | 31 | super(msg); 32 | 33 | } 34 | 35 | } 36 | -------------------------------------------------------------------------------- /src/main/java/com/elsevier/spark_xml_utils/xpath/XPathException.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c)2015 Elsevier, Inc. 3 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | * 16 | */ 17 | package com.elsevier.spark_xml_utils.xpath; 18 | 19 | 20 | /** 21 | * XPath Exception 22 | * 23 | * @author Darin McBeath 24 | * 25 | */ 26 | public class XPathException extends Exception { 27 | 28 | private static final long serialVersionUID = -7388865425596520914L; 29 | 30 | public XPathException(String msg) { 31 | 32 | super(msg); 33 | 34 | } 35 | 36 | } 37 | -------------------------------------------------------------------------------- /src/main/java/com/elsevier/spark_xml_utils/xquery/XQueryException.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c)2015 Elsevier, Inc. 3 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | * 16 | */ 17 | package com.elsevier.spark_xml_utils.xquery; 18 | 19 | /** 20 | * XQuery Exception 21 | * 22 | * @author Darin McBeath 23 | * 24 | */ 25 | public class XQueryException extends Exception { 26 | 27 | private static final long serialVersionUID = -1838016565780507800L; 28 | 29 | public XQueryException(String msg) { 30 | 31 | super(msg); 32 | 33 | } 34 | 35 | } 36 | -------------------------------------------------------------------------------- /javadoc/overview-frame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Overview List 7 | 8 | 9 | 10 | 11 |
All Classes
12 |
13 |

Packages

14 | 19 |
20 |

 

21 | 22 | 23 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xpath/package-frame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | com.elsevier.spark_xml_utils.xpath 7 | 8 | 9 | 10 | 11 |

com.elsevier.spark_xml_utils.xpath

12 |
13 |

Classes

14 | 17 |

Exceptions

18 | 21 |
22 | 23 | 24 | -------------------------------------------------------------------------------- /NOTICE: -------------------------------------------------------------------------------- 1 | This product includes 'Saxon-HE' developed by Saxonica, an open source product that provides 2 | implementations of XSLT 2.0, XQuery 3.0, and XPath 3.0 at the basic level of conformance 3 | defined by W3C. 4 | 5 | * LICENSE: 6 | * Mozilla Public License version 2.0 (https://www.mozilla.org/MPL/2.0/) 7 | * HOMEPAGE: 8 | * http://saxon.sourceforge.net/ 9 | 10 | This product includes 'Apache Commons io' which can be obtained at: 11 | 12 | * LICENSE: 13 | * Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html) 14 | * HOMEPAGE: 15 | * http://commons.apache.org/proper/commons-io/ 16 | 17 | This product includes 'Apache Commons Lang' which can be obtained at: 18 | 19 | * LICENSE: 20 | * Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html) 21 | * HOMEPAGE: 22 | * http://commons.apache.org/proper/commons-lang/ 23 | 24 | This product includes 'Apache Commons Logging', a logging framework, which can be 25 | obtained at: 26 | 27 | * LICENSE: 28 | * Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0.html) 29 | * HOMEPAGE: 30 | * http://commons.apache.org/logging/ -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xquery/package-frame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | com.elsevier.spark_xml_utils.xquery 7 | 8 | 9 | 10 | 11 |

com.elsevier.spark_xml_utils.xquery

12 |
13 |

Classes

14 | 17 |

Exceptions

18 | 21 |
22 | 23 | 24 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xslt/package-frame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | com.elsevier.spark_xml_utils.xslt 7 | 8 | 9 | 10 | 11 |

com.elsevier.spark_xml_utils.xslt

12 |
13 |

Classes

14 | 18 |

Exceptions

19 | 22 |
23 | 24 | 25 | -------------------------------------------------------------------------------- /javadoc/allclasses-noframe.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | All Classes 7 | 8 | 9 | 10 | 11 |

All Classes

12 |
13 | 22 |
23 | 24 | 25 | -------------------------------------------------------------------------------- /javadoc/allclasses-frame.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | All Classes 7 | 8 | 9 | 10 | 11 |

All Classes

12 |
13 | 22 |
23 | 24 | 25 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # spark-xml-utils 2 | 3 | This site offers some background information on how to utilize the capabilities provided by the spark-xml-utils library within an [Apache Spark](http://spark.apache.org) application. Some scala examples (leveraging XPath, XSLT, and XQuery) within the Apache Spark framework are provided. I have modified the spark-xml-utils APIs in this new version. The previous version was really a work in progress whereas the newer version incorporates some of the experience I have gained with both Spark and the spark-xml-utils package. My hope is that the new version will be simpler to use as well as more performant. As time permits, I plan to optimize the implementation as well as add some additional features. 4 | 5 | Spark-xml-utils is not meant for processing one large single GBs XML record. However, if you have many XML records (we have millions) in the MBs (or less) then this should be a handy tool. 6 | 7 | The javadoc is available for spark-xml-utils and could be helpful with understanding the class interactions. 8 | ## Motivation 9 | 10 | The spark-xml-utils library was developed because there is a large amount of XML in our big datasets and I felt this data could be better served by providing some helpful XML utilities. This includes the ability to filter documents based on an XPath expression, return specific nodes for an XPath/XQuery expression, or transform documents using a XSLT stylesheet. By providing some basic wrappers to [Saxon](http://www.saxonica.com), the spark-xml-utils library exposes some basic XPath, XQuery, and XSLT functionality that can readily be leveraged by any Spark application. 11 | 12 | ## Examples 13 | 14 | The basic examples included only scratch the surface for what is possible with spark-xml-utils and [XPath](https://github.com/elsevierlabs/spark-xml-utils/wiki/xpath), [XQuery](https://github.com/elsevierlabs/spark-xml-utils/wiki/XQuery), and [XSLT](https://github.com/elsevierlabs/spark-xml-utils/wiki/xslt). I have used spark-xml-utils to transform millions of XML documents to json and html, performed a simple batch search against millions of XML documents, and more. Some more [complex examples](https://github.com/elsevierlabs/spark-xml-utils/wiki/complexexamples) are available to further showcase the power of spark-xml-utils. 15 | 16 | The sequence file used in all of the examples is publicly available in s3://spark-xml-utils/xml/part*. In the sequence file, the key is a unique identifier for the record and the value is the XML (as a string). This should allow you to try out the examples as well as experiment with your own expressions. 17 | 18 | ## Maven Coordinate 19 | 20 | 21 | com.elsevier 22 | spark-xml-utils 23 | 1.8.0 24 | -------------------------------------------------------------------------------- /javadoc/index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Generated Documentation (Untitled) 7 | 59 | 60 | 61 | 62 | 63 | 64 | 65 | 66 | 67 | <noscript> 68 | <div>JavaScript is disabled on your browser.</div> 69 | </noscript> 70 | <h2>Frame Alert</h2> 71 | <p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> 72 | 73 | 74 | 75 | -------------------------------------------------------------------------------- /src/main/java/com/elsevier/spark_xml_utils/xslt/S3URIResolver.java: -------------------------------------------------------------------------------- 1 | /* 2 | * Copyright (c)2015 Elsevier, Inc. 3 | 4 | * Licensed under the Apache License, Version 2.0 (the "License"); 5 | * you may not use this file except in compliance with the License. 6 | * You may obtain a copy of the License at 7 | * 8 | * http://www.apache.org/licenses/LICENSE-2.0 9 | * 10 | * Unless required by applicable law or agreed to in writing, software 11 | * distributed under the License is distributed on an "AS IS" BASIS, 12 | * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 13 | * See the License for the specific language governing permissions and 14 | * limitations under the License. 15 | * 16 | */ 17 | package com.elsevier.spark_xml_utils.xslt; 18 | 19 | import java.io.IOException; 20 | import java.net.URL; 21 | import java.nio.charset.StandardCharsets; 22 | import java.util.HashMap; 23 | 24 | import javax.xml.transform.Source; 25 | import javax.xml.transform.TransformerException; 26 | import javax.xml.transform.URIResolver; 27 | import javax.xml.transform.stream.StreamSource; 28 | 29 | import org.apache.commons.io.IOUtils; 30 | import org.apache.commons.logging.Log; 31 | import org.apache.commons.logging.LogFactory; 32 | 33 | 34 | /** 35 | * URI Resolver that will be used by XLTProcessor when resolving xsl:import and 36 | * xsl:include statements. The purpose of this class is to create a local cache 37 | * of the stylesheets retrieved (presumably) from S3 so they don't need to be 38 | * re-retrieved from S3 on subsequent requests. 39 | * 40 | * @author Darin McBeath 41 | * 42 | */ 43 | public class S3URIResolver implements URIResolver { 44 | 45 | // Stylesheet map cache 46 | private HashMap stylesheetMap = new HashMap(); 47 | 48 | // Logger 49 | private static Log log = LogFactory.getLog(S3URIResolver.class); 50 | 51 | 52 | /** 53 | * Return the requested stylesheet. If the stylesheet hasn't been cached, 54 | * then save the stylesheet to the cache. The assumption (although not 55 | * required) is that the imported/included stylesheets will be stored in an 56 | * S3 bucket and accessible using an S3 url. 57 | * 58 | * @param href url for the stylesheet 59 | * @param base not used (assuming absolute urls) 60 | */ 61 | public Source resolve(String href, String base) throws TransformerException { 62 | 63 | try { 64 | 65 | // Check local cache 66 | if (stylesheetMap.containsKey(href)) { 67 | 68 | return new StreamSource(IOUtils.toInputStream(stylesheetMap.get(href),StandardCharsets.UTF_8.name())); 69 | 70 | } else { 71 | 72 | // Read the data from the URL and populate the cache 73 | URL theUrl = new URL(href); 74 | stylesheetMap.put(href,IOUtils.toString(theUrl.openStream(),StandardCharsets.UTF_8.name())); 75 | 76 | // Return a StreamSource 77 | return new StreamSource(IOUtils.toInputStream(stylesheetMap.get(href),StandardCharsets.UTF_8.name())); 78 | 79 | } 80 | 81 | } catch (IOException e) { 82 | 83 | log.error("Problems resolving a stylesheet. URI:" + href + " " + e.getMessage(),e); 84 | throw new TransformerException(e.getMessage()); 85 | 86 | } 87 | 88 | } 89 | 90 | } 91 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | com.elsevier 6 | spark-xml-utils 7 | 4.0.0 8 | Spark Utilities 9 | jar 10 | 1.10.0 11 | 12 | UTF-8 13 | 1.8 14 | 1.8 15 | 16 | 17 | 18 | 19 | org.junit.jupiter 20 | junit-jupiter-engine 21 | 5.3.1 22 | test 23 | 24 | 25 | net.sf.saxon 26 | Saxon-HE 27 | 10.5 28 | 29 | 30 | commons-io 31 | commons-io 32 | 2.14.0 33 | 34 | 35 | commons-logging 36 | commons-logging 37 | 1.2 38 | 39 | 40 | 41 | 42 | 43 | Apache License, Version 2.0 44 | http://www.apache.org/licenses/LICENSE-2.0.html 45 | 46 | 47 | 48 | 49 | Elsevier, Inc. 50 | http://www.elsevier.com 51 | 52 | 53 | 54 | 55 | dmcbeath 56 | Darin McBeath 57 | d.mcbeath@elsevier.com 58 | Elsevier, Inc. 59 | http://www.elsevier.com 60 | 61 | architect 62 | developer 63 | 64 | 65 | 66 | 67 | 68 | 69 | 70 | org.apache.maven.plugins 71 | maven-shade-plugin 72 | 73 | 74 | package 75 | 76 | shade 77 | 78 | 79 | 80 | 81 | 82 | 83 | *:* 84 | 85 | META-INF/*.SF 86 | META-INF/*.DSA 87 | META-INF/*.RSA 88 | 89 | 90 | 91 | uber-${project.artifactId}-${project.version} 92 | 93 | 94 | 95 | org.apache.maven.plugins 96 | maven-surefire-plugin 97 | 2.22.2 98 | 99 | 100 | 101 | 102 | -------------------------------------------------------------------------------- /javadoc/deprecated-list.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Deprecated List 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Deprecated API

67 |

Contents

68 |
69 | 70 |
71 | 72 | 73 | 74 | 75 | 85 |
86 | 113 | 114 | 115 | 116 | -------------------------------------------------------------------------------- /javadoc/constant-values.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Constant Field Values 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Constant Field Values

67 |

Contents

68 |
69 | 70 |
71 | 72 | 73 | 74 | 75 | 85 |
86 | 113 | 114 | 115 | 116 | -------------------------------------------------------------------------------- /javadoc/overview-summary.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Overview 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 |
Packages 
PackageDescription
com.elsevier.spark_xml_utils.xpath 
com.elsevier.spark_xml_utils.xquery 
com.elsevier.spark_xml_utils.xslt 
87 |
88 | 89 |
90 | 91 | 92 | 93 | 94 | 104 |
105 | 132 | 133 | 134 | 135 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xslt/class-use/S3URIResolver.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Class com.elsevier.spark_xml_utils.xslt.S3URIResolver 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Class
com.elsevier.spark_xml_utils.xslt.S3URIResolver

67 |
68 |
No usage of com.elsevier.spark_xml_utils.xslt.S3URIResolver
69 | 70 |
71 | 72 | 73 | 74 | 75 | 85 |
86 | 113 | 114 | 115 | 116 | -------------------------------------------------------------------------------- /javadoc/index-files/index-7.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | T-Index 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
C E F G R S T X  66 | 67 | 68 |

T

69 |
70 |
transform(String) - Method in class com.elsevier.spark_xml_utils.xslt.XSLTProcessor
71 |
72 |
Transform the content.
73 |
74 |
75 | C E F G R S T X 
76 | 77 |
78 | 79 | 80 | 81 | 82 | 92 |
93 | 120 | 121 | 122 | 123 | -------------------------------------------------------------------------------- /javadoc/index-files/index-5.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | R-Index 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
C E F G R S T X  66 | 67 | 68 |

R

69 |
70 |
resolve(String, String) - Method in class com.elsevier.spark_xml_utils.xslt.S3URIResolver
71 |
72 |
Return the requested stylesheet.
73 |
74 |
75 | C E F G R S T X 
76 | 77 |
78 | 79 | 80 | 81 | 82 | 92 |
93 | 120 | 121 | 122 | 123 | -------------------------------------------------------------------------------- /javadoc/index-files/index-3.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | F-Index 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
C E F G R S T X  66 | 67 | 68 |

F

69 |
70 |
filterString(String) - Method in class com.elsevier.spark_xml_utils.xpath.XPathProcessor
71 |
72 |
Filter the content with the XPath expression specified when creating the XPathProcessor.
73 |
74 |
75 | C E F G R S T X 
76 | 77 |
78 | 79 | 80 | 81 | 82 | 92 |
93 | 120 | 121 | 122 | 123 | -------------------------------------------------------------------------------- /javadoc/index-files/index-1.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | C-Index 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
C E F G R S T X  66 | 67 | 68 |

C

69 |
70 |
com.elsevier.spark_xml_utils.xpath - package com.elsevier.spark_xml_utils.xpath
71 |
 
72 |
com.elsevier.spark_xml_utils.xquery - package com.elsevier.spark_xml_utils.xquery
73 |
 
74 |
com.elsevier.spark_xml_utils.xslt - package com.elsevier.spark_xml_utils.xslt
75 |
 
76 |
77 | C E F G R S T X 
78 | 79 |
80 | 81 | 82 | 83 | 84 | 94 |
95 | 122 | 123 | 124 | 125 | -------------------------------------------------------------------------------- /javadoc/index-files/index-6.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | S-Index 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
C E F G R S T X  66 | 67 | 68 |

S

69 |
70 |
S3URIResolver - Class in com.elsevier.spark_xml_utils.xslt
71 |
72 |
URI Resolver that will be used by XLTProcessor when resolving xsl:import and 73 | xsl:include statements.
74 |
75 |
S3URIResolver() - Constructor for class com.elsevier.spark_xml_utils.xslt.S3URIResolver
76 |
 
77 |
78 | C E F G R S T X 
79 | 80 |
81 | 82 | 83 | 84 | 85 | 95 |
96 | 123 | 124 | 125 | 126 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xpath/package-tree.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | com.elsevier.spark_xml_utils.xpath Class Hierarchy 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Hierarchy For Package com.elsevier.spark_xml_utils.xpath

67 | Package Hierarchies: 68 | 71 |
72 |
73 |

Class Hierarchy

74 |
    75 |
  • java.lang.Object 76 |
      77 |
    • java.lang.Throwable (implements java.io.Serializable) 78 |
        79 |
      • java.lang.Exception 80 | 83 |
      • 84 |
      85 |
    • 86 |
    • com.elsevier.spark_xml_utils.xpath.XPathProcessor (implements java.io.Serializable)
    • 87 |
    88 |
  • 89 |
90 |
91 | 92 |
93 | 94 | 95 | 96 | 97 | 107 |
108 | 135 | 136 | 137 | 138 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xquery/package-tree.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | com.elsevier.spark_xml_utils.xquery Class Hierarchy 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Hierarchy For Package com.elsevier.spark_xml_utils.xquery

67 | Package Hierarchies: 68 | 71 |
72 |
73 |

Class Hierarchy

74 |
    75 |
  • java.lang.Object 76 |
      77 |
    • java.lang.Throwable (implements java.io.Serializable) 78 |
        79 |
      • java.lang.Exception 80 | 83 |
      • 84 |
      85 |
    • 86 |
    • com.elsevier.spark_xml_utils.xquery.XQueryProcessor (implements java.io.Serializable)
    • 87 |
    88 |
  • 89 |
90 |
91 | 92 |
93 | 94 | 95 | 96 | 97 | 107 |
108 | 135 | 136 | 137 | 138 | -------------------------------------------------------------------------------- /javadoc/index-files/index-2.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | E-Index 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
C E F G R S T X  66 | 67 | 68 |

E

69 |
70 |
evaluateString(String) - Method in class com.elsevier.spark_xml_utils.xpath.XPathProcessor
71 |
72 |
Evaluate the content with the XPath expression specified when creating the XPathProcessor 73 | and return a serialized response.
74 |
75 |
evaluateString(String) - Method in class com.elsevier.spark_xml_utils.xquery.XQueryProcessor
76 |
77 |
Evaluate the content with the XQuery expression specified when creating the XQueryProcessor 78 | and return a serialized response.
79 |
80 |
81 | C E F G R S T X 
82 | 83 |
84 | 85 | 86 | 87 | 88 | 98 |
99 | 126 | 127 | 128 | 129 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xslt/package-tree.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | com.elsevier.spark_xml_utils.xslt Class Hierarchy 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Hierarchy For Package com.elsevier.spark_xml_utils.xslt

67 | Package Hierarchies: 68 | 71 |
72 |
73 |

Class Hierarchy

74 |
    75 |
  • java.lang.Object 76 |
      77 |
    • com.elsevier.spark_xml_utils.xslt.S3URIResolver (implements javax.xml.transform.URIResolver)
    • 78 |
    • java.lang.Throwable (implements java.io.Serializable) 79 |
        80 |
      • java.lang.Exception 81 | 84 |
      • 85 |
      86 |
    • 87 |
    • com.elsevier.spark_xml_utils.xslt.XSLTProcessor (implements java.io.Serializable)
    • 88 |
    89 |
  • 90 |
91 |
92 | 93 |
94 | 95 | 96 | 97 | 98 | 108 |
109 | 136 | 137 | 138 | 139 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xpath/package-summary.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | com.elsevier.spark_xml_utils.xpath 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Package com.elsevier.spark_xml_utils.xpath

67 |
68 |
69 |
    70 |
  • 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 85 | 86 | 87 |
    Class Summary 
    ClassDescription
    XPathProcessor 81 |
    Class with methods to filter an XPath expression (return a TRUE/FALSE) 82 | against a string of arbitrary xml content and evaluate an XPath expression (return 83 | a serialized response) against a string of arbitrary xml content.
    84 |
    88 |
  • 89 |
  • 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 102 | 103 | 104 |
    Exception Summary 
    ExceptionDescription
    XPathException 100 |
    XPath Exception
    101 |
    105 |
  • 106 |
107 |
108 | 109 |
110 | 111 | 112 | 113 | 114 | 124 |
125 | 152 | 153 | 154 | 155 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xquery/package-summary.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | com.elsevier.spark_xml_utils.xquery 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Package com.elsevier.spark_xml_utils.xquery

67 |
68 |
69 |
    70 |
  • 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 84 | 85 | 86 |
    Class Summary 
    ClassDescription
    XQueryProcessor 81 |
    Class with methods to apply an XQuery expression against a string of 82 | arbitrary xml content.
    83 |
    87 |
  • 88 |
  • 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 101 | 102 | 103 |
    Exception Summary 
    ExceptionDescription
    XQueryException 99 |
    XQuery Exception
    100 |
    104 |
  • 105 |
106 |
107 | 108 |
109 | 110 | 111 | 112 | 113 | 123 |
124 | 151 | 152 | 153 | 154 | -------------------------------------------------------------------------------- /javadoc/overview-tree.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Class Hierarchy 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Hierarchy For All Packages

67 | Package Hierarchies: 68 | 73 |
74 |
75 |

Class Hierarchy

76 |
    77 |
  • java.lang.Object 78 |
      79 |
    • com.elsevier.spark_xml_utils.xslt.S3URIResolver (implements javax.xml.transform.URIResolver)
    • 80 |
    • java.lang.Throwable (implements java.io.Serializable) 81 |
        82 |
      • java.lang.Exception 83 | 88 |
      • 89 |
      90 |
    • 91 |
    • com.elsevier.spark_xml_utils.xpath.XPathProcessor (implements java.io.Serializable)
    • 92 |
    • com.elsevier.spark_xml_utils.xquery.XQueryProcessor (implements java.io.Serializable)
    • 93 |
    • com.elsevier.spark_xml_utils.xslt.XSLTProcessor (implements java.io.Serializable)
    • 94 |
    95 |
  • 96 |
97 |
98 | 99 |
100 | 101 | 102 | 103 | 104 | 114 |
115 | 142 | 143 | 144 | 145 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xslt/package-use.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Package com.elsevier.spark_xml_utils.xslt 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Package
com.elsevier.spark_xml_utils.xslt

67 |
68 |
69 | 108 |
109 | 110 |
111 | 112 | 113 | 114 | 115 | 125 |
126 | 153 | 154 | 155 | 156 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xquery/package-use.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Package com.elsevier.spark_xml_utils.xquery 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Package
com.elsevier.spark_xml_utils.xquery

67 |
68 |
69 | 109 |
110 | 111 |
112 | 113 | 114 | 115 | 116 | 126 |
127 | 154 | 155 | 156 | 157 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xslt/package-summary.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | com.elsevier.spark_xml_utils.xslt 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Package com.elsevier.spark_xml_utils.xslt

67 |
68 |
69 |
    70 |
  • 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 84 | 85 | 86 | 87 | 90 | 91 | 92 |
    Class Summary 
    ClassDescription
    S3URIResolver 81 |
    URI Resolver that will be used by XLTProcessor when resolving xsl:import and 82 | xsl:include statements.
    83 |
    XSLTProcessor 88 |
    Class that provides xml transforming capabilities (via xslt) for xml passed as a String.
    89 |
    93 |
  • 94 |
  • 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 107 | 108 | 109 |
    Exception Summary 
    ExceptionDescription
    XSLTException 105 |
    XSLT Exception
    106 |
    110 |
  • 111 |
112 |
113 | 114 |
115 | 116 | 117 | 118 | 119 | 129 |
130 | 157 | 158 | 159 | 160 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xpath/package-use.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Package com.elsevier.spark_xml_utils.xpath 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Package
com.elsevier.spark_xml_utils.xpath

67 |
68 |
69 | 110 |
111 | 112 |
113 | 114 | 115 | 116 | 117 | 127 |
128 | 155 | 156 | 157 | 158 | -------------------------------------------------------------------------------- /javadoc/index-files/index-4.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | G-Index 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
C E F G R S T X  66 | 67 | 68 |

G

69 |
70 |
getInstance(String) - Static method in class com.elsevier.spark_xml_utils.xpath.XPathProcessor
71 |
72 |
Get an instance of XPathProcessor.
73 |
74 |
getInstance(String, HashMap<String, String>) - Static method in class com.elsevier.spark_xml_utils.xpath.XPathProcessor
75 |
76 |
Get an instance of XPathProcessor.
77 |
78 |
getInstance(String) - Static method in class com.elsevier.spark_xml_utils.xquery.XQueryProcessor
79 |
80 |
Get an instance of XQueryProcessor.
81 |
82 |
getInstance(String, HashMap<String, String>) - Static method in class com.elsevier.spark_xml_utils.xquery.XQueryProcessor
83 |
84 |
Get an instance of XQueryProcessor.
85 |
86 |
getInstance(String) - Static method in class com.elsevier.spark_xml_utils.xslt.XSLTProcessor
87 |
88 |
Get an instance of XSLTProcessor.
89 |
90 |
91 | C E F G R S T X 
92 | 93 |
94 | 95 | 96 | 97 | 98 | 108 |
109 | 136 | 137 | 138 | 139 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xslt/class-use/XSLTProcessor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Class com.elsevier.spark_xml_utils.xslt.XSLTProcessor 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Class
com.elsevier.spark_xml_utils.xslt.XSLTProcessor

67 |
68 |
69 | 110 |
111 | 112 |
113 | 114 | 115 | 116 | 117 | 127 |
128 | 155 | 156 | 157 | 158 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xslt/class-use/XSLTException.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Class com.elsevier.spark_xml_utils.xslt.XSLTException 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Class
com.elsevier.spark_xml_utils.xslt.XSLTException

67 |
68 |
69 | 116 |
117 | 118 |
119 | 120 | 121 | 122 | 123 | 133 |
134 | 161 | 162 | 163 | 164 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xpath/class-use/XPathProcessor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Class com.elsevier.spark_xml_utils.xpath.XPathProcessor 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Class
com.elsevier.spark_xml_utils.xpath.XPathProcessor

67 |
68 |
69 | 117 |
118 | 119 |
120 | 121 | 122 | 123 | 124 | 134 |
135 | 162 | 163 | 164 | 165 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xquery/class-use/XQueryProcessor.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Class com.elsevier.spark_xml_utils.xquery.XQueryProcessor 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Class
com.elsevier.spark_xml_utils.xquery.XQueryProcessor

67 |
68 |
69 | 117 |
118 | 119 |
120 | 121 | 122 | 123 | 124 | 134 |
135 | 162 | 163 | 164 | 165 | -------------------------------------------------------------------------------- /javadoc/index-files/index-8.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | X-Index 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
C E F G R S T X  66 | 67 | 68 |

X

69 |
70 |
XPathException - Exception in com.elsevier.spark_xml_utils.xpath
71 |
72 |
XPath Exception
73 |
74 |
XPathException(String) - Constructor for exception com.elsevier.spark_xml_utils.xpath.XPathException
75 |
 
76 |
XPathProcessor - Class in com.elsevier.spark_xml_utils.xpath
77 |
78 |
Class with methods to filter an XPath expression (return a TRUE/FALSE) 79 | against a string of arbitrary xml content and evaluate an XPath expression (return 80 | a serialized response) against a string of arbitrary xml content.
81 |
82 |
XQueryException - Exception in com.elsevier.spark_xml_utils.xquery
83 |
84 |
XQuery Exception
85 |
86 |
XQueryException(String) - Constructor for exception com.elsevier.spark_xml_utils.xquery.XQueryException
87 |
 
88 |
XQueryProcessor - Class in com.elsevier.spark_xml_utils.xquery
89 |
90 |
Class with methods to apply an XQuery expression against a string of 91 | arbitrary xml content.
92 |
93 |
XSLTException - Exception in com.elsevier.spark_xml_utils.xslt
94 |
95 |
XSLT Exception
96 |
97 |
XSLTException(String) - Constructor for exception com.elsevier.spark_xml_utils.xslt.XSLTException
98 |
 
99 |
XSLTProcessor - Class in com.elsevier.spark_xml_utils.xslt
100 |
101 |
Class that provides xml transforming capabilities (via xslt) for xml passed as a String.
102 |
103 |
104 | C E F G R S T X 
105 | 106 |
107 | 108 | 109 | 110 | 111 | 121 |
122 | 149 | 150 | 151 | 152 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xquery/class-use/XQueryException.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Class com.elsevier.spark_xml_utils.xquery.XQueryException 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Class
com.elsevier.spark_xml_utils.xquery.XQueryException

67 |
68 |
69 | 124 |
125 | 126 |
127 | 128 | 129 | 130 | 131 | 141 |
142 | 169 | 170 | 171 | 172 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xpath/class-use/XPathException.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | Uses of Class com.elsevier.spark_xml_utils.xpath.XPathException 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

Uses of Class
com.elsevier.spark_xml_utils.xpath.XPathException

67 |
68 |
69 |
    70 |
  • 71 | 72 | 73 | 74 | 75 | 76 | 77 | 78 | 79 | 80 | 81 | 82 | 83 |
    Packages that use XPathException 
    PackageDescription
    com.elsevier.spark_xml_utils.xpath 
    84 |
  • 85 |
  • 86 |
      87 |
    • 88 | 89 | 90 |

      Uses of XPathException in com.elsevier.spark_xml_utils.xpath

      91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 104 | 105 | 106 | 107 | 110 | 111 | 112 | 113 | 116 | 117 | 118 | 119 | 123 | 124 | 125 |
      Methods in com.elsevier.spark_xml_utils.xpath that throw XPathException 
      Modifier and TypeMethod and Description
      java.lang.StringXPathProcessor.evaluateString(java.lang.String content) 101 |
      Evaluate the content with the XPath expression specified when creating the XPathProcessor 102 | and return a serialized response.
      103 |
      booleanXPathProcessor.filterString(java.lang.String content) 108 |
      Filter the content with the XPath expression specified when creating the XPathProcessor.
      109 |
      static XPathProcessorXPathProcessor.getInstance(java.lang.String xPathExpression) 114 |
      Get an instance of XPathProcessor.
      115 |
      static XPathProcessorXPathProcessor.getInstance(java.lang.String xPathExpression, 120 | java.util.HashMap<java.lang.String,java.lang.String> namespaceMappings) 121 |
      Get an instance of XPathProcessor.
      122 |
      126 |
    • 127 |
    128 |
  • 129 |
130 |
131 | 132 |
133 | 134 | 135 | 136 | 137 | 147 |
148 | 175 | 176 | 177 | 178 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xpath/XPathException.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | XPathException 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 79 | 80 | 81 |
82 |
com.elsevier.spark_xml_utils.xpath
83 |

Class XPathException

84 |
85 |
86 |
    87 |
  • java.lang.Object
  • 88 |
  • 89 |
      90 |
    • java.lang.Throwable
    • 91 |
    • 92 |
        93 |
      • java.lang.Exception
      • 94 |
      • 95 |
          96 |
        • com.elsevier.spark_xml_utils.xpath.XPathException
        • 97 |
        98 |
      • 99 |
      100 |
    • 101 |
    102 |
  • 103 |
104 |
105 |
    106 |
  • 107 |
    108 |
    All Implemented Interfaces:
    109 |
    java.io.Serializable
    110 |
    111 |
    112 |
    113 |
    public class XPathException
    114 | extends java.lang.Exception
    115 |
    XPath Exception
    116 |
    Author:
    117 |
    Darin McBeath
    118 |
    See Also:
    Serialized Form
    119 |
  • 120 |
121 |
122 |
123 |
    124 |
  • 125 | 126 |
      127 |
    • 128 | 129 | 130 |

      Constructor Summary

      131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 |
      Constructors 
      Constructor and Description
      XPathException(java.lang.String msg) 
      140 |
    • 141 |
    142 | 143 |
      144 |
    • 145 | 146 | 147 |

      Method Summary

      148 |
        149 |
      • 150 | 151 | 152 |

        Methods inherited from class java.lang.Throwable

        153 | addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • 154 |
      155 |
        156 |
      • 157 | 158 | 159 |

        Methods inherited from class java.lang.Object

        160 | equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • 161 |
      162 |
    • 163 |
    164 |
  • 165 |
166 |
167 |
168 |
    169 |
  • 170 | 171 |
      172 |
    • 173 | 174 | 175 |

      Constructor Detail

      176 | 177 | 178 | 179 |
        180 |
      • 181 |

        XPathException

        182 |
        public XPathException(java.lang.String msg)
        183 |
      • 184 |
      185 |
    • 186 |
    187 |
  • 188 |
189 |
190 |
191 | 192 | 193 |
194 | 195 | 196 | 197 | 198 | 208 |
209 | 251 | 252 | 253 | 254 | -------------------------------------------------------------------------------- /javadoc/com/elsevier/spark_xml_utils/xquery/XQueryException.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | XQueryException 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 79 | 80 | 81 |
82 |
com.elsevier.spark_xml_utils.xquery
83 |

Class XQueryException

84 |
85 |
86 |
    87 |
  • java.lang.Object
  • 88 |
  • 89 |
      90 |
    • java.lang.Throwable
    • 91 |
    • 92 |
        93 |
      • java.lang.Exception
      • 94 |
      • 95 |
          96 |
        • com.elsevier.spark_xml_utils.xquery.XQueryException
        • 97 |
        98 |
      • 99 |
      100 |
    • 101 |
    102 |
  • 103 |
104 |
105 |
    106 |
  • 107 |
    108 |
    All Implemented Interfaces:
    109 |
    java.io.Serializable
    110 |
    111 |
    112 |
    113 |
    public class XQueryException
    114 | extends java.lang.Exception
    115 |
    XQuery Exception
    116 |
    Author:
    117 |
    Darin McBeath
    118 |
    See Also:
    Serialized Form
    119 |
  • 120 |
121 |
122 |
123 |
    124 |
  • 125 | 126 |
      127 |
    • 128 | 129 | 130 |

      Constructor Summary

      131 | 132 | 133 | 134 | 135 | 136 | 137 | 138 | 139 |
      Constructors 
      Constructor and Description
      XQueryException(java.lang.String msg) 
      140 |
    • 141 |
    142 | 143 |
      144 |
    • 145 | 146 | 147 |

      Method Summary

      148 |
        149 |
      • 150 | 151 | 152 |

        Methods inherited from class java.lang.Throwable

        153 | addSuppressed, fillInStackTrace, getCause, getLocalizedMessage, getMessage, getStackTrace, getSuppressed, initCause, printStackTrace, printStackTrace, printStackTrace, setStackTrace, toString
      • 154 |
      155 |
        156 |
      • 157 | 158 | 159 |

        Methods inherited from class java.lang.Object

        160 | equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
      • 161 |
      162 |
    • 163 |
    164 |
  • 165 |
166 |
167 |
168 |
    169 |
  • 170 | 171 |
      172 |
    • 173 | 174 | 175 |

      Constructor Detail

      176 | 177 | 178 | 179 |
        180 |
      • 181 |

        XQueryException

        182 |
        public XQueryException(java.lang.String msg)
        183 |
      • 184 |
      185 |
    • 186 |
    187 |
  • 188 |
189 |
190 |
191 | 192 | 193 |
194 | 195 | 196 | 197 | 198 | 208 |
209 | 251 | 252 | 253 | 254 | -------------------------------------------------------------------------------- /javadoc/help-doc.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 | API Help 7 | 8 | 9 | 10 | 11 | 17 | 20 | 21 |
22 | 23 | 24 | 25 | 26 | 36 |
37 | 64 | 65 |
66 |

How This API Document Is Organized

67 |
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
68 |
69 |
70 |
    71 |
  • 72 |

    Overview

    73 |

    The Overview page is the front page of this API document and provides a list of all packages with a summary for each. This page can also contain an overall description of the set of packages.

    74 |
  • 75 |
  • 76 |

    Package

    77 |

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. This page can contain six categories:

    78 |
      79 |
    • Interfaces (italic)
    • 80 |
    • Classes
    • 81 |
    • Enums
    • 82 |
    • Exceptions
    • 83 |
    • Errors
    • 84 |
    • Annotation Types
    • 85 |
    86 |
  • 87 |
  • 88 |

    Class/Interface

    89 |

    Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

    90 |
      91 |
    • Class inheritance diagram
    • 92 |
    • Direct Subclasses
    • 93 |
    • All Known Subinterfaces
    • 94 |
    • All Known Implementing Classes
    • 95 |
    • Class/interface declaration
    • 96 |
    • Class/interface description
    • 97 |
    98 |
      99 |
    • Nested Class Summary
    • 100 |
    • Field Summary
    • 101 |
    • Constructor Summary
    • 102 |
    • Method Summary
    • 103 |
    104 |
      105 |
    • Field Detail
    • 106 |
    • Constructor Detail
    • 107 |
    • Method Detail
    • 108 |
    109 |

    Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

    110 |
  • 111 |
  • 112 |

    Annotation Type

    113 |

    Each annotation type has its own separate page with the following sections:

    114 |
      115 |
    • Annotation Type declaration
    • 116 |
    • Annotation Type description
    • 117 |
    • Required Element Summary
    • 118 |
    • Optional Element Summary
    • 119 |
    • Element Detail
    • 120 |
    121 |
  • 122 |
  • 123 |

    Enum

    124 |

    Each enum has its own separate page with the following sections:

    125 |
      126 |
    • Enum declaration
    • 127 |
    • Enum description
    • 128 |
    • Enum Constant Summary
    • 129 |
    • Enum Constant Detail
    • 130 |
    131 |
  • 132 |
  • 133 |

    Use

    134 |

    Each documented package, class and interface has its own Use page. This page describes what packages, classes, methods, constructors and fields use any part of the given class or package. Given a class or interface A, its Use page includes subclasses of A, fields declared as A, methods that return A, and methods and constructors with parameters of type A. You can access this page by first going to the package, class or interface, then clicking on the "Use" link in the navigation bar.

    135 |
  • 136 |
  • 137 |

    Tree (Class Hierarchy)

    138 |

    There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. The classes are organized by inheritance structure starting with java.lang.Object. The interfaces do not inherit from java.lang.Object.

    139 |
      140 |
    • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
    • 141 |
    • When viewing a particular package, class or interface page, clicking "Tree" displays the hierarchy for only that package.
    • 142 |
    143 |
  • 144 |
  • 145 |

    Deprecated API

    146 |

    The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

    147 |
  • 148 |
  • 149 |

    Index

    150 |

    The Index contains an alphabetic list of all classes, interfaces, constructors, methods, and fields.

    151 |
  • 152 |
  • 153 |

    Prev/Next

    154 |

    These links take you to the next or previous class, interface, package, or related page.

    155 |
  • 156 |
  • 157 |

    Frames/No Frames

    158 |

    These links show and hide the HTML frames. All pages are available with or without frames.

    159 |
  • 160 |
  • 161 |

    All Classes

    162 |

    The All Classes link shows all classes and interfaces except non-static nested types.

    163 |
  • 164 |
  • 165 |

    Serialized Form

    166 |

    Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

    167 |
  • 168 |
  • 169 |

    Constant Field Values

    170 |

    The Constant Field Values page lists the static final fields and their values.

    171 |
  • 172 |
173 | This help file applies to API documentation generated using the standard doclet.
174 | 175 |
176 | 177 | 178 | 179 | 180 | 190 |
191 | 218 | 219 | 220 | 221 | --------------------------------------------------------------------------------