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