2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
4 * This program and the accompanying materials are made available under the
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
8 package org.opendaylight.yangtools.yang.data.api.schema.stream;
10 import static java.util.Objects.requireNonNull;
11 import static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter.UNKNOWN_SIZE;
13 import com.google.common.annotations.Beta;
14 import com.google.common.collect.Iterables;
15 import java.io.Closeable;
16 import java.io.Flushable;
17 import java.io.IOException;
18 import java.util.Collection;
19 import java.util.Optional;
21 import javax.xml.stream.XMLStreamReader;
22 import org.opendaylight.yangtools.yang.common.QName;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
24 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
25 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.OrderedLeafSetNode;
35 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
39 import org.slf4j.Logger;
40 import org.slf4j.LoggerFactory;
43 * This is an experimental iterator over a {@link NormalizedNode}. This is essentially
44 * the opposite of a {@link XMLStreamReader} -- unlike instantiating an iterator over
45 * the backing data, this encapsulates a {@link NormalizedNodeStreamWriter} and allows
46 * us to write multiple nodes.
49 public class NormalizedNodeWriter implements Closeable, Flushable {
50 private final NormalizedNodeStreamWriter writer;
52 protected NormalizedNodeWriter(final NormalizedNodeStreamWriter writer) {
53 this.writer = requireNonNull(writer);
56 protected final NormalizedNodeStreamWriter getWriter() {
61 * Create a new writer backed by a {@link NormalizedNodeStreamWriter}.
63 * @param writer Back-end writer
64 * @return A new instance.
66 public static NormalizedNodeWriter forStreamWriter(final NormalizedNodeStreamWriter writer) {
67 return forStreamWriter(writer, true);
71 * Create a new writer backed by a {@link NormalizedNodeStreamWriter}. Unlike the simple
72 * {@link #forStreamWriter(NormalizedNodeStreamWriter)} method, this allows the caller to switch off RFC6020 XML
73 * compliance, providing better throughput. The reason is that the XML mapping rules in RFC6020 require
74 * the encoding to emit leaf nodes which participate in a list's key first and in the order in which they are
75 * defined in the key. For JSON, this requirement is completely relaxed and leaves can be ordered in any way we
76 * see fit. The former requires a bit of work: first a lookup for each key and then for each emitted node we need
77 * to check whether it was already emitted.
79 * @param writer Back-end writer
80 * @param orderKeyLeaves whether the returned instance should be RFC6020 XML compliant.
81 * @return A new instance.
83 public static NormalizedNodeWriter forStreamWriter(final NormalizedNodeStreamWriter writer,
84 final boolean orderKeyLeaves) {
85 return orderKeyLeaves ? new OrderedNormalizedNodeWriter(writer) : new NormalizedNodeWriter(writer);
89 * Iterate over the provided {@link NormalizedNode} and emit write
90 * events to the encapsulated {@link NormalizedNodeStreamWriter}.
93 * @return NormalizedNodeWriter this
94 * @throws IOException when thrown from the backing writer.
96 public NormalizedNodeWriter write(final NormalizedNode<?, ?> node) throws IOException {
97 if (wasProcessedAsCompositeNode(node)) {
101 if (wasProcessAsSimpleNode(node)) {
105 throw new IllegalStateException("It wasn't possible to serialize node " + node);
109 public void flush() throws IOException {
114 public void close() throws IOException {
120 * Emit a best guess of a hint for a particular set of children. It evaluates the
121 * iterable to see if the size can be easily gotten to. If it is, we hint at the
122 * real number of child nodes. Otherwise we emit UNKNOWN_SIZE.
124 * @param children Child nodes
125 * @return Best estimate of the collection size required to hold all the children.
127 protected static int childSizeHint(final Iterable<?> children) {
128 return children instanceof Collection ? ((Collection<?>) children).size() : UNKNOWN_SIZE;
131 protected boolean wasProcessAsSimpleNode(final NormalizedNode<?, ?> node) throws IOException {
132 if (node instanceof LeafSetEntryNode) {
133 final LeafSetEntryNode<?> nodeAsLeafList = (LeafSetEntryNode<?>)node;
134 final QName name = nodeAsLeafList.getIdentifier().getNodeType();
135 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
136 ((NormalizedNodeStreamAttributeWriter) writer).leafSetEntryNode(name, nodeAsLeafList.getValue(),
137 nodeAsLeafList.getAttributes());
139 writer.leafSetEntryNode(name, nodeAsLeafList.getValue());
142 } else if (node instanceof LeafNode) {
143 final LeafNode<?> nodeAsLeaf = (LeafNode<?>)node;
144 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
145 ((NormalizedNodeStreamAttributeWriter) writer).leafNode(nodeAsLeaf.getIdentifier(),
146 nodeAsLeaf.getValue(), nodeAsLeaf.getAttributes());
148 writer.leafNode(nodeAsLeaf.getIdentifier(), nodeAsLeaf.getValue());
151 } else if (node instanceof AnyXmlNode) {
152 final AnyXmlNode anyXmlNode = (AnyXmlNode)node;
153 writer.anyxmlNode(anyXmlNode.getIdentifier(), anyXmlNode.getValue());
161 * Emit events for all children and then emit an endNode() event.
163 * @param children Child iterable
165 * @throws IOException when the writer reports it
167 protected boolean writeChildren(final Iterable<? extends NormalizedNode<?, ?>> children) throws IOException {
168 for (final NormalizedNode<?, ?> child : children) {
176 protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
177 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
178 ((NormalizedNodeStreamAttributeWriter) writer)
179 .startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()), node.getAttributes());
181 writer.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
183 return writeChildren(node.getValue());
186 protected boolean wasProcessedAsCompositeNode(final NormalizedNode<?, ?> node) throws IOException {
187 if (node instanceof ContainerNode) {
188 final ContainerNode n = (ContainerNode) node;
189 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
190 ((NormalizedNodeStreamAttributeWriter) writer).startContainerNode(n.getIdentifier(),
191 childSizeHint(n.getValue()), n.getAttributes());
193 writer.startContainerNode(n.getIdentifier(), childSizeHint(n.getValue()));
195 return writeChildren(n.getValue());
197 if (node instanceof YangModeledAnyXmlNode) {
198 final YangModeledAnyXmlNode n = (YangModeledAnyXmlNode) node;
199 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
200 ((NormalizedNodeStreamAttributeWriter) writer).startYangModeledAnyXmlNode(n.getIdentifier(),
201 childSizeHint(n.getValue()), n.getAttributes());
203 writer.startYangModeledAnyXmlNode(n.getIdentifier(), childSizeHint(n.getValue()));
205 return writeChildren(n.getValue());
207 if (node instanceof MapEntryNode) {
208 return writeMapEntryNode((MapEntryNode) node);
210 if (node instanceof UnkeyedListEntryNode) {
211 final UnkeyedListEntryNode n = (UnkeyedListEntryNode) node;
212 writer.startUnkeyedListItem(n.getIdentifier(), childSizeHint(n.getValue()));
213 return writeChildren(n.getValue());
215 if (node instanceof ChoiceNode) {
216 final ChoiceNode n = (ChoiceNode) node;
217 writer.startChoiceNode(n.getIdentifier(), childSizeHint(n.getValue()));
218 return writeChildren(n.getValue());
220 if (node instanceof AugmentationNode) {
221 final AugmentationNode n = (AugmentationNode) node;
222 writer.startAugmentationNode(n.getIdentifier());
223 return writeChildren(n.getValue());
225 if (node instanceof UnkeyedListNode) {
226 final UnkeyedListNode n = (UnkeyedListNode) node;
227 writer.startUnkeyedList(n.getIdentifier(), childSizeHint(n.getValue()));
228 return writeChildren(n.getValue());
230 if (node instanceof OrderedMapNode) {
231 final OrderedMapNode n = (OrderedMapNode) node;
232 writer.startOrderedMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
233 return writeChildren(n.getValue());
235 if (node instanceof MapNode) {
236 final MapNode n = (MapNode) node;
237 writer.startMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
238 return writeChildren(n.getValue());
240 if (node instanceof OrderedLeafSetNode) {
241 final LeafSetNode<?> n = (LeafSetNode<?>) node;
242 writer.startOrderedLeafSet(n.getIdentifier(), childSizeHint(n.getValue()));
243 return writeChildren(n.getValue());
245 if (node instanceof LeafSetNode) {
246 final LeafSetNode<?> n = (LeafSetNode<?>) node;
247 writer.startLeafSet(n.getIdentifier(), childSizeHint(n.getValue()));
248 return writeChildren(n.getValue());
254 private static final class OrderedNormalizedNodeWriter extends NormalizedNodeWriter {
255 private static final Logger LOG = LoggerFactory.getLogger(OrderedNormalizedNodeWriter.class);
257 OrderedNormalizedNodeWriter(final NormalizedNodeStreamWriter writer) {
262 protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
263 final NormalizedNodeStreamWriter nnWriter = getWriter();
264 if (nnWriter instanceof NormalizedNodeStreamAttributeWriter) {
265 ((NormalizedNodeStreamAttributeWriter) nnWriter).startMapEntryNode(node.getIdentifier(),
266 childSizeHint(node.getValue()), node.getAttributes());
268 nnWriter.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
271 final Set<QName> qnames = node.getIdentifier().getKeyValues().keySet();
272 // Write out all the key children
273 for (final QName qname : qnames) {
274 final Optional<? extends NormalizedNode<?, ?>> child = node.getChild(new NodeIdentifier(qname));
275 if (child.isPresent()) {
278 LOG.info("No child for key element {} found", qname);
282 // Write all the rest
283 return writeChildren(Iterables.filter(node.getValue(), input -> {
284 if (input instanceof AugmentationNode) {
287 if (!qnames.contains(input.getNodeType())) {
291 LOG.debug("Skipping key child {}", input);