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