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.AnyDataSchemaNode;
  28 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  34 import org.opendaylight.yangtools.yang.model.api.SchemaContextProvider;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  36
  37 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter extends XMLStreamNormalizedNodeStreamWriter<SchemaNode>
  38         implements SchemaContextProvider {
  39     private final SchemaTracker tracker;
  40     private final SchemaAwareXMLStreamWriterUtils streamUtils;
  41
  42     SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final SchemaContext context,
  43             final SchemaTracker tracker) {
  44         super(writer);
  45         this.tracker = requireNonNull(tracker);
  46         this.streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
  47     }
  48
  49     @Override
  50     String encodeValue(final ValueWriter xmlWriter, final Object value, final SchemaNode schemaNode)
  51             throws XMLStreamException {
  52         return streamUtils.encodeValue(xmlWriter, schemaNode, value, schemaNode.getQName().getModule());
  53     }
  54
  55     @Override
  56     String encodeAnnotationValue(final ValueWriter xmlWriter, final QName qname, final Object value)
  57             throws XMLStreamException {
  58         final Optional<AnnotationSchemaNode> optAnnotation = AnnotationSchemaNode.find(streamUtils.getSchemaContext(),
  59             qname);
  60         if (optAnnotation.isPresent()) {
  61             return streamUtils.encodeValue(xmlWriter, optAnnotation.get(), value, qname.getModule());
  62         }
  63
  64         checkArgument(!qname.getRevision().isPresent(), "Failed to find bound annotation %s", qname);
  65         checkArgument(value instanceof String, "Invalid non-string value %s for unbound annotation %s", value, qname);
  66         return (String) value;
  67     }
  68
  69     @Override
  70     void startList(final NodeIdentifier name) {
  71         tracker.startList(name);
  72     }
  73
  74     @Override
  75     void startListItem(final PathArgument name) throws IOException {
  76         tracker.startListItem(name);
  77         startElement(name.getNodeType());
  78     }
  79
  80     @Override
  81     public void endNode() throws IOException {
  82         final Object schema = tracker.endNode();
  83         if (schema instanceof ListSchemaNode || schema instanceof LeafListSchemaNode) {
  84             // For lists, we only emit end element on the inner frame
  85             final Object parent = tracker.getParent();
  86             if (parent == schema) {
  87                 endElement();
  88             }
  89         } else if (schema instanceof ContainerSchemaNode || schema instanceof LeafSchemaNode
  90                 || schema instanceof AnyDataSchemaNode) {
  91             endElement();
  92         }
  93     }
  94
  95     @Override
  96     public void startLeafNode(final NodeIdentifier name) throws IOException {
  97         tracker.startLeafNode(name);
  98         startElement(name.getNodeType());
  99     }
 100
 101     @Override
 102     public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
 103         tracker.startLeafSetEntryNode(name);
 104         startElement(name.getNodeType());
 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 startAnyxmlNode(final NodeIdentifier name) throws IOException {
 141         tracker.startAnyxmlNode(name);
 142         startElement(name.getNodeType());
 143     }
 144
 145     @Override
 146     public SchemaContext getSchemaContext() {
 147         return streamUtils.getSchemaContext();
 148     }
 149
 150     @Override
 151     public void scalarValue(final Object value) throws IOException {
 152         final Object current = tracker.getParent();
 153         checkState(current instanceof LeafSchemaNode || current instanceof LeafListSchemaNode,
 154             "Unexpected scalar value %s with %s", value, current);
 155         writeValue(value, (SchemaNode) current);
 156     }
 157
 158     @Override
 159     public void domSourceValue(final DOMSource value) throws IOException {
 160         final Object current = tracker.getParent();
 161         checkState(current instanceof AnyXmlSchemaNode, "Unexpected scala value %s with %s", value, current);
 162         anyxmlValue(value);
 163     }
 164
 165     @Override
 166     SchemaNode startAnydata(final NodeIdentifier name) {
 167         return tracker.startAnydataNode(name);
 168     }
 169 }