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 org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter.UNKNOWN_SIZE;
12 import com.google.common.annotations.Beta;
13 import com.google.common.base.Optional;
14 import com.google.common.base.Preconditions;
15 import com.google.common.base.Predicate;
16 import com.google.common.collect.Iterables;
17 import java.io.Closeable;
18 import java.io.Flushable;
19 import java.io.IOException;
20 import java.util.Collection;
22 import javax.xml.stream.XMLStreamReader;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
25 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
26 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
27 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
28 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
29 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
30 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
31 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
32 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
33 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
34 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
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 private NormalizedNodeWriter(final NormalizedNodeStreamWriter writer) {
53 this.writer = Preconditions.checkNotNull(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 {@link #forStreamWriter(NormalizedNodeStreamWriter)}
72 * method, this allows the caller to switch off RFC6020 XML compliance, providing better
73 * throughput. The reason is that the XML mapping rules in RFC6020 require the encoding
74 * to emit leaf nodes which participate in a list's key first and in the order in which
75 * they are defined in the key. For JSON, this requirement is completely relaxed and leaves
76 * can be ordered in any way we see fit. The former requires a bit of work: first a lookup
77 * for each key and then for each emitted node we need to check whether it was already
80 * @param writer Back-end writer
81 * @param orderKeyLeaves whether the returned instance should be RFC6020 XML compliant.
82 * @return A new instance.
84 public static NormalizedNodeWriter forStreamWriter(final NormalizedNodeStreamWriter writer, final boolean orderKeyLeaves) {
86 return new OrderedNormalizedNodeWriter(writer);
88 return new NormalizedNodeWriter(writer);
93 * Iterate over the provided {@link NormalizedNode} and emit write
94 * events to the encapsulated {@link NormalizedNodeStreamWriter}.
97 * @return NormalizedNodeWriter this
98 * @throws IOException when thrown from the backing writer.
100 public final NormalizedNodeWriter write(final NormalizedNode<?, ?> node) throws IOException {
101 if (wasProcessedAsCompositeNode(node)) {
105 if (wasProcessAsSimpleNode(node)) {
109 throw new IllegalStateException("It wasn't possible to serialize node " + node);
113 public void flush() throws IOException {
118 public void close() throws IOException {
124 * Emit a best guess of a hint for a particular set of children. It evaluates the
125 * iterable to see if the size can be easily gotten to. If it is, we hint at the
126 * real number of child nodes. Otherwise we emit UNKNOWN_SIZE.
128 * @param children Child nodes
129 * @return Best estimate of the collection size required to hold all the children.
131 static final int childSizeHint(final Iterable<?> children) {
132 return (children instanceof Collection) ? ((Collection<?>) children).size() : UNKNOWN_SIZE;
135 private boolean wasProcessAsSimpleNode(final NormalizedNode<?, ?> node) throws IOException {
136 if (node instanceof LeafSetEntryNode) {
137 final LeafSetEntryNode<?> nodeAsLeafList = (LeafSetEntryNode<?>)node;
138 if(writer instanceof NormalizedNodeStreamAttributeWriter) {
139 ((NormalizedNodeStreamAttributeWriter) writer).leafSetEntryNode(nodeAsLeafList.getValue(), nodeAsLeafList.getAttributes());
141 writer.leafSetEntryNode(nodeAsLeafList.getValue());
144 } else if (node instanceof LeafNode) {
145 final LeafNode<?> nodeAsLeaf = (LeafNode<?>)node;
146 if(writer instanceof NormalizedNodeStreamAttributeWriter) {
147 ((NormalizedNodeStreamAttributeWriter) writer).leafNode(nodeAsLeaf.getIdentifier(), nodeAsLeaf.getValue(), nodeAsLeaf.getAttributes());
149 writer.leafNode(nodeAsLeaf.getIdentifier(), nodeAsLeaf.getValue());
152 } else if (node instanceof AnyXmlNode) {
153 final AnyXmlNode anyXmlNode = (AnyXmlNode)node;
154 writer.anyxmlNode(anyXmlNode.getIdentifier(), anyXmlNode.getValue());
162 * Emit events for all children and then emit an endNode() event.
164 * @param children Child iterable
166 * @throws IOException when the writer reports it
168 protected final boolean writeChildren(final Iterable<? extends NormalizedNode<?, ?>> children) throws IOException {
169 for (final NormalizedNode<?, ?> child : children) {
177 protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
178 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
179 ((NormalizedNodeStreamAttributeWriter) writer)
180 .startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()), node.getAttributes());
182 writer.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
184 return writeChildren(node.getValue());
187 private boolean wasProcessedAsCompositeNode(final NormalizedNode<?, ?> node) throws IOException {
188 if (node instanceof ContainerNode) {
189 final ContainerNode n = (ContainerNode) node;
190 if(writer instanceof NormalizedNodeStreamAttributeWriter) {
191 ((NormalizedNodeStreamAttributeWriter) writer).startContainerNode(n.getIdentifier(), 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(), childSizeHint(n.getValue()), n.getAttributes());
202 writer.startYangModeledAnyXmlNode(n.getIdentifier(), childSizeHint(n.getValue()));
204 return writeChildren(n.getValue());
206 if (node instanceof MapEntryNode) {
207 return writeMapEntryNode((MapEntryNode) node);
209 if (node instanceof UnkeyedListEntryNode) {
210 final UnkeyedListEntryNode n = (UnkeyedListEntryNode) node;
211 writer.startUnkeyedListItem(n.getIdentifier(), childSizeHint(n.getValue()));
212 return writeChildren(n.getValue());
214 if (node instanceof ChoiceNode) {
215 final ChoiceNode n = (ChoiceNode) node;
216 writer.startChoiceNode(n.getIdentifier(), childSizeHint(n.getValue()));
217 return writeChildren(n.getValue());
219 if (node instanceof AugmentationNode) {
220 final AugmentationNode n = (AugmentationNode) node;
221 writer.startAugmentationNode(n.getIdentifier());
222 return writeChildren(n.getValue());
224 if (node instanceof UnkeyedListNode) {
225 final UnkeyedListNode n = (UnkeyedListNode) node;
226 writer.startUnkeyedList(n.getIdentifier(), childSizeHint(n.getValue()));
227 return writeChildren(n.getValue());
229 if (node instanceof OrderedMapNode) {
230 final OrderedMapNode n = (OrderedMapNode) node;
231 writer.startOrderedMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
232 return writeChildren(n.getValue());
234 if (node instanceof MapNode) {
235 final MapNode n = (MapNode) node;
236 writer.startMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
237 return writeChildren(n.getValue());
239 if (node instanceof LeafSetNode) {
240 //covers also OrderedLeafSetNode for which doesn't exist start* method
241 final LeafSetNode<?> n = (LeafSetNode<?>) node;
242 writer.startLeafSet(n.getIdentifier(), childSizeHint(n.getValue()));
243 return writeChildren(n.getValue());
249 private static final class OrderedNormalizedNodeWriter extends NormalizedNodeWriter {
250 private static final Logger LOG = LoggerFactory.getLogger(OrderedNormalizedNodeWriter.class);
252 OrderedNormalizedNodeWriter(final NormalizedNodeStreamWriter writer) {
257 protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
258 final NormalizedNodeStreamWriter nnWriter = getWriter();
259 if(nnWriter instanceof NormalizedNodeStreamAttributeWriter) {
260 ((NormalizedNodeStreamAttributeWriter) nnWriter).startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()), node.getAttributes());
262 nnWriter.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
265 final Set<QName> qnames = node.getIdentifier().getKeyValues().keySet();
266 // Write out all the key children
267 for (final QName qname : qnames) {
268 final Optional<? extends NormalizedNode<?, ?>> child = node.getChild(new NodeIdentifier(qname));
269 if (child.isPresent()) {
272 LOG.info("No child for key element {} found", qname);
276 // Write all the rest
277 return writeChildren(Iterables.filter(node.getValue(), new Predicate<NormalizedNode<?, ?>>() {
279 public boolean apply(final NormalizedNode<?, ?> input) {
280 if (input instanceof AugmentationNode) {
283 if (!qnames.contains(input.getNodeType())) {
287 LOG.debug("Skipping key child {}", input);