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