yang/yang-data-codec-gson/src/main/java/org/opendaylight/yangtools/yang/data/codec/gson/JSONNormalizedNodeStreamWriter.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.codec.gson;
   9
  10 import com.google.common.base.Preconditions;
  11 import com.google.common.base.Strings;
  12 import com.google.gson.stream.JsonWriter;
  13 import java.io.IOException;
  14 import java.io.Writer;
  15 import java.net.URI;
  16 import java.util.ArrayDeque;
  17 import java.util.Deque;
  18 import org.opendaylight.yangtools.concepts.Codec;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  22 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  23 import org.opendaylight.yangtools.yang.data.impl.codec.SchemaTracker;
  24 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.Module;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  29 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  30
  31 /**
  32  * This implementation will create JSON output as output stream.
  33  *
  34  * Values of leaf and leaf-list are NOT translated according to codecs.
  35  *
  36  * FIXME: rewrite this in terms of {@link JsonWriter}.
  37  */
  38 public class JSONNormalizedNodeStreamWriter implements NormalizedNodeStreamWriter {
  39
  40     private static enum NodeType {
  41         OBJECT,
  42         LIST,
  43         OTHER,
  44     }
  45
  46     private static class TypeInfo {
  47         private boolean hasAtLeastOneChild = false;
  48         private final NodeType type;
  49         private final URI uri;
  50
  51         public TypeInfo(final NodeType type, final URI uri) {
  52             this.type = type;
  53             this.uri = uri;
  54         }
  55
  56         public void setHasAtLeastOneChild(final boolean hasChildren) {
  57             this.hasAtLeastOneChild = hasChildren;
  58         }
  59
  60         public NodeType getType() {
  61             return type;
  62         }
  63
  64         public URI getNamespace() {
  65             return uri;
  66         }
  67
  68         public boolean hasAtLeastOneChild() {
  69             return hasAtLeastOneChild;
  70         }
  71     }
  72
  73     private final Deque<TypeInfo> stack = new ArrayDeque<>();
  74     private final SchemaContext schemaContext;
  75     private final CodecFactory codecs;
  76     private final SchemaTracker tracker;
  77     private final Writer writer;
  78     private final String indent;
  79
  80     private URI currentNamespace = null;
  81     private int currentDepth = 0;
  82
  83     private JSONNormalizedNodeStreamWriter(final SchemaContext schemaContext,
  84             final Writer writer, final int indentSize) {
  85         this.schemaContext = Preconditions.checkNotNull(schemaContext);
  86         this.writer = Preconditions.checkNotNull(writer);
  87
  88         Preconditions.checkArgument(indentSize >= 0, "Indent size must be non-negative");
  89         if (indentSize != 0) {
  90             indent = Strings.repeat(" ", indentSize);
  91         } else {
  92             indent = null;
  93         }
  94
  95         this.codecs = CodecFactory.create(schemaContext);
  96         this.tracker = SchemaTracker.create(schemaContext);
  97     }
  98
  99     private JSONNormalizedNodeStreamWriter(final SchemaContext schemaContext, final SchemaPath path,
 100             final Writer writer, final URI initialNs,final int indentSize) {
 101         this.schemaContext = Preconditions.checkNotNull(schemaContext);
 102         this.writer = Preconditions.checkNotNull(writer);
 103
 104         Preconditions.checkArgument(indentSize >= 0, "Indent size must be non-negative");
 105         if (indentSize != 0) {
 106             indent = Strings.repeat(" ", indentSize);
 107         } else {
 108             indent = null;
 109         }
 110         this.currentNamespace = initialNs;
 111         this.codecs = CodecFactory.create(schemaContext);
 112         this.tracker = SchemaTracker.create(schemaContext,path);
 113     }
 114
 115     /**
 116      * Create a new stream writer, which writes to the specified {@link Writer}.
 117      *
 118      * @param schemaContext Schema context
 119      * @param writer Output writer
 120      * @return A stream writer instance
 121      */
 122     public static NormalizedNodeStreamWriter create(final SchemaContext schemaContext, final Writer writer) {
 123         return new JSONNormalizedNodeStreamWriter(schemaContext, writer, 0);
 124     }
 125
 126     /**
 127      * Create a new stream writer, which writes to the specified {@link Writer}.
 128      *
 129      * @param schemaContext Schema context
 130      * @param writer Output writer
 131      * @return A stream writer instance
 132      */
 133     public static NormalizedNodeStreamWriter create(final SchemaContext schemaContext, SchemaPath path,final Writer writer) {
 134         return new JSONNormalizedNodeStreamWriter(schemaContext, path, writer, null, 0);
 135     }
 136
 137     /**
 138      * Create a new stream writer, which writes to the specified {@link Writer}.
 139      *
 140      * @param schemaContext Schema context
 141      * @param writer Output writer
 142      * @param initialNs Initial namespace
 143      * @return A stream writer instance
 144      */
 145     public static NormalizedNodeStreamWriter create(final SchemaContext schemaContext, SchemaPath path,URI initialNs, final Writer writer) {
 146         return new JSONNormalizedNodeStreamWriter(schemaContext, path, writer, initialNs, 0);
 147     }
 148
 149     /**
 150      * Create a new stream writer, which writes to the specified output stream.
 151      *
 152      * @param schemaContext Schema context
 153      * @param writer Output writer
 154      * @param indentSize indentation size
 155      * @return A stream writer instance
 156      */
 157     public static NormalizedNodeStreamWriter create(final SchemaContext schemaContext, final Writer writer, final int indentSize) {
 158         return new JSONNormalizedNodeStreamWriter(schemaContext, writer, indentSize);
 159     }
 160
 161     @Override
 162     public void leafNode(final NodeIdentifier name, final Object value) throws IOException {
 163         final LeafSchemaNode schema = tracker.leafNode(name);
 164         final Codec<Object, Object> codec = codecs.codecFor(schema.getType());
 165
 166         separateElementFromPreviousElement();
 167         writeJsonIdentifier(name);
 168         currentNamespace = stack.peek().getNamespace();
 169         writeValue(String.valueOf(codec.serialize(value)));
 170         separateNextSiblingsWithComma();
 171     }
 172
 173     @Override
 174     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) throws IOException {
 175         tracker.startLeafSet(name);
 176
 177         separateElementFromPreviousElement();
 178         stack.push(new TypeInfo(NodeType.LIST, name.getNodeType().getNamespace()));
 179         writeJsonIdentifier(name);
 180         writeStartList();
 181         indentRight();
 182     }
 183
 184     @Override
 185     public void leafSetEntryNode(final Object value) throws IOException {
 186         final LeafListSchemaNode schema = tracker.leafSetEntryNode();
 187         final Codec<Object, Object> codec = codecs.codecFor(schema.getType());
 188
 189         separateElementFromPreviousElement();
 190         writeValue(String.valueOf(codec.serialize(value)));
 191         separateNextSiblingsWithComma();
 192     }
 193
 194     @Override
 195     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 196         tracker.startContainerNode(name);
 197
 198         separateElementFromPreviousElement();
 199         stack.push(new TypeInfo(NodeType.OBJECT, name.getNodeType().getNamespace()));
 200         writeJsonIdentifier(name);
 201         writeStartObject();
 202         indentRight();
 203     }
 204
 205     @Override
 206     public void startUnkeyedList(final NodeIdentifier name, final int childSizeHint) throws IOException {
 207         tracker.startList(name);
 208
 209         separateElementFromPreviousElement();
 210         stack.push(new TypeInfo(NodeType.LIST, name.getNodeType().getNamespace()));
 211         writeJsonIdentifier(name);
 212         writeStartList();
 213         indentRight();
 214     }
 215
 216     @Override
 217     public void startUnkeyedListItem(final NodeIdentifier name, final int childSizeHint) throws IOException {
 218         tracker.startListItem(name);
 219
 220         separateElementFromPreviousElement();
 221         stack.push(new TypeInfo(NodeType.OBJECT, name.getNodeType().getNamespace()));
 222         writeStartObject();
 223         indentRight();
 224     }
 225
 226     @Override
 227     public void startMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 228         tracker.startList(name);
 229
 230         separateElementFromPreviousElement();
 231         stack.push(new TypeInfo(NodeType.LIST, name.getNodeType().getNamespace()));
 232         writeJsonIdentifier(name);
 233         writeStartList();
 234         indentRight();
 235     }
 236
 237     @Override
 238     public void startMapEntryNode(final NodeIdentifierWithPredicates identifier, final int childSizeHint)
 239             throws IOException {
 240         tracker.startListItem(identifier);
 241         separateElementFromPreviousElement();
 242         stack.push(new TypeInfo(NodeType.OBJECT, identifier.getNodeType().getNamespace()));
 243
 244
 245         writeStartObject();
 246         indentRight();
 247     }
 248
 249     @Override
 250     public void startOrderedMapNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 251         tracker.startListItem(name);
 252
 253         stack.push(new TypeInfo(NodeType.LIST, name.getNodeType().getNamespace()));
 254         separateElementFromPreviousElement();
 255         writeJsonIdentifier(name);
 256         writeStartList();
 257         indentRight();
 258     }
 259
 260     @Override
 261     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) throws IllegalArgumentException {
 262         tracker.startChoiceNode(name);
 263         handleInvisibleNode(name.getNodeType().getNamespace());
 264     }
 265
 266     @Override
 267     public void startAugmentationNode(final AugmentationIdentifier identifier) throws IllegalArgumentException {
 268         tracker.startAugmentationNode(identifier);
 269         handleInvisibleNode(currentNamespace);
 270     }
 271
 272     @Override
 273     public void anyxmlNode(final NodeIdentifier name, final Object value) throws IOException {
 274         final AnyXmlSchemaNode schema = tracker.anyxmlNode(name);
 275         // FIXME: should have a codec based on this :)
 276
 277         separateElementFromPreviousElement();
 278         writeJsonIdentifier(name);
 279         currentNamespace = stack.peek().getNamespace();
 280         writeValue(value.toString());
 281         separateNextSiblingsWithComma();
 282     }
 283
 284     @Override
 285     public void endNode() throws IOException {
 286         tracker.endNode();
 287
 288         final TypeInfo t = stack.pop();
 289         switch (t.getType()) {
 290         case LIST:
 291             indentLeft();
 292             newLine();
 293             writer.append(']');
 294             break;
 295         case OBJECT:
 296             indentLeft();
 297             newLine();
 298             writer.append('}');
 299             break;
 300         default:
 301             break;
 302         }
 303
 304         currentNamespace = stack.isEmpty() ? null : stack.peek().getNamespace();
 305         separateNextSiblingsWithComma();
 306     }
 307
 308     private void separateElementFromPreviousElement() throws IOException {
 309         if (!stack.isEmpty() && stack.peek().hasAtLeastOneChild()) {
 310             writer.append(',');
 311         }
 312         newLine();
 313     }
 314
 315     private void newLine() throws IOException {
 316         if (indent != null) {
 317             writer.append('\n');
 318
 319             for (int i = 0; i < currentDepth; i++) {
 320                 writer.append(indent);
 321             }
 322         }
 323     }
 324
 325     private void separateNextSiblingsWithComma() {
 326         if (!stack.isEmpty()) {
 327             stack.peek().setHasAtLeastOneChild(true);
 328         }
 329     }
 330
 331     /**
 332      * Invisible nodes have to be also pushed to stack because of pairing of start*() and endNode() methods. Information
 333      * about child existing (due to printing comma) has to be transfered to invisible node.
 334      */
 335     private void handleInvisibleNode(final URI uri) {
 336         TypeInfo typeInfo = new TypeInfo(NodeType.OTHER, uri);
 337         typeInfo.setHasAtLeastOneChild(stack.peek().hasAtLeastOneChild());
 338         stack.push(typeInfo);
 339     }
 340
 341     private void writeStartObject() throws IOException {
 342         writer.append('{');
 343     }
 344
 345     private void writeStartList() throws IOException {
 346         writer.append('[');
 347     }
 348
 349     private void writeModulName(final URI namespace) throws IOException {
 350         if (this.currentNamespace == null || namespace != this.currentNamespace) {
 351             Module module = schemaContext.findModuleByNamespaceAndRevision(namespace, null);
 352             writer.append(module.getName());
 353             writer.append(':');
 354             currentNamespace = namespace;
 355         }
 356     }
 357
 358     private void writeValue(final String value) throws IOException {
 359         writer.append('"');
 360         writer.append(value);
 361         writer.append('"');
 362     }
 363
 364     private void writeJsonIdentifier(final NodeIdentifier name) throws IOException {
 365         writer.append('"');
 366         writeModulName(name.getNodeType().getNamespace());
 367         writer.append(name.getNodeType().getLocalName());
 368         writer.append("\":");
 369     }
 370
 371     private void indentRight() {
 372         currentDepth++;
 373     }
 374
 375     private void indentLeft() {
 376         currentDepth--;
 377     }
 378
 379     @Override
 380     public void flush() throws IOException {
 381         writer.flush();
 382     }
 383
 384     @Override
 385     public void close() throws IOException {
 386         writer.flush();
 387         writer.close();
 388     }
 389
 390 }