| blob | 795b71db3194af569b8ae909472450be45adc71d |
1 /*************************************************************************
2 *
3 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
4 *
5 * Copyright 2008 by Sun Microsystems, Inc.
6 *
7 * OpenOffice.org - a multi-platform office productivity suite
8 *
9 * $RCSfile: XMLHelper.java,v $
10 * $Revision: 1.7 $
11 *
12 * This file is part of OpenOffice.org.
13 *
14 * OpenOffice.org is free software: you can redistribute it and/or modify
15 * it under the terms of the GNU Lesser General Public License version 3
16 * only, as published by the Free Software Foundation.
17 *
18 * OpenOffice.org is distributed in the hope that it will be useful,
19 * but WITHOUT ANY WARRANTY; without even the implied warranty of
20 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 * GNU Lesser General Public License version 3 for more details
22 * (a copy is included in the LICENSE file that accompanied this code).
23 *
24 * You should have received a copy of the GNU Lesser General Public License
25 * version 3 along with OpenOffice.org. If not, see
26 * <http://www.openoffice.org/license.html>
27 * for a copy of the LGPLv3 License.
28 *
29 ************************************************************************/
33 //_______________________________________________
39 //_______________________________________________
41 /**
42 * It provides some constant values and some static helper routines
43 * which are neccessary to work with a xml file - especialy
44 * the filter configuration.
45 *
46 *
47 */
48 public class XMLHelper
49 {
50 //___________________________________________
51 // public const
53 /** its a possible value of the xml attribute "oor:type" and identify an integer type. */
56 /** its a possible value of the xml attribute "oor:type" and identify an boolean type. */
59 /** its a possible value of the xml attribute "oor:type" and identify an string type. */
62 /** its a possible value of the xml attribute "oor:type" and identify an string list type. */
65 /** its a xml attribute, which specify a property name. */
68 /** its a xml attribute, which specify a property type. */
71 /** its a xml attribute, which specify a list separator. */
74 /** its a xml attribute, which specify a localized value. */
77 /** its a xml attribute, which specify a merge operation for cfg layering. */
80 /** can be used as value for XMLATTRIB_OOR_OP. */
83 /** its a xml attribute, which specify a locale value. */
86 /** its the tag name of a <value ...> entry. */
89 /** its the tag name of a <prop ...> entry. */
92 /** its the tag name of a <node ...> entry. */
95 //___________________________________________
96 // private const
98 /** a static list of all possible separators, which can be used for configuration type string-list. */
99 private static final java.lang.String[] DELIMS = {" ", ",", ";", ".", ":", "-", "_", "#", "'", "+", "*", "~", "=", "?"};
101 /** index of the default separator inside list DELIMS.
102 * Its neccessary to know such default separator; because it can
103 * be supressed as xml attribute of the corresponding value tag. */
106 //___________________________________________
108 /** analyze the structures of the given XML node and
109 * return a property set of all found sub nodes.
110 *
111 * Such properties are organized as [name, value] pairs.
112 * The type of a xml node will be detected automaticly.
113 * Following types are supported:
114 * xs:int => java.lang.Integer
115 * xs:bool => java.lang.Boolean
116 * xs:string => java.lang.String
117 * oor:string-list => java.util.LinkedList[java.lang.String]
118 * oor:set => java.util.Vector[java.lang.Object]
119 * oor:localized => java.util.HashMap[java.lang.Object]
120 *
121 * @param aNode
122 * points directly to the xml node, where we should analyze
123 * the children nodes.
124 *
125 * @return [java.util.HashMap]
126 * contains every node name as key and its string(!) as value.
127 */
130 {
133 // get all child nodes, which seems to be properties
137 {
140 // read its name
141 java.lang.String sChildName = XMLHelper.extractNodeAttribByName(aChildNode, XMLATTRIB_OOR_NAME);
145 // read its type info
146 java.lang.String sChildType = XMLHelper.extractNodeAttribByName(aChildNode, XMLATTRIB_OOR_TYPE);
148 {
149 /** Special patch:
150 * If an xml tag has no type information set ... we can restore it
151 * by analyzing the already readed tag name :-)
152 * Not very nice - but it can help to read stripped xml files too. */
156 }
158 // read its value(s?)
164 {
166 java.lang.String sChildLocale = XMLHelper.extractNodeAttribByName(aValueNode, XMLATTRIB_XML_LANG);
172 {
174 throw new java.io.IOException("unsupported format: more then one value for non localized but atomic type detected");
177 }
178 else
180 {
182 throw new java.io.IOException("unsupported format: more then one value for non localized but atomic type detected");
185 }
186 else
188 {
190 throw new java.io.IOException("unsupported format: more then one value for non localized but atomic type detected");
196 {
201 }
202 else
204 }
205 else
207 {
209 throw new java.io.IOException("unsupported format: more then one value for non localized but atomic type detected");
211 java.lang.String sSeparator = XMLHelper.extractNodeAttribByName(aChildNode, XMLATTRIB_OOR_SEPARATOR);
221 {
227 }
229 }
232 }
233 }
236 }
238 //___________________________________________
241 {
259 )
261 else
265 )
267 else
272 )
274 else
281 )
288 }
290 //___________________________________________
292 /** return a xml representation of the given property set.
293 *
294 * @param aPropSet
295 * a set of <name,value> pairs, which should be translated to xml
296 *
297 * @return [java.lang.String]
298 * the xml string representation.
299 *
300 * @throws [java.lang.Exception]
301 * if anything during convertion fill fail.
302 */
306 {
311 {
317 // is it a simple type?
322 )
323 {
326 }
328 // no!
329 // is it a list value?
331 {
335 }
337 // its a localized value?
339 {
343 }
345 // unknown type!
351 }
354 }
357 {
362 {
366 else
368 }
375 }
377 //___________________________________________
379 /** return a xml representation of an atomic property.
380 *
381 * Atomic property types are e.g. Integer, Boolean, String.
382 *
383 * @param sName
384 * the name of the property.
386 * @param aValue
387 * the value of the property.
388 *
389 * @param nPrettyTabs
390 * count of tab signs for pretty format the xml code :-)
391 *
392 * @return [java.lang.String]
393 * the xml string representation.
394 *
395 * @throws [java.lang.Exception]
396 * if anything during convertion fill fail.
397 */
402 {
408 {
412 }
413 else
415 {
419 }
420 else
422 {
430 else
431 {
434 }
435 }
436 else
437 {
440 // ! can be used outside to detect - that it was not a simple type :-)
442 }
445 }
447 //___________________________________________
449 /** return a xml representation of a string-list property.
450 *
451 * @param sName
452 * the name of the property.
454 * @param aValue
455 * the value of the property.
456 *
457 * @param nPrettyTabs
458 * count of tab signs for pretty format the xml code :-)
459 *
460 * @return [java.lang.String]
461 * the xml string representation.
462 *
463 * @throws [java.lang.Exception]
464 * if anything during convertion fill fail.
465 */
470 {
478 {
481 }
483 // step over all list items and add it to a string buffer
484 // Every item will be separated by a default separator "\n" first.
485 // Because "\n" is not a valid separator at all and can`t occure inside
486 // our list items. During we step over all items, we check if our current separator
487 // (we use a list of possible ones!) clash with an item.
488 // If it clash - we step to the next possible separator.
489 // If our list of possible separator values runs out of range we throw
490 // an exception :-) Its better then generating of wrong values
491 // If we found a valid seperator - we use it to replace our "\n" place holder
492 // at the end of the following loop ...
497 {
498 // get the next list item
507 // append item with default separator, which isn a valid separator at all
508 // But supress adding of the separator if last element is reached.
513 // check for delim clash
514 // Attention: An empty (means default) element forbid using
515 // of a whitespace character as separator!
517 {
521 {
524 }
526 {
529 }
531 }
532 }
534 // replace default separator with right one
537 //TODO_JAVA java.lang.String sListVal = sValBuff.toString().replaceAll("\n", DELIMS[d]);
543 else
550 }
552 //___________________________________________
554 /** return a xml representation of a localized property.
555 *
556 * @param sName
557 * the name of the property.
559 * @param aValue
560 * the value of the property.
561 *
562 * @param nPrettyTabs
563 * count of tab signs for pretty format the xml code :-)
564 *
565 * @return [java.lang.String]
566 * the xml string representation.
567 *
568 * @throws [java.lang.Exception]
569 * if anything during convertion fill fail.
570 */
575 {
580 throw new java.lang.Exception("Cant detect type of localized values. Because the given list is empty.");
584 // !Our localized values must be formated at a deeper coloum
585 // then its property name!
590 // boolean bTypeKnown = false;
592 {
595 /*
596 if (!bTypeKnown)
597 {
598 bTypeKnown = true;
599 if (aLocalizedValue instanceof java.lang.Integer)
600 sXML.append(" "+XMLATTRIB_OOR_TYPE+"=\""+XMLTYPE_INTEGER+"\">\n");
601 else
602 if (aLocalizedValue instanceof java.lang.Boolean)
603 sXML.append(" "+XMLATTRIB_OOR_TYPE+"=\""+XMLTYPE_BOOLEAN+"\">\n");
604 else
605 if (aLocalizedValue instanceof java.lang.String)
606 sXML.append(" "+XMLATTRIB_OOR_TYPE+"=\""+XMLTYPE_STRING+"\">\n");
607 else
608 throw new java.lang.Exception("Unsupported type for localized value detected.");
609 }
610 */
617 }
624 }
626 //___________________________________________
628 /** returns the value of an attribute of the given node.
629 *
630 * If the given node represent an lement node, may it supports some attributes.
631 * Then this method search for an attribute with the specified name and return it's value.
632 * If nothing could be found ... or the given node isn't a suitable node ... it returns null.
633 *
634 * @param aNode
635 * the node, which should be analyzed.
636 *
637 * @param sAttrib
638 * name of the attribute, which should be searched.
639 *
640 * @return The value of the specified attribute if it could be found at the given node.
641 * Can be null if node doesn't support attributes or the searched one does not exist there.
642 */
646 {
647 // We can get valid attributes for element nodes only!
649 {
650 // System.err.println("not an element node");
652 }
654 // may it supports attributes in general ... but doesn't have anyone realy.
657 {
658 // System.err.println("no attributes at all");
660 }
662 // step over the attribute list and search for the requested one
664 {
667 {
670 }
671 }
673 // the searched attribute was not found!
674 // System.err.println("required attribute \""+sAttrib+"\" does not exist for node ["+aNode.toString()+"]");
676 }
678 //___________________________________________
680 /** returns a list of childs, which are ELEMENT_NODES and have the right tag name.
681 *
682 * It analyze the list of all possible child nodes. Only ELEMENT_NODES are candidates.
683 * All other ones will be ignored. Further these element nodes are compared by it's tag
684 * names. If it match with the specified value it's added to the return list.
685 * So the return list includes references to the DOM tree nodes only, which are child
686 * element nodes with the right tag name.
687 *
688 * @param aNode
689 * provides access to the child nodes, which should be analyzed
690 *
691 * @param sTag
692 * the searched tag name.
693 *
694 * @return A list of child nodes, which are element nodes and have the right tag name.
695 */
698 {
699 // extract first all ELEMENT_NODES of he given parent
700 // Such nodes only provide tag names.
701 java.util.Vector lChilds = XMLHelper.extractChildNodesByType(aNode,org.w3c.dom.Node.ELEMENT_NODE);
704 // step over the list and search for the right tags using the specified name
707 {
711 }
713 // pack(!) and return the list
716 }
718 //___________________________________________
720 /** returns a list of childs, which supports the right node type.
721 *
722 * It analyze the list of all possible child nodes. If a node represent the right node type
723 * it is added to the return list. Otherwhise it will be ignored.
724 *
725 * @param aNode
726 * provides access to the list of possible children nodes.
727 *
728 * @param nType
729 * represent the searched node type.
730 * Possible values are constant fields of a org.w3c.dom.Node - e.g. org.w3c.dom.Node.ELEMENT_NODE.
731 *
732 * @return A list of child nodes, which provides the right node type.
733 */
736 {
737 // get list of all possibe childs and reserve enough space for our return list
738 // Attention: A null pointer is not allowed for return! (means lExtractedChilds)
743 // step of these childs and select only needed ones
745 {
749 }
751 // pack(!) and return the list
754 }
756 //___________________________________________
758 /** generates an xml header, using parameters.
759 *
760 * @param sVersion
761 * number of the xml version.
762 *
763 * @param sEncoding
764 * used file encoding.
765 *
766 * @param sPath
767 * name of the configuration root.
768 *
769 * @param sPackage
770 * name of the configuration package.
771 *
772 * @param bLanguagepack
773 * force creation of a special header,
774 * which is needed for language packs only.
775 *
776 * @return [java.lang.String]
777 * the generated xml header.
779 */
785 {
789 {
803 }
804 else
805 {
810 sHeader.append("\"?>\n<!DOCTYPE oor:component-data SYSTEM \"../../../../component-update.dtd\">\n");
811 sHeader.append("<oor:component-data xmlns:oor=\"http://openoffice.org/2001/registry\" xmlns:xs=\"http://www.w3.org/2001/XMLSchema\" oor:package=\"");
816 }
819 }
822 {
824 }
825 }