1 /**
2 * This file Copyright (c) 2017 Magnolia International
3 * Ltd. (http://www.magnolia-cms.com). All rights reserved.
4 *
5 *
6 * This file is dual-licensed under both the Magnolia
7 * Network Agreement and the GNU General Public License.
8 * You may elect to use one or the other of these licenses.
9 *
10 * This file is distributed in the hope that it will be
11 * useful, but AS-IS and WITHOUT ANY WARRANTY; without even the
12 * implied warranty of MERCHANTABILITY or FITNESS FOR A
13 * PARTICULAR PURPOSE, TITLE, or NONINFRINGEMENT.
14 * Redistribution, except as permitted by whichever of the GPL
15 * or MNA you select, is prohibited.
16 *
17 * 1. For the GPL license (GPL), you can redistribute and/or
18 * modify this file under the terms of the GNU General
19 * Public License, Version 3, as published by the Free Software
20 * Foundation. You should have received a copy of the GNU
21 * General Public License, Version 3 along with this program;
22 * if not, write to the Free Software Foundation, Inc., 51
23 * Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
24 *
25 * 2. For the Magnolia Network Agreement (MNA), this file
26 * and the accompanying materials are made available under the
27 * terms of the MNA which accompanies this distribution, and
28 * is available at http://www.magnolia-cms.com/mna.html
29 *
30 * Any modifications to this file must keep this entire header
31 * intact.
32 *
33 */
34 package info.magnolia.importexport.outputter;
35
36 import java.io.IOException;
37 import java.io.Writer;
38 import java.util.List;
39
40 import org.apache.commons.lang3.StringUtils;
41 import org.apache.jackrabbit.util.ISO9075;
42 import org.jdom.Attribute;
43 import org.jdom.Element;
44 import org.jdom.output.Format;
45
46 /**
47 * {@link DocumentViewOutputter} for YAML format.
48 */
49 public class YamlOutputter extends DocumentViewOutputter {
50
51 public YamlOutputter() {
52 setSeparatorChars("\n");
53 setApostropheChars("");
54 setAsignmentChars(": ");
55
56 final Format format = super.getFormat();
57 format.setLineSeparator("\n");
58 setFormat(format);
59 }
60
61
62 @Override
63 protected void printElement(Writer out, Element element, int level, NamespaceStack namespaces) throws IOException {
64 setCurrentLevel(level);
65 indent(out, level);
66 List attributes = element.getAttributes();
67 if (StringUtils.isNotEmpty(element.getNamespace().getPrefix())) {
68 out.write(element.getNamespace().getPrefix());
69 out.write(":");
70 }
71 final String name = decode(element.getName());
72 out.write(name);
73 out.write(": ");
74 if (attributes != null) {
75 printAttributes(out, attributes, element, null); //don't pass namespaces
76 }
77 newline(out);
78 for (Object childElement : element.getChildren()) {
79 printElement(out, (Element) childElement, level + 1, namespaces);
80 }
81 }
82
83 @Override
84 protected void printName(Writer out, Attribute a) throws IOException {
85 out.write(decode(a.getName()));
86 }
87
88 @Override
89 public String escapeAttributeEntities(String str) {
90 return str;
91 }
92
93 private String decode(String input) {
94 return ISO9075.decode(input); //XML names cannot begin e.g. the character "0", but it's not a problem in YAML
95 }
96 }