yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/ImmutableNormalizedNodeStreamWriter.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.impl.schema;
   9
  10 import com.google.common.base.Preconditions;
  11 import java.util.ArrayDeque;
  12 import java.util.Collection;
  13 import java.util.Deque;
  14 import javax.xml.transform.dom.DOMSource;
  15 import org.opendaylight.yangtools.yang.common.QName;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  20 import org.opendaylight.yangtools.yang.data.api.schema.AnyXmlNode;
  21 import org.opendaylight.yangtools.yang.data.api.schema.ChoiceNode;
  22 import org.opendaylight.yangtools.yang.data.api.schema.ContainerNode;
  23 import org.opendaylight.yangtools.yang.data.api.schema.LeafNode;
  24 import org.opendaylight.yangtools.yang.data.api.schema.LeafSetEntryNode;
  25 import org.opendaylight.yangtools.yang.data.api.schema.MapEntryNode;
  26 import org.opendaylight.yangtools.yang.data.api.schema.MapNode;
  27 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  28 import org.opendaylight.yangtools.yang.data.api.schema.OrderedMapNode;
  29 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListEntryNode;
  30 import org.opendaylight.yangtools.yang.data.api.schema.UnkeyedListNode;
  31 import org.opendaylight.yangtools.yang.data.api.schema.YangModeledAnyXmlNode;
  32 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  33 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.CollectionNodeBuilder;
  34 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeAttrBuilder;
  35 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.DataContainerNodeBuilder;
  36 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.ListNodeBuilder;
  37 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeBuilder;
  38 import org.opendaylight.yangtools.yang.data.impl.schema.builder.api.NormalizedNodeContainerBuilder;
  39 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAnyXmlNodeBuilder;
  40 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableAugmentationNodeBuilder;
  41 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableChoiceNodeBuilder;
  42 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  43 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableLeafSetNodeBuilder;
  44 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapEntryNodeBuilder;
  45 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableMapNodeBuilder;
  46 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedLeafSetNodeBuilder;
  47 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableOrderedMapNodeBuilder;
  48 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListEntryNodeBuilder;
  49 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableUnkeyedListNodeBuilder;
  50 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableYangModeledAnyXmlNodeBuilder;
  51 import org.opendaylight.yangtools.yang.data.util.LeafInterner;
  52 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  53 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  54 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
  55
  56 /**
  57  *
  58  * Implementation of {@link NormalizedNodeStreamWriter}, which constructs
  59  * immutable instances of {@link NormalizedNode}s.
  60  * <p>
  61  * This writer supports two modes of behaviour one is using {@link #from(NormalizedNodeResult)}
  62  * where resulting NormalizedNode will be stored in supplied result object.
  63  *
  64  * Other mode of operation is using {@link #from(NormalizedNodeContainerBuilder)},
  65  * where all created nodes will be written to this builder.
  66  *
  67  *
  68  */
  69 public class ImmutableNormalizedNodeStreamWriter implements NormalizedNodeStreamWriter {
  70
  71     @SuppressWarnings("rawtypes")
  72     private final Deque<NormalizedNodeContainerBuilder> builders = new ArrayDeque<>();
  73     private DataSchemaNode nextSchema;
  74
  75     @SuppressWarnings("rawtypes")
  76     protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeContainerBuilder topLevelBuilder) {
  77         builders.push(topLevelBuilder);
  78     }
  79
  80     protected ImmutableNormalizedNodeStreamWriter(final NormalizedNodeResult result) {
  81         this(new NormalizedNodeResultBuilder(result));
  82     }
  83
  84     /**
  85      * Creates a {@link NormalizedNodeStreamWriter} which creates instances of supplied
  86      * {@link NormalizedNode}s and writes them to supplied builder as child nodes.
  87      * <p>
  88      * Type of supplied {@link NormalizedNodeContainerBuilder} affects,
  89      * which events could be emitted in order to ensure proper construction of
  90      * data.
  91      *
  92      * @param builder Builder to which data will be written.
  93      * @return {@link NormalizedNodeStreamWriter} which writes data
  94      */
  95     public static NormalizedNodeStreamWriter from(final NormalizedNodeContainerBuilder<?, ?, ?, ?> builder) {
  96         return new ImmutableNormalizedNodeStreamWriter(builder);
  97     }
  98
  99     /**
 100      * Creates a {@link NormalizedNodeStreamWriter} which creates one instance of top
 101      * level {@link NormalizedNode} (type of NormalizedNode) is determined by first
 102      * start event.
 103      * <p>
 104      * Result is built when {@link #endNode()} associated with that start event
 105      * is emitted.
 106      * <p>
 107      * Writer properly creates also nested {@link NormalizedNode} instances,
 108      * if their are supported inside the scope of first event.
 109      * <p>
 110      * This method is useful for clients, which knows there will be one
 111      * top level node written, but does not know which type of {@link NormalizedNode}
 112      * will be written.
 113      *
 114      * @param result {@link NormalizedNodeResult} object which will hold result value.
 115      * @return {@link NormalizedNodeStreamWriter} which will write item to supplied result holder.
 116      */
 117     public static NormalizedNodeStreamWriter from(final NormalizedNodeResult result) {
 118         return new ImmutableNormalizedNodeStreamWriter(result);
 119     }
 120
 121     @SuppressWarnings("rawtypes")
 122     private NormalizedNodeContainerBuilder getCurrent() {
 123         return builders.peek();
 124     }
 125
 126     @SuppressWarnings("rawtypes")
 127     private void enter(final NormalizedNodeContainerBuilder next) {
 128         builders.push(next);
 129         nextSchema = null;
 130     }
 131
 132     @SuppressWarnings("unchecked")
 133     protected void writeChild(final NormalizedNode<?, ?> child) {
 134         getCurrent().addChild(child);
 135     }
 136
 137     @Override
 138     @SuppressWarnings({"rawtypes","unchecked"})
 139     public void endNode() {
 140         final NormalizedNodeContainerBuilder finishedBuilder = builders.poll();
 141         Preconditions.checkState(finishedBuilder != null, "Node which should be closed does not exists.");
 142         final NormalizedNodeContainerBuilder current = getCurrent();
 143         Preconditions.checkState(current != null, "Reached top level node, which could not be closed in this writer.");
 144         final NormalizedNode<PathArgument, ?> product = finishedBuilder.build();
 145         current.addChild(product);
 146         nextSchema = null;
 147     }
 148
 149     @Override
 150     public void leafNode(final NodeIdentifier name, final Object value) {
 151         checkDataNodeContainer();
 152
 153         final LeafNode<Object> sample = ImmutableNodes.leafNode(name, value);
 154         final LeafNode<?> node;
 155         if (nextSchema instanceof LeafSchemaNode) {
 156             node = LeafInterner.forSchema((LeafSchemaNode)nextSchema).intern(sample);
 157         } else {
 158             node = sample;
 159         }
 160
 161         writeChild(node);
 162         nextSchema = null;
 163     }
 164
 165     @Override
 166     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
 167         checkDataNodeContainer();
 168         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = UNKNOWN_SIZE == childSizeHint ?
 169                 InterningLeafSetNodeBuilder.create(nextSchema) :
 170                     InterningLeafSetNodeBuilder.create(nextSchema, childSizeHint);
 171         builder.withNodeIdentifier(name);
 172         enter(builder);
 173     }
 174
 175     @Override
 176     public void leafSetEntryNode(final QName name, final Object value) {
 177         if (getCurrent() instanceof ImmutableOrderedLeafSetNodeBuilder) {
 178             @SuppressWarnings("unchecked")
 179             ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = ((ImmutableOrderedLeafSetNodeBuilder<Object>) getCurrent());
 180             builder.withChildValue(value);
 181         } else if (getCurrent() instanceof ImmutableLeafSetNodeBuilder) {
 182             @SuppressWarnings("unchecked")
 183             ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = ((ImmutableLeafSetNodeBuilder<Object>) getCurrent());
 184             builder.withChildValue(value);
 185         } else {
 186             throw new IllegalArgumentException("LeafSetEntryNode is not valid for parent " + getCurrent());
 187         }
 188
 189         nextSchema = null;
 190     }
 191
 192     @Override
 193     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
 194         checkDataNodeContainer();
 195         final ListNodeBuilder<Object, LeafSetEntryNode<Object>> builder = Builders.orderedLeafSetBuilder();
 196         builder.withNodeIdentifier(name);
 197         enter(builder);
 198     }
 199
 200     @Override
 201     public void anyxmlNode(final NodeIdentifier name, final Object value) {
 202         checkDataNodeContainer();
 203
 204         final AnyXmlNode node = ImmutableAnyXmlNodeBuilder.create().withNodeIdentifier(name)
 205                 .withValue((DOMSource) value).build();
 206         writeChild(node);
 207
 208         nextSchema = null;
 209     }
 210
 211     @Override
 212     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) {
 213         checkDataNodeContainer();
 214
 215         final DataContainerNodeAttrBuilder<NodeIdentifier, ContainerNode> builder = UNKNOWN_SIZE == childSizeHint ?
 216                 ImmutableContainerNodeBuilder.create() : ImmutableContainerNodeBuilder.create(childSizeHint);
 217         enter(builder.withNodeIdentifier(name));
 218     }
 219
 220     @Override
 221     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) {
 222         checkDataNodeContainer();
 223
 224         Preconditions.checkArgument(nextSchema instanceof YangModeledAnyXmlSchemaNode,
 225                 "Schema of this node should be instance of YangModeledAnyXmlSchemaNode");
 226         final DataContainerNodeAttrBuilder<NodeIdentifier, YangModeledAnyXmlNode> builder = UNKNOWN_SIZE == childSizeHint ? ImmutableYangModeledAnyXmlNodeBuilder
 227                 .create((YangModeledAnyXmlSchemaNode) nextSchema) : ImmutableYangModeledAnyXmlNodeBuilder.create(
 228                 (YangModeledAnyXmlSchemaNode) nextSchema, childSizeHint);
 229         enter(builder.withNodeIdentifier(name));
 230     }
 231
 232     @Override
 233     public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) {
 234         checkDataNodeContainer();
 235
 236         final CollectionNodeBuilder<UnkeyedListEntryNode, UnkeyedListNode> builder = UNKNOWN_SIZE == childSizeHint ?
 237                 ImmutableUnkeyedListNodeBuilder.create() : ImmutableUnkeyedListNodeBuilder.create(childSizeHint);
 238         enter(builder.withNodeIdentifier(name));
 239     }
 240
 241     @Override
 242     public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) {
 243         Preconditions.checkArgument((getCurrent() instanceof NormalizedNodeResultBuilder)
 244                 || getCurrent() instanceof ImmutableUnkeyedListNodeBuilder);
 245         final DataContainerNodeAttrBuilder<NodeIdentifier, UnkeyedListEntryNode> builder = UNKNOWN_SIZE == childSizeHint ?
 246                 ImmutableUnkeyedListEntryNodeBuilder.create() : ImmutableUnkeyedListEntryNodeBuilder.create(childSizeHint);
 247         enter(builder.withNodeIdentifier(name));
 248     }
 249
 250     @Override
 251     public void startMapNode(final NodeIdentifier name, final int childSizeHint) {
 252         checkDataNodeContainer();
 253
 254         final CollectionNodeBuilder<MapEntryNode, MapNode> builder = UNKNOWN_SIZE == childSizeHint ?
 255                 ImmutableMapNodeBuilder.create() : ImmutableMapNodeBuilder.create(childSizeHint);
 256         enter(builder.withNodeIdentifier(name));
 257     }
 258
 259     @Override
 260     public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint) {
 261         if (!(getCurrent() instanceof NormalizedNodeResultBuilder)) {
 262             Preconditions.checkArgument(getCurrent() instanceof ImmutableMapNodeBuilder || getCurrent() instanceof ImmutableOrderedMapNodeBuilder);
 263         }
 264
 265         final DataContainerNodeAttrBuilder<NodeIdentifierWithPredicates, MapEntryNode> builder = UNKNOWN_SIZE == childSizeHint ?
 266                 ImmutableMapEntryNodeBuilder.create() : ImmutableMapEntryNodeBuilder.create(childSizeHint);
 267         enter(builder.withNodeIdentifier(identifier));
 268     }
 269
 270     @Override
 271     public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) {
 272         checkDataNodeContainer();
 273
 274         final CollectionNodeBuilder<MapEntryNode, OrderedMapNode> builder = UNKNOWN_SIZE == childSizeHint ?
 275                 ImmutableOrderedMapNodeBuilder.create() : ImmutableOrderedMapNodeBuilder.create(childSizeHint);
 276         enter(builder.withNodeIdentifier(name));
 277     }
 278
 279     @Override
 280     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 281         checkDataNodeContainer();
 282
 283         final DataContainerNodeBuilder<NodeIdentifier, ChoiceNode> builder = UNKNOWN_SIZE == childSizeHint ?
 284                 ImmutableChoiceNodeBuilder.create() : ImmutableChoiceNodeBuilder.create(childSizeHint);
 285         enter(builder.withNodeIdentifier(name));
 286     }
 287
 288     @Override
 289     public void startAugmentationNode(final AugmentationIdentifier identifier) {
 290         checkDataNodeContainer();
 291         Preconditions.checkArgument(!(getCurrent() instanceof ImmutableAugmentationNodeBuilder));
 292         enter(Builders.augmentationBuilder().withNodeIdentifier(identifier));
 293     }
 294
 295     private void checkDataNodeContainer() {
 296         @SuppressWarnings("rawtypes")
 297         final
 298         NormalizedNodeContainerBuilder current = getCurrent();
 299         if (!(current instanceof NormalizedNodeResultBuilder)) {
 300             Preconditions.checkArgument(current instanceof DataContainerNodeBuilder<?, ?>, "Invalid nesting of data.");
 301         }
 302     }
 303
 304     @SuppressWarnings("rawtypes")
 305     private static final class NormalizedNodeResultBuilder implements NormalizedNodeContainerBuilder {
 306
 307         private final NormalizedNodeResult result;
 308
 309         public NormalizedNodeResultBuilder(final NormalizedNodeResult result) {
 310             this.result = result;
 311         }
 312
 313         @Override
 314         public NormalizedNodeBuilder withValue(final Object value) {
 315             throw new UnsupportedOperationException();
 316         }
 317
 318         @Override
 319         public NormalizedNode build() {
 320             throw new IllegalStateException("Can not close NormalizedNodeResult");
 321         }
 322
 323         @Override
 324         public NormalizedNodeContainerBuilder withNodeIdentifier(final PathArgument nodeIdentifier) {
 325             throw new UnsupportedOperationException();
 326         }
 327
 328         @Override
 329         public NormalizedNodeContainerBuilder withValue(final Collection value) {
 330             throw new UnsupportedOperationException();
 331         }
 332
 333         @Override
 334         public NormalizedNodeContainerBuilder addChild(final NormalizedNode child) {
 335             result.setResult(child);
 336             return this;
 337         }
 338
 339         @Override
 340         public NormalizedNodeContainerBuilder removeChild(final PathArgument key) {
 341             throw new UnsupportedOperationException();
 342         }
 343
 344     }
 345
 346     @Override
 347     public void flush() {
 348         // no-op
 349     }
 350
 351     @Override
 352     public void close() {
 353         // no-op
 354     }
 355
 356     @Override
 357     public void nextDataSchemaNode(final DataSchemaNode schema) {
 358         nextSchema = Preconditions.checkNotNull(schema);
 359     }
 360 }