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.OrderedLeafSetNode;
36 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
37 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
38 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
39 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
40 import org.slf4j.Logger;
41 import org.slf4j.LoggerFactory;
44 * This is an experimental iterator over a {@link NormalizedNode}. This is essentially
45 * the opposite of a {@link XMLStreamReader} -- unlike instantiating an iterator over
46 * the backing data, this encapsulates a {@link NormalizedNodeStreamWriter} and allows
47 * us to write multiple nodes.
50 public class NormalizedNodeWriter implements Closeable, Flushable {
51 private final NormalizedNodeStreamWriter writer;
53 protected NormalizedNodeWriter(final NormalizedNodeStreamWriter writer) {
54 this.writer = Preconditions.checkNotNull(writer);
57 protected final NormalizedNodeStreamWriter getWriter() {
62 * Create a new writer backed by a {@link NormalizedNodeStreamWriter}.
64 * @param writer Back-end writer
65 * @return A new instance.
67 public static NormalizedNodeWriter forStreamWriter(final NormalizedNodeStreamWriter writer) {
68 return forStreamWriter(writer, true);
72 * Create a new writer backed by a {@link NormalizedNodeStreamWriter}. Unlike the simple {@link #forStreamWriter(NormalizedNodeStreamWriter)}
73 * method, this allows the caller to switch off RFC6020 XML compliance, providing better
74 * throughput. The reason is that the XML mapping rules in RFC6020 require the encoding
75 * to emit leaf nodes which participate in a list's key first and in the order in which
76 * they are defined in the key. For JSON, this requirement is completely relaxed and leaves
77 * can be ordered in any way we see fit. The former requires a bit of work: first a lookup
78 * for each key and then for each emitted node we need to check whether it was already
81 * @param writer Back-end writer
82 * @param orderKeyLeaves whether the returned instance should be RFC6020 XML compliant.
83 * @return A new instance.
85 public static NormalizedNodeWriter forStreamWriter(final NormalizedNodeStreamWriter writer, final boolean orderKeyLeaves) {
87 return new OrderedNormalizedNodeWriter(writer);
89 return new NormalizedNodeWriter(writer);
94 * Iterate over the provided {@link NormalizedNode} and emit write
95 * events to the encapsulated {@link NormalizedNodeStreamWriter}.
98 * @return NormalizedNodeWriter this
99 * @throws IOException when thrown from the backing writer.
101 public NormalizedNodeWriter write(final NormalizedNode<?, ?> node) throws IOException {
102 if (wasProcessedAsCompositeNode(node)) {
106 if (wasProcessAsSimpleNode(node)) {
110 throw new IllegalStateException("It wasn't possible to serialize node " + node);
114 public void flush() throws IOException {
119 public void close() throws IOException {
125 * Emit a best guess of a hint for a particular set of children. It evaluates the
126 * iterable to see if the size can be easily gotten to. If it is, we hint at the
127 * real number of child nodes. Otherwise we emit UNKNOWN_SIZE.
129 * @param children Child nodes
130 * @return Best estimate of the collection size required to hold all the children.
132 protected static int childSizeHint(final Iterable<?> children) {
133 return (children instanceof Collection) ? ((Collection<?>) children).size() : UNKNOWN_SIZE;
136 protected boolean wasProcessAsSimpleNode(final NormalizedNode<?, ?> node) throws IOException {
137 if (node instanceof LeafSetEntryNode) {
138 final LeafSetEntryNode<?> nodeAsLeafList = (LeafSetEntryNode<?>)node;
139 final QName name = nodeAsLeafList.getIdentifier().getNodeType();
140 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
141 ((NormalizedNodeStreamAttributeWriter) writer).leafSetEntryNode(name, nodeAsLeafList.getValue(),
142 nodeAsLeafList.getAttributes());
144 writer.leafSetEntryNode(name, nodeAsLeafList.getValue());
147 } else if (node instanceof LeafNode) {
148 final LeafNode<?> nodeAsLeaf = (LeafNode<?>)node;
149 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
150 ((NormalizedNodeStreamAttributeWriter) writer).leafNode(nodeAsLeaf.getIdentifier(), nodeAsLeaf.getValue(), nodeAsLeaf.getAttributes());
152 writer.leafNode(nodeAsLeaf.getIdentifier(), nodeAsLeaf.getValue());
155 } else if (node instanceof AnyXmlNode) {
156 final AnyXmlNode anyXmlNode = (AnyXmlNode)node;
157 writer.anyxmlNode(anyXmlNode.getIdentifier(), anyXmlNode.getValue());
165 * Emit events for all children and then emit an endNode() event.
167 * @param children Child iterable
169 * @throws IOException when the writer reports it
171 protected boolean writeChildren(final Iterable<? extends NormalizedNode<?, ?>> children) throws IOException {
172 for (final NormalizedNode<?, ?> child : children) {
180 protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
181 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
182 ((NormalizedNodeStreamAttributeWriter) writer)
183 .startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()), node.getAttributes());
185 writer.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
187 return writeChildren(node.getValue());
190 protected boolean wasProcessedAsCompositeNode(final NormalizedNode<?, ?> node) throws IOException {
191 if (node instanceof ContainerNode) {
192 final ContainerNode n = (ContainerNode) node;
193 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
194 ((NormalizedNodeStreamAttributeWriter) writer).startContainerNode(n.getIdentifier(), childSizeHint(n.getValue()), n.getAttributes());
196 writer.startContainerNode(n.getIdentifier(), childSizeHint(n.getValue()));
198 return writeChildren(n.getValue());
200 if (node instanceof YangModeledAnyXmlNode) {
201 final YangModeledAnyXmlNode n = (YangModeledAnyXmlNode) node;
202 if (writer instanceof NormalizedNodeStreamAttributeWriter) {
203 ((NormalizedNodeStreamAttributeWriter) writer).startYangModeledAnyXmlNode(n.getIdentifier(), childSizeHint(n.getValue()), n.getAttributes());
205 writer.startYangModeledAnyXmlNode(n.getIdentifier(), childSizeHint(n.getValue()));
207 return writeChildren(n.getValue());
209 if (node instanceof MapEntryNode) {
210 return writeMapEntryNode((MapEntryNode) node);
212 if (node instanceof UnkeyedListEntryNode) {
213 final UnkeyedListEntryNode n = (UnkeyedListEntryNode) node;
214 writer.startUnkeyedListItem(n.getIdentifier(), childSizeHint(n.getValue()));
215 return writeChildren(n.getValue());
217 if (node instanceof ChoiceNode) {
218 final ChoiceNode n = (ChoiceNode) node;
219 writer.startChoiceNode(n.getIdentifier(), childSizeHint(n.getValue()));
220 return writeChildren(n.getValue());
222 if (node instanceof AugmentationNode) {
223 final AugmentationNode n = (AugmentationNode) node;
224 writer.startAugmentationNode(n.getIdentifier());
225 return writeChildren(n.getValue());
227 if (node instanceof UnkeyedListNode) {
228 final UnkeyedListNode n = (UnkeyedListNode) node;
229 writer.startUnkeyedList(n.getIdentifier(), childSizeHint(n.getValue()));
230 return writeChildren(n.getValue());
232 if (node instanceof OrderedMapNode) {
233 final OrderedMapNode n = (OrderedMapNode) node;
234 writer.startOrderedMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
235 return writeChildren(n.getValue());
237 if (node instanceof MapNode) {
238 final MapNode n = (MapNode) node;
239 writer.startMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
240 return writeChildren(n.getValue());
242 if (node instanceof OrderedLeafSetNode) {
243 final LeafSetNode<?> n = (LeafSetNode<?>) node;
244 writer.startOrderedLeafSet(n.getIdentifier(), childSizeHint(n.getValue()));
245 return writeChildren(n.getValue());
247 if (node instanceof LeafSetNode) {
248 final LeafSetNode<?> n = (LeafSetNode<?>) node;
249 writer.startLeafSet(n.getIdentifier(), childSizeHint(n.getValue()));
250 return writeChildren(n.getValue());
256 private static final class OrderedNormalizedNodeWriter extends NormalizedNodeWriter {
257 private static final Logger LOG = LoggerFactory.getLogger(OrderedNormalizedNodeWriter.class);
259 OrderedNormalizedNodeWriter(final NormalizedNodeStreamWriter writer) {
264 protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
265 final NormalizedNodeStreamWriter nnWriter = getWriter();
266 if (nnWriter instanceof NormalizedNodeStreamAttributeWriter) {
267 ((NormalizedNodeStreamAttributeWriter) nnWriter).startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()), node.getAttributes());
269 nnWriter.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
272 final Set<QName> qnames = node.getIdentifier().getKeyValues().keySet();
273 // Write out all the key children
274 for (final QName qname : qnames) {
275 final Optional<? extends NormalizedNode<?, ?>> child = node.getChild(new NodeIdentifier(qname));
276 if (child.isPresent()) {
279 LOG.info("No child for key element {} found", qname);
283 // Write all the rest
284 return writeChildren(Iterables.filter(node.getValue(), new Predicate<NormalizedNode<?, ?>>() {
286 public boolean apply(final NormalizedNode<?, ?> input) {
287 if (input instanceof AugmentationNode) {
290 if (!qnames.contains(input.getNodeType())) {
294 LOG.debug("Skipping key child {}", input);