|
|||||||||||||||||||
Source file | Conditionals | Statements | Methods | TOTAL | |||||||||||||||
DocumentHelper.java | 94,4% | 73,4% | 50% | 71,3% |
|
1 | /* | |
2 | * Copyright 2001-2004 (C) MetaStuff, Ltd. All Rights Reserved. | |
3 | * | |
4 | * This software is open source. | |
5 | * See the bottom of this file for the licence. | |
6 | * | |
7 | * $Id: DocumentHelper.java,v 1.23 2004/07/11 10:49:36 maartenc Exp $ | |
8 | */ | |
9 | ||
10 | package org.dom4j; | |
11 | ||
12 | import java.io.StringReader; | |
13 | import java.util.List; | |
14 | import java.util.Map; | |
15 | import java.util.StringTokenizer; | |
16 | ||
17 | import org.dom4j.io.SAXReader; | |
18 | import org.dom4j.rule.Pattern; | |
19 | import org.jaxen.VariableContext; | |
20 | import org.xml.sax.InputSource; | |
21 | ||
22 | /** <p><code>DocumentHelper</code> is a collection of helper methods | |
23 | * for using DOM4J.</p> | |
24 | * | |
25 | * @author <a href="mailto:jstrachan@apache.org">James Strachan</a> | |
26 | * @version $Revision: 1.23 $ | |
27 | */ | |
28 | public class DocumentHelper { | |
29 | ||
30 | ||
31 | // Static helper methods | |
32 | ||
33 | 304 | public static Document createDocument() { |
34 | 304 | return DocumentFactory.getInstance().createDocument(); |
35 | } | |
36 | ||
37 | 2 | public static Document createDocument(Element rootElement) { |
38 | 2 | return DocumentFactory.getInstance().createDocument(rootElement); |
39 | } | |
40 | ||
41 | ||
42 | 4000 | public static Element createElement(QName qname) { |
43 | 4000 | return DocumentFactory.getInstance().createElement(qname); |
44 | } | |
45 | ||
46 | 2 | public static Element createElement(String name) { |
47 | 2 | return DocumentFactory.getInstance().createElement(name); |
48 | } | |
49 | ||
50 | ||
51 | 0 | public static Attribute createAttribute(Element owner, QName qname, String value) { |
52 | 0 | return DocumentFactory.getInstance().createAttribute(owner, qname, value); |
53 | } | |
54 | ||
55 | 0 | public static Attribute createAttribute(Element owner, String name, String value) { |
56 | 0 | return DocumentFactory.getInstance().createAttribute(owner, name, value); |
57 | } | |
58 | ||
59 | 0 | public static CDATA createCDATA(String text) { |
60 | 0 | return DocumentFactory.getInstance().createCDATA(text); |
61 | } | |
62 | ||
63 | 0 | public static Comment createComment(String text) { |
64 | 0 | return DocumentFactory.getInstance().createComment(text); |
65 | } | |
66 | ||
67 | 0 | public static Text createText(String text) { |
68 | 0 | return DocumentFactory.getInstance().createText(text); |
69 | } | |
70 | ||
71 | ||
72 | 0 | public static Entity createEntity(String name, String text) { |
73 | 0 | return DocumentFactory.getInstance().createEntity(name, text); |
74 | } | |
75 | ||
76 | 0 | public static Namespace createNamespace(String prefix, String uri) { |
77 | 0 | return DocumentFactory.getInstance().createNamespace(prefix, uri); |
78 | } | |
79 | ||
80 | 4 | public static ProcessingInstruction createProcessingInstruction(String target, String data) { |
81 | 4 | return DocumentFactory.getInstance().createProcessingInstruction(target, data); |
82 | } | |
83 | ||
84 | 0 | public static ProcessingInstruction createProcessingInstruction(String target, Map data) { |
85 | 0 | return DocumentFactory.getInstance().createProcessingInstruction(target, data); |
86 | } | |
87 | ||
88 | 0 | public static QName createQName(String localName, Namespace namespace) { |
89 | 0 | return DocumentFactory.getInstance().createQName(localName, namespace); |
90 | } | |
91 | ||
92 | 20000 | public static QName createQName(String localName) { |
93 | 20000 | return DocumentFactory.getInstance().createQName(localName); |
94 | } | |
95 | ||
96 | ||
97 | /** <p><code>createXPath</code> parses an XPath expression | |
98 | * and creates a new XPath <code>XPath</code> instance | |
99 | * using the singleton {@link DocumentFactory}.</p> | |
100 | * | |
101 | * @param xpathExpression is the XPath expression to create | |
102 | * @return a new <code>XPath</code> instance | |
103 | * @throws InvalidXPathException if the XPath expression is invalid | |
104 | */ | |
105 | 106 | public static XPath createXPath(String xpathExpression) throws InvalidXPathException { |
106 | 106 | return DocumentFactory.getInstance().createXPath(xpathExpression); |
107 | } | |
108 | ||
109 | /** <p><code>createXPath</code> parses an XPath expression | |
110 | * and creates a new XPath <code>XPath</code> instance | |
111 | * using the singleton {@link DocumentFactory}.</p> | |
112 | * | |
113 | * @param xpathExpression is the XPath expression to create | |
114 | * @param variableContext is the variable context to use when evaluating the XPath | |
115 | * @return a new <code>XPath</code> instance | |
116 | * @throws InvalidXPathException if the XPath expression is invalid | |
117 | */ | |
118 | 12 | public static XPath createXPath(String xpathExpression, VariableContext variableContext) throws InvalidXPathException { |
119 | 12 | return DocumentFactory.getInstance().createXPath(xpathExpression, variableContext); |
120 | } | |
121 | ||
122 | ||
123 | /** <p><code>createXPathFilter</code> parses a NodeFilter | |
124 | * from the given XPath filter expression using the singleton | |
125 | * {@link DocumentFactory}. | |
126 | * XPath filter expressions occur within XPath expressions such as | |
127 | * <code>self::node()[ filterExpression ]</code></p> | |
128 | * | |
129 | * @param xpathFilterExpression is the XPath filter expression | |
130 | * to create | |
131 | * @return a new <code>NodeFilter</code> instance | |
132 | */ | |
133 | 8 | public static NodeFilter createXPathFilter(String xpathFilterExpression) { |
134 | 8 | return DocumentFactory.getInstance().createXPathFilter(xpathFilterExpression); |
135 | } | |
136 | ||
137 | /** <p><code>createPattern</code> parses the given | |
138 | * XPath expression to create an XSLT style {@link Pattern} instance | |
139 | * which can then be used in an XSLT processing model.</p> | |
140 | * | |
141 | * @param xpathPattern is the XPath pattern expression | |
142 | * to create | |
143 | * @return a new <code>Pattern</code> instance | |
144 | */ | |
145 | 26 | public static Pattern createPattern(String xpathPattern) { |
146 | 26 | return DocumentFactory.getInstance().createPattern(xpathPattern); |
147 | } | |
148 | ||
149 | ||
150 | /** <p><code>selectNodes</code> performs the given XPath | |
151 | * expression on the {@link List} of {@link Node} instances appending | |
152 | * all the results together into a single list.</p> | |
153 | * | |
154 | * @param xpathFilterExpression is the XPath filter expression | |
155 | * to evaluate | |
156 | * @param nodes is the list of nodes on which to evalute the XPath | |
157 | * @return the results of all the XPath evaluations as a single list | |
158 | */ | |
159 | 0 | public static List selectNodes(String xpathFilterExpression, List nodes) { |
160 | 0 | XPath xpath = createXPath( xpathFilterExpression ); |
161 | 0 | return xpath.selectNodes( nodes ); |
162 | } | |
163 | ||
164 | /** <p><code>selectNodes</code> performs the given XPath | |
165 | * expression on the {@link List} of {@link Node} instances appending | |
166 | * all the results together into a single list.</p> | |
167 | * | |
168 | * @param xpathFilterExpression is the XPath filter expression | |
169 | * to evaluate | |
170 | * @param node is the Node on which to evalute the XPath | |
171 | * @return the results of all the XPath evaluations as a single list | |
172 | */ | |
173 | 0 | public static List selectNodes(String xpathFilterExpression, Node node) { |
174 | 0 | XPath xpath = createXPath( xpathFilterExpression ); |
175 | 0 | return xpath.selectNodes( node ); |
176 | } | |
177 | ||
178 | /** <p><code>sort</code> sorts the given List of Nodes | |
179 | * using an XPath expression as a {@link java.util.Comparator}. | |
180 | * | |
181 | * @param list is the list of Nodes to sort | |
182 | * @param xpathExpression is the XPath expression used for comparison | |
183 | */ | |
184 | 0 | public static void sort( List list, String xpathExpression ) { |
185 | 0 | XPath xpath = createXPath( xpathExpression ); |
186 | 0 | xpath.sort( list ); |
187 | } | |
188 | ||
189 | /** <p><code>sort</code> sorts the given List of Nodes | |
190 | * using an XPath expression as a {@link java.util.Comparator} | |
191 | * and optionally removing duplicates.</p> | |
192 | * | |
193 | * @param list is the list of Nodes to sort | |
194 | * @param xpathExpression is the XPath expression used for comparison | |
195 | * @param distinct if true then duplicate values (using the sortXPath for | |
196 | * comparisions) will be removed from the List | |
197 | */ | |
198 | 0 | public static void sort( List list, String xpathExpression, boolean distinct ) { |
199 | 0 | XPath xpath = createXPath( xpathExpression ); |
200 | 0 | xpath.sort( list, distinct ); |
201 | } | |
202 | ||
203 | /** <p><code>parseText</code> parses the given text as an XML document | |
204 | * and returns the newly created Document. | |
205 | * | |
206 | * @param text is the XML text to be parsed | |
207 | * @return a newly parsed Document | |
208 | * @throws DocumentException if the document could not be parsed | |
209 | */ | |
210 | 11094 | public static Document parseText(String text) throws DocumentException { |
211 | 11094 | SAXReader reader = new SAXReader(); |
212 | 11094 | String encoding = getEncoding(text); |
213 | ||
214 | 11094 | InputSource source = new InputSource(new StringReader(text)); |
215 | 11094 | source.setEncoding(encoding); |
216 | 11094 | return reader.read(source); |
217 | } | |
218 | ||
219 | 11094 | private static String getEncoding(String text) { |
220 | 11094 | String result = null; |
221 | ||
222 | 11094 | String xml = text.trim(); |
223 | 11094 | if (xml.startsWith("<?xml")) { |
224 | 46 | int end = xml.indexOf("?>"); |
225 | 46 | String sub = xml.substring(0, end); |
226 | 46 | StringTokenizer tokens = new StringTokenizer(sub, " =\"\'"); |
227 | 46 | while (tokens.hasMoreTokens()) { |
228 | 182 | String token = tokens.nextToken(); |
229 | 182 | if ("encoding".equals(token)) { |
230 | 44 | if (tokens.hasMoreTokens()) { |
231 | 44 | result = tokens.nextToken(); |
232 | } | |
233 | 44 | break; |
234 | } | |
235 | } | |
236 | } | |
237 | ||
238 | 11094 | return result; |
239 | } | |
240 | ||
241 | /** <p>makeElement</p> a helper method which navigates from the | |
242 | * given Document or Element node to some Element using the path | |
243 | * expression, creating any necessary elements along the way. | |
244 | * For example the path <code>a/b/c</code> would get the first | |
245 | * child <a> element, which would be created if it did not | |
246 | * exist, then the next child <b> and so on until finally a | |
247 | * <c> element is returned. | |
248 | * | |
249 | * @param source is the Element or Document to start navigating from | |
250 | * @param path is a simple path expression, seperated by '/' which denotes | |
251 | * the path from the source to the resulting element such as a/b/c | |
252 | * | |
253 | * @return the first Element on the given path which either already | |
254 | * existed on the path or were created by this method. | |
255 | */ | |
256 | 12 | public static Element makeElement(Branch source, String path) { |
257 | 12 | StringTokenizer tokens = new StringTokenizer( path, "/" ); |
258 | 12 | Element parent; |
259 | 12 | if ( source instanceof Document ) { |
260 | 8 | Document document = (Document) source; |
261 | 8 | parent = document.getRootElement(); |
262 | ||
263 | // lets throw a NoSuchElementException | |
264 | // if we are given an empty path | |
265 | 8 | String name = tokens.nextToken(); |
266 | 8 | if ( parent == null ) { |
267 | 2 | parent = document.addElement( name ); |
268 | } | |
269 | } | |
270 | else { | |
271 | 4 | parent = (Element) source; |
272 | } | |
273 | 12 | Element element = null; |
274 | 12 | while ( tokens.hasMoreTokens() ) { |
275 | 28 | String name = tokens.nextToken(); |
276 | 28 | if ( name.indexOf( ':' ) > 0 ) { |
277 | 8 | element = parent.element( parent.getQName( name ) ); |
278 | } | |
279 | else { | |
280 | 20 | element = parent.element( name ); |
281 | } | |
282 | 28 | if ( element == null ) { |
283 | 12 | element = parent.addElement( name ); |
284 | } | |
285 | 28 | parent = element; |
286 | } | |
287 | 12 | return element; |
288 | } | |
289 | } | |
290 | ||
291 | ||
292 | ||
293 | ||
294 | /* | |
295 | * Redistribution and use of this software and associated documentation | |
296 | * ("Software"), with or without modification, are permitted provided | |
297 | * that the following conditions are met: | |
298 | * | |
299 | * 1. Redistributions of source code must retain copyright | |
300 | * statements and notices. Redistributions must also contain a | |
301 | * copy of this document. | |
302 | * | |
303 | * 2. Redistributions in binary form must reproduce the | |
304 | * above copyright notice, this list of conditions and the | |
305 | * following disclaimer in the documentation and/or other | |
306 | * materials provided with the distribution. | |
307 | * | |
308 | * 3. The name "DOM4J" must not be used to endorse or promote | |
309 | * products derived from this Software without prior written | |
310 | * permission of MetaStuff, Ltd. For written permission, | |
311 | * please contact dom4j-info@metastuff.com. | |
312 | * | |
313 | * 4. Products derived from this Software may not be called "DOM4J" | |
314 | * nor may "DOM4J" appear in their names without prior written | |
315 | * permission of MetaStuff, Ltd. DOM4J is a registered | |
316 | * trademark of MetaStuff, Ltd. | |
317 | * | |
318 | * 5. Due credit should be given to the DOM4J Project - | |
319 | * http://www.dom4j.org | |
320 | * | |
321 | * THIS SOFTWARE IS PROVIDED BY METASTUFF, LTD. AND CONTRIBUTORS | |
322 | * ``AS IS'' AND ANY EXPRESSED OR IMPLIED WARRANTIES, INCLUDING, BUT | |
323 | * NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND | |
324 | * FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL | |
325 | * METASTUFF, LTD. OR ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, | |
326 | * INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES | |
327 | * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR | |
328 | * SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | |
329 | * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, | |
330 | * STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) | |
331 | * ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED | |
332 | * OF THE POSSIBILITY OF SUCH DAMAGE. | |
333 | * | |
334 | * Copyright 2001-2004 (C) MetaStuff, Ltd. All Rights Reserved. | |
335 | * | |
336 | * $Id: DocumentHelper.java,v 1.23 2004/07/11 10:49:36 maartenc Exp $ | |
337 | */ |
|