yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/stream/NormalizedNodeWriter.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   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
   7  */
   8 package org.opendaylight.yangtools.yang.data.api.schema.stream;
   9
  10 import static java.util.Objects.requireNonNull;
  11 import static org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter.UNKNOWN_SIZE;
  12
  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;
  20 import java.util.Set;
  21 import javax.xml.stream.XMLStreamReader;
  22 import org.eclipse.jdt.annotation.NonNull;
  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.AnydataNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.AugmentationNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetNode;
  33 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  34 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  35 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  36 import org.opendaylight.yangtools.yang.data.api.schema.OrderedLeafSetNode;
  37 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  38 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  39 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  40 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
  41 import org.slf4j.Logger;
  42 import org.slf4j.LoggerFactory;
  43
  44 /**
  45  * This is an experimental iterator over a {@link NormalizedNode}. This is essentially
  46  * the opposite of a {@link XMLStreamReader} -- unlike instantiating an iterator over
  47  * the backing data, this encapsulates a {@link NormalizedNodeStreamWriter} and allows
  48  * us to write multiple nodes.
  49  */
  50 @Beta
  51 public class NormalizedNodeWriter implements Closeable, Flushable {
  52     private static final Logger LOG = LoggerFactory.getLogger(NormalizedNodeWriter.class);
  53
  54     private final @NonNull NormalizedNodeStreamWriter writer;
  55
  56     protected NormalizedNodeWriter(final NormalizedNodeStreamWriter writer) {
  57         this.writer = requireNonNull(writer);
  58     }
  59
  60     protected final NormalizedNodeStreamWriter getWriter() {
  61         return writer;
  62     }
  63
  64     /**
  65      * Create a new writer backed by a {@link NormalizedNodeStreamWriter}.
  66      *
  67      * @param writer Back-end writer
  68      * @return A new instance.
  69      */
  70     public static NormalizedNodeWriter forStreamWriter(final NormalizedNodeStreamWriter writer) {
  71         return forStreamWriter(writer, true);
  72     }
  73
  74     /**
  75      * Create a new writer backed by a {@link NormalizedNodeStreamWriter}. Unlike the simple
  76      * {@link #forStreamWriter(NormalizedNodeStreamWriter)} method, this allows the caller to switch off RFC6020 XML
  77      * compliance, providing better throughput. The reason is that the XML mapping rules in RFC6020 require
  78      * the encoding to emit leaf nodes which participate in a list's key first and in the order in which they are
  79      * defined in the key. For JSON, this requirement is completely relaxed and leaves can be ordered in any way we
  80      * see fit. The former requires a bit of work: first a lookup for each key and then for each emitted node we need
  81      * to check whether it was already emitted.
  82      *
  83      * @param writer Back-end writer
  84      * @param orderKeyLeaves whether the returned instance should be RFC6020 XML compliant.
  85      * @return A new instance.
  86      */
  87     public static NormalizedNodeWriter forStreamWriter(final NormalizedNodeStreamWriter writer,
  88             final boolean orderKeyLeaves) {
  89         return orderKeyLeaves ? new OrderedNormalizedNodeWriter(writer) : new NormalizedNodeWriter(writer);
  90     }
  91
  92     /**
  93      * Iterate over the provided {@link NormalizedNode} and emit write
  94      * events to the encapsulated {@link NormalizedNodeStreamWriter}.
  95      *
  96      * @param node Node
  97      * @return NormalizedNodeWriter this
  98      * @throws IOException when thrown from the backing writer.
  99      */
 100     public NormalizedNodeWriter write(final NormalizedNode<?, ?> node) throws IOException {
 101         if (wasProcessedAsCompositeNode(node)) {
 102             return this;
 103         }
 104
 105         if (wasProcessAsSimpleNode(node)) {
 106             return this;
 107         }
 108
 109         throw new IllegalStateException("It wasn't possible to serialize node " + node);
 110     }
 111
 112     @Override
 113     public void flush() throws IOException {
 114         writer.flush();
 115     }
 116
 117     @Override
 118     public void close() throws IOException {
 119         writer.flush();
 120         writer.close();
 121     }
 122
 123     /**
 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.
 127      *
 128      * @param children Child nodes
 129      * @return Best estimate of the collection size required to hold all the children.
 130      */
 131     protected static int childSizeHint(final Iterable<?> children) {
 132         return children instanceof Collection ? ((Collection<?>) children).size() : UNKNOWN_SIZE;
 133     }
 134
 135     protected boolean wasProcessAsSimpleNode(final NormalizedNode<?, ?> node) throws IOException {
 136         if (node instanceof LeafSetEntryNode) {
 137             final LeafSetEntryNode<?> nodeAsLeafList = (LeafSetEntryNode<?>)node;
 138             writer.startLeafSetEntryNode(nodeAsLeafList.getIdentifier());
 139             writer.scalarValue(nodeAsLeafList.getValue());
 140             writer.endNode();
 141             return true;
 142         } else if (node instanceof LeafNode) {
 143             final LeafNode<?> nodeAsLeaf = (LeafNode<?>)node;
 144             writer.startLeafNode(nodeAsLeaf.getIdentifier());
 145             writer.scalarValue(nodeAsLeaf.getValue());
 146             writer.endNode();
 147             return true;
 148         } else if (node instanceof AnyXmlNode) {
 149             final AnyXmlNode anyXmlNode = (AnyXmlNode)node;
 150             writer.startAnyxmlNode(anyXmlNode.getIdentifier());
 151             writer.domSourceValue(anyXmlNode.getValue());
 152             writer.endNode();
 153             return true;
 154         } else if (node instanceof AnydataNode) {
 155             final AnydataExtension ext = writer.getExtensions().getInstance(AnydataExtension.class);
 156             if (ext != null) {
 157                 final AnydataNode<?> anydata = (AnydataNode<?>) node;
 158                 final Class<?> model = anydata.getValueObjectModel();
 159                 if (ext.startAnydataNode(anydata.getIdentifier(), model)) {
 160                     writer.scalarValue(anydata.getValue());
 161                     writer.endNode();
 162                     return true;
 163                 }
 164
 165                 LOG.debug("Writer {} does not support anydata in form of {}", writer, model);
 166             } else {
 167                 LOG.debug("Writer {} does not support anydata", writer);
 168             }
 169         }
 170
 171         return false;
 172     }
 173
 174     /**
 175      * Emit events for all children and then emit an endNode() event.
 176      *
 177      * @param children Child iterable
 178      * @return True
 179      * @throws IOException when the writer reports it
 180      */
 181     protected boolean writeChildren(final Iterable<? extends NormalizedNode<?, ?>> children) throws IOException {
 182         for (final NormalizedNode<?, ?> child : children) {
 183             write(child);
 184         }
 185
 186         writer.endNode();
 187         return true;
 188     }
 189
 190     protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
 191         writer.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
 192         return writeChildren(node.getValue());
 193     }
 194
 195     protected boolean wasProcessedAsCompositeNode(final NormalizedNode<?, ?> node) throws IOException {
 196         if (node instanceof ContainerNode) {
 197             final ContainerNode n = (ContainerNode) node;
 198             writer.startContainerNode(n.getIdentifier(), childSizeHint(n.getValue()));
 199             return writeChildren(n.getValue());
 200         }
 201         if (node instanceof YangModeledAnyXmlNode) {
 202             final YangModeledAnyXmlNode n = (YangModeledAnyXmlNode) node;
 203             writer.startYangModeledAnyXmlNode(n.getIdentifier(), childSizeHint(n.getValue()));
 204             return writeChildren(n.getValue());
 205         }
 206         if (node instanceof MapEntryNode) {
 207             return writeMapEntryNode((MapEntryNode) node);
 208         }
 209         if (node instanceof UnkeyedListEntryNode) {
 210             final UnkeyedListEntryNode n = (UnkeyedListEntryNode) node;
 211             writer.startUnkeyedListItem(n.getIdentifier(), childSizeHint(n.getValue()));
 212             return writeChildren(n.getValue());
 213         }
 214         if (node instanceof ChoiceNode) {
 215             final ChoiceNode n = (ChoiceNode) node;
 216             writer.startChoiceNode(n.getIdentifier(), childSizeHint(n.getValue()));
 217             return writeChildren(n.getValue());
 218         }
 219         if (node instanceof AugmentationNode) {
 220             final AugmentationNode n = (AugmentationNode) node;
 221             writer.startAugmentationNode(n.getIdentifier());
 222             return writeChildren(n.getValue());
 223         }
 224         if (node instanceof UnkeyedListNode) {
 225             final UnkeyedListNode n = (UnkeyedListNode) node;
 226             writer.startUnkeyedList(n.getIdentifier(), childSizeHint(n.getValue()));
 227             return writeChildren(n.getValue());
 228         }
 229         if (node instanceof OrderedMapNode) {
 230             final OrderedMapNode n = (OrderedMapNode) node;
 231             writer.startOrderedMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
 232             return writeChildren(n.getValue());
 233         }
 234         if (node instanceof MapNode) {
 235             final MapNode n = (MapNode) node;
 236             writer.startMapNode(n.getIdentifier(), childSizeHint(n.getValue()));
 237             return writeChildren(n.getValue());
 238         }
 239         if (node instanceof OrderedLeafSetNode) {
 240             final LeafSetNode<?> n = (LeafSetNode<?>) node;
 241             writer.startOrderedLeafSet(n.getIdentifier(), childSizeHint(n.getValue()));
 242             return writeChildren(n.getValue());
 243         }
 244         if (node instanceof LeafSetNode) {
 245             final LeafSetNode<?> n = (LeafSetNode<?>) node;
 246             writer.startLeafSet(n.getIdentifier(), childSizeHint(n.getValue()));
 247             return writeChildren(n.getValue());
 248         }
 249
 250         return false;
 251     }
 252
 253     private static final class OrderedNormalizedNodeWriter extends NormalizedNodeWriter {
 254         private static final Logger LOG = LoggerFactory.getLogger(OrderedNormalizedNodeWriter.class);
 255
 256         OrderedNormalizedNodeWriter(final NormalizedNodeStreamWriter writer) {
 257             super(writer);
 258         }
 259
 260         @Override
 261         protected boolean writeMapEntryNode(final MapEntryNode node) throws IOException {
 262             final NormalizedNodeStreamWriter nnWriter = getWriter();
 263             nnWriter.startMapEntryNode(node.getIdentifier(), childSizeHint(node.getValue()));
 264
 265             final Set<QName> qnames = node.getIdentifier().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()) {
 270                     write(child.get());
 271                 } else {
 272                     LOG.info("No child for key element {} found", qname);
 273                 }
 274             }
 275
 276             // Write all the rest
 277             return writeChildren(Iterables.filter(node.getValue(), input -> {
 278                 if (input instanceof AugmentationNode) {
 279                     return true;
 280                 }
 281                 if (!qnames.contains(input.getNodeType())) {
 282                     return true;
 283                 }
 284
 285                 LOG.debug("Skipping key child {}", input);
 286                 return false;
 287             }));
 288         }
 289     }
 290 }