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.xml.stream.XMLStreamException;
  15 import javax.xml.stream.XMLStreamWriter;
  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.PathArgument;
  20 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  21 import org.opendaylight.yangtools.yang.data.impl.codec.SchemaTracker;
  22 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  24 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  25 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  26 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  28 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
  29 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  31
  32 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter extends XMLStreamNormalizedNodeStreamWriter<SchemaNode>
  33         implements SchemaContextProvider {
  34     private final SchemaTracker tracker;
  35     private final SchemaAwareXMLStreamWriterUtils streamUtils;
  36
  37     private SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final SchemaContext context,
  38                                                            final SchemaPath path) {
  39         super(writer);
  40         this.tracker = SchemaTracker.create(context, path);
  41         this.streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
  42     }
  43
  44     static NormalizedNodeStreamWriter newInstance(final XMLStreamWriter writer, final SchemaContext context,
  45             final SchemaPath path) {
  46         return new SchemaAwareXMLStreamNormalizedNodeStreamWriter(writer, context, path);
  47     }
  48
  49     @Override
  50     protected void writeValue(final XMLStreamWriter xmlWriter, final QName qname, final Object value,
  51             final SchemaNode schemaNode) throws IOException, XMLStreamException {
  52         streamUtils.writeValue(xmlWriter, schemaNode, value, qname.getModule());
  53     }
  54
  55     @Override
  56     protected void startList(final NodeIdentifier name) {
  57         tracker.startList(name);
  58     }
  59
  60     @Override
  61     protected void startListItem(final PathArgument name) throws IOException {
  62         tracker.startListItem(name);
  63         startElement(name.getNodeType());
  64     }
  65
  66     @Override
  67     protected void endNode(final XMLStreamWriter xmlWriter) throws IOException, XMLStreamException {
  68         final Object schema = tracker.endNode();
  69         if (schema instanceof ListSchemaNode) {
  70             // For lists, we only emit end element on the inner frame
  71             final Object parent = tracker.getParent();
  72             if (parent == schema) {
  73                 xmlWriter.writeEndElement();
  74             }
  75         } else if (schema instanceof ContainerSchemaNode) {
  76             // Emit container end element
  77             xmlWriter.writeEndElement();
  78         }
  79     }
  80
  81     @Override
  82     public void leafNode(final NodeIdentifier name, final Object value) throws IOException {
  83         final LeafSchemaNode schema = tracker.leafNode(name);
  84         writeElement(schema.getQName(), value, Collections.emptyMap(), schema);
  85     }
  86
  87     @Override
  88     public void leafNode(final NodeIdentifier name, final Object value, final Map<QName, String> attributes)
  89         throws IOException {
  90         final LeafSchemaNode schema = tracker.leafNode(name);
  91         writeElement(schema.getQName(), value, attributes, schema);
  92     }
  93
  94     @Override
  95     public void leafSetEntryNode(final QName name, final Object value, final Map<QName, String> attributes)
  96             throws IOException {
  97         final LeafListSchemaNode schema = tracker.leafSetEntryNode(name);
  98         writeElement(schema.getQName(), value, attributes, schema);
  99     }
 100
 101     @Override
 102     public void leafSetEntryNode(final QName name, final Object value) throws IOException {
 103         final LeafListSchemaNode schema = tracker.leafSetEntryNode(name);
 104         writeElement(schema.getQName(), value, Collections.emptyMap(), schema);
 105     }
 106
 107     @Override
 108     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
 109         tracker.startLeafSet(name);
 110     }
 111
 112     @Override
 113     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
 114         tracker.startLeafSet(name);
 115     }
 116
 117     @Override
 118     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 119         final SchemaNode schema = tracker.startContainerNode(name);
 120         startElement(schema.getQName());
 121     }
 122
 123     @Override
 124     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 125         tracker.startChoiceNode(name);
 126     }
 127
 128     @Override
 129     public void startAugmentationNode(final AugmentationIdentifier identifier) {
 130         tracker.startAugmentationNode(identifier);
 131     }
 132
 133     @Override
 134     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 135         final SchemaNode schema = tracker.startYangModeledAnyXmlNode(name);
 136         startElement(schema.getQName());
 137     }
 138
 139     @Override
 140     public void anyxmlNode(final NodeIdentifier name, final Object value) throws IOException {
 141         final AnyXmlSchemaNode schema = tracker.anyxmlNode(name);
 142         anyxmlNode(schema.getQName(), value);
 143     }
 144
 145     @Override
 146     public SchemaContext getSchemaContext() {
 147         return streamUtils.getSchemaContext();
 148     }
 149 }