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 static com.google.common.base.Preconditions.checkArgument;
  12 import static com.google.common.base.Preconditions.checkState;
  13 import static java.util.Objects.requireNonNull;
  14
  15 import java.io.IOException;
  16 import java.util.Optional;
  17 import javax.xml.stream.XMLStreamException;
  18 import javax.xml.stream.XMLStreamWriter;
  19 import javax.xml.transform.dom.DOMSource;
  20 import org.opendaylight.yangtools.rfc7952.model.api.AnnotationSchemaNode;
  21 import org.opendaylight.yangtools.yang.common.QName;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  26 import org.opendaylight.yangtools.yang.data.impl.codec.SchemaTracker;
  27 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  33 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
  34 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  35
  36 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter extends XMLStreamNormalizedNodeStreamWriter<SchemaNode>
  37         implements SchemaContextProvider {
  38     private final SchemaTracker tracker;
  39     private final SchemaAwareXMLStreamWriterUtils streamUtils;
  40
  41     SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final SchemaContext context,
  42             final SchemaTracker tracker) {
  43         super(writer);
  44         this.tracker = requireNonNull(tracker);
  45         this.streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
  46     }
  47
  48     @Override
  49     String encodeValue(final ValueWriter xmlWriter, final Object value, final SchemaNode schemaNode)
  50             throws XMLStreamException {
  51         return streamUtils.encodeValue(xmlWriter, schemaNode, value, schemaNode.getQName().getModule());
  52     }
  53
  54     @Override
  55     String encodeAnnotationValue(final ValueWriter xmlWriter, final QName qname, final Object value)
  56             throws XMLStreamException {
  57         final Optional<AnnotationSchemaNode> optAnnotation = AnnotationSchemaNode.find(streamUtils.getSchemaContext(),
  58             qname);
  59         if (optAnnotation.isPresent()) {
  60             return streamUtils.encodeValue(xmlWriter, optAnnotation.get(), value, qname.getModule());
  61         }
  62
  63         checkArgument(!qname.getRevision().isPresent(), "Failed to find bound annotation %s", qname);
  64         checkArgument(value instanceof String, "Invalid non-string value %s for unbound annotation %s", value, qname);
  65         return (String) value;
  66     }
  67
  68     @Override
  69     void startList(final NodeIdentifier name) {
  70         tracker.startList(name);
  71     }
  72
  73     @Override
  74     void startListItem(final PathArgument name) throws IOException {
  75         tracker.startListItem(name);
  76         startElement(name.getNodeType());
  77     }
  78
  79     @Override
  80     public void endNode() throws IOException {
  81         final Object schema = tracker.endNode();
  82         if (schema instanceof ListSchemaNode || schema instanceof LeafListSchemaNode) {
  83             // For lists, we only emit end element on the inner frame
  84             final Object parent = tracker.getParent();
  85             if (parent == schema) {
  86                 endElement();
  87             }
  88         } else if (schema instanceof ContainerSchemaNode || schema instanceof LeafSchemaNode) {
  89             endElement();
  90         }
  91     }
  92
  93     @Override
  94     public void startLeafNode(final NodeIdentifier name) throws IOException {
  95         tracker.startLeafNode(name);
  96         startElement(name.getNodeType());
  97     }
  98
  99     @Override
 100     public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
 101         tracker.startLeafSetEntryNode(name);
 102         startElement(name.getNodeType());
 103     }
 104
 105     @Override
 106     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
 107         tracker.startLeafSet(name);
 108     }
 109
 110     @Override
 111     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
 112         tracker.startLeafSet(name);
 113     }
 114
 115     @Override
 116     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 117         final SchemaNode schema = tracker.startContainerNode(name);
 118         startElement(schema.getQName());
 119     }
 120
 121     @Override
 122     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 123         tracker.startChoiceNode(name);
 124     }
 125
 126     @Override
 127     public void startAugmentationNode(final AugmentationIdentifier identifier) {
 128         tracker.startAugmentationNode(identifier);
 129     }
 130
 131     @Override
 132     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 133         final SchemaNode schema = tracker.startYangModeledAnyXmlNode(name);
 134         startElement(schema.getQName());
 135     }
 136
 137     @Override
 138     public void startAnyxmlNode(final NodeIdentifier name) throws IOException {
 139         tracker.startAnyxmlNode(name);
 140         startElement(name.getNodeType());
 141     }
 142
 143     @Override
 144     public SchemaContext getSchemaContext() {
 145         return streamUtils.getSchemaContext();
 146     }
 147
 148     @Override
 149     public void scalarValue(final Object value) throws IOException {
 150         final Object current = tracker.getParent();
 151         checkState(current instanceof LeafSchemaNode || current instanceof LeafListSchemaNode,
 152             "Unexpected scalar value %s with %s", value, current);
 153         writeValue(value, (SchemaNode) current);
 154     }
 155
 156     @Override
 157     public void domSourceValue(final DOMSource value) throws IOException {
 158         final Object current = tracker.getParent();
 159         checkState(current instanceof AnyXmlSchemaNode, "Unexpected scala value %s with %s", value, current);
 160         anyxmlValue(value);
 161     }
 162 }