yang/yang-data-codec-xml/src/main/java/org/opendaylight/yangtools/yang/data/codec/xml/SchemaAwareXMLStreamNormalizedNodeStreamWriter.java

   1 /*
   2  * Copyright (c) 2014 Cisco Systems, Inc. and others.  All rights reserved.
   3  * Copyright (c) 2016 Brocade Communications Systems, Inc. and others.  All rights reserved.
   4  *
   5  * This program and the accompanying materials are made available under the
   6  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   7  * and is available at http://www.eclipse.org/legal/epl-v10.html
   8  */
   9 package org.opendaylight.yangtools.yang.data.codec.xml;
  10
  11 import java.io.IOException;
  12 import java.util.Collections;
  13 import java.util.Map;
  14 import javax.annotation.Nonnull;
  15 import javax.xml.stream.XMLStreamException;
  16 import javax.xml.stream.XMLStreamWriter;
  17 import org.opendaylight.yangtools.yang.common.QName;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  19 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  21 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  22 import org.opendaylight.yangtools.yang.data.impl.codec.SchemaTracker;
  23 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  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.ListSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  29 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
  30 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  32
  33 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter extends XMLStreamNormalizedNodeStreamWriter<SchemaNode>
  34         implements SchemaContextProvider {
  35     private final SchemaTracker tracker;
  36     private final SchemaAwareXMLStreamWriterUtils streamUtils;
  37
  38     private SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final SchemaContext context,
  39                                                            final SchemaPath path) {
  40         super(writer);
  41         this.tracker = SchemaTracker.create(context, path);
  42         this.streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
  43     }
  44
  45     static NormalizedNodeStreamWriter newInstance(final XMLStreamWriter writer, final SchemaContext context,
  46             final SchemaPath path) {
  47         return new SchemaAwareXMLStreamNormalizedNodeStreamWriter(writer, context, path);
  48     }
  49
  50     @Override
  51     protected void writeValue(final XMLStreamWriter xmlWriter, final QName qname, @Nonnull final Object value,
  52             final SchemaNode schemaNode) throws IOException, XMLStreamException {
  53         streamUtils.writeValue(xmlWriter, schemaNode, value, qname.getModule());
  54     }
  55
  56     @Override
  57     protected void startList(final NodeIdentifier name) {
  58         tracker.startList(name);
  59     }
  60
  61     @Override
  62     protected void startListItem(final PathArgument name) throws IOException {
  63         tracker.startListItem(name);
  64         startElement(name.getNodeType());
  65     }
  66
  67     @Override
  68     protected void endNode(final XMLStreamWriter xmlWriter) throws IOException, XMLStreamException {
  69         final Object schema = tracker.endNode();
  70         if (schema instanceof ListSchemaNode) {
  71             // For lists, we only emit end element on the inner frame
  72             final Object parent = tracker.getParent();
  73             if (parent == schema) {
  74                 xmlWriter.writeEndElement();
  75             }
  76         } else if (schema instanceof ContainerSchemaNode) {
  77             // Emit container end element
  78             xmlWriter.writeEndElement();
  79         }
  80     }
  81
  82     @Override
  83     public void leafNode(final NodeIdentifier name, final Object value) throws IOException {
  84         final LeafSchemaNode schema = tracker.leafNode(name);
  85         writeElement(schema.getQName(), value, Collections.emptyMap(), schema);
  86     }
  87
  88     @Override
  89     public void leafNode(final NodeIdentifier name, final Object value, final Map<QName, String> attributes)
  90         throws IOException {
  91         final LeafSchemaNode schema = tracker.leafNode(name);
  92         writeElement(schema.getQName(), value, attributes, schema);
  93     }
  94
  95     @Override
  96     public void leafSetEntryNode(final QName name, final Object value, final Map<QName, String> attributes)
  97             throws IOException {
  98         final LeafListSchemaNode schema = tracker.leafSetEntryNode(name);
  99         writeElement(schema.getQName(), value, attributes, schema);
 100     }
 101
 102     @Override
 103     public void leafSetEntryNode(final QName name, final Object value) throws IOException {
 104         final LeafListSchemaNode schema = tracker.leafSetEntryNode(name);
 105         writeElement(schema.getQName(), value, Collections.emptyMap(), schema);
 106     }
 107
 108     @Override
 109     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
 110         tracker.startLeafSet(name);
 111     }
 112
 113     @Override
 114     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
 115         tracker.startLeafSet(name);
 116     }
 117
 118     @Override
 119     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 120         final SchemaNode schema = tracker.startContainerNode(name);
 121         startElement(schema.getQName());
 122     }
 123
 124     @Override
 125     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 126         tracker.startChoiceNode(name);
 127     }
 128
 129     @Override
 130     public void startAugmentationNode(final AugmentationIdentifier identifier) {
 131         tracker.startAugmentationNode(identifier);
 132     }
 133
 134     @Override
 135     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 136         final SchemaNode schema = tracker.startYangModeledAnyXmlNode(name);
 137         startElement(schema.getQName());
 138     }
 139
 140     @Override
 141     public void anyxmlNode(final NodeIdentifier name, final Object value) throws IOException {
 142         final AnyXmlSchemaNode schema = tracker.anyxmlNode(name);
 143         anyxmlNode(schema.getQName(), value);
 144     }
 145
 146     @Override
 147     public SchemaContext getSchemaContext() {
 148         return streamUtils.getSchemaContext();
 149     }
 150 }