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.EffectiveModelContext;
  31 import org.opendaylight.yangtools.yang.model.api.EffectiveModelContextProvider;
  32 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  34 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.TypedDataSchemaNode;
  37
  38 final class SchemaAwareXMLStreamNormalizedNodeStreamWriter
  39         extends XMLStreamNormalizedNodeStreamWriter<TypedDataSchemaNode> implements EffectiveModelContextProvider {
  40     private final SchemaTracker tracker;
  41     private final SchemaAwareXMLStreamWriterUtils streamUtils;
  42
  43     SchemaAwareXMLStreamNormalizedNodeStreamWriter(final XMLStreamWriter writer, final EffectiveModelContext context,
  44             final SchemaTracker tracker) {
  45         super(writer);
  46         this.tracker = requireNonNull(tracker);
  47         this.streamUtils = new SchemaAwareXMLStreamWriterUtils(context);
  48     }
  49
  50     @Override
  51     String encodeValue(final ValueWriter xmlWriter, final Object value, final TypedDataSchemaNode schemaNode)
  52             throws XMLStreamException {
  53         return streamUtils.encodeValue(xmlWriter, schemaNode, schemaNode.getType(), value,
  54             schemaNode.getQName().getModule());
  55     }
  56
  57     @Override
  58     String encodeAnnotationValue(final ValueWriter xmlWriter, final QName qname, final Object value)
  59             throws XMLStreamException {
  60         final Optional<AnnotationSchemaNode> optAnnotation =
  61             AnnotationSchemaNode.find(streamUtils.getEffectiveModelContext(), qname);
  62         if (optAnnotation.isPresent()) {
  63             final AnnotationSchemaNode schema = optAnnotation.get();
  64             return streamUtils.encodeValue(xmlWriter, schema, schema.getType(), value, qname.getModule());
  65         }
  66
  67         checkArgument(!qname.getRevision().isPresent(), "Failed to find bound annotation %s", qname);
  68         checkArgument(value instanceof String, "Invalid non-string value %s for unbound annotation %s", value, qname);
  69         return (String) value;
  70     }
  71
  72     @Override
  73     void startList(final NodeIdentifier name) {
  74         tracker.startList(name);
  75     }
  76
  77     @Override
  78     void startListItem(final PathArgument name) throws IOException {
  79         tracker.startListItem(name);
  80         startElement(name.getNodeType());
  81     }
  82
  83     @Override
  84     public void endNode() throws IOException {
  85         final Object schema = tracker.endNode();
  86         if (schema instanceof ListSchemaNode || schema instanceof LeafListSchemaNode) {
  87             // For lists, we only emit end element on the inner frame
  88             final Object parent = tracker.getParent();
  89             if (parent == schema) {
  90                 endElement();
  91             }
  92         } else if (schema instanceof ContainerSchemaNode || schema instanceof LeafSchemaNode
  93                 || schema instanceof AnydataSchemaNode || schema instanceof AnyxmlSchemaNode) {
  94             endElement();
  95         }
  96     }
  97
  98     @Override
  99     public void startLeafNode(final NodeIdentifier name) throws IOException {
 100         tracker.startLeafNode(name);
 101         startElement(name.getNodeType());
 102     }
 103
 104     @Override
 105     public void startLeafSetEntryNode(final NodeWithValue<?> name) throws IOException {
 106         tracker.startLeafSetEntryNode(name);
 107         startElement(name.getNodeType());
 108     }
 109
 110     @Override
 111     public void startLeafSet(final NodeIdentifier name, final int childSizeHint) {
 112         tracker.startLeafSet(name);
 113     }
 114
 115     @Override
 116     public void startOrderedLeafSet(final NodeIdentifier name, final int childSizeHint) {
 117         tracker.startLeafSet(name);
 118     }
 119
 120     @Override
 121     public void startContainerNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 122         final SchemaNode schema = tracker.startContainerNode(name);
 123         startElement(schema.getQName());
 124     }
 125
 126     @Override
 127     public void startChoiceNode(final NodeIdentifier name, final int childSizeHint) {
 128         tracker.startChoiceNode(name);
 129     }
 130
 131     @Override
 132     public void startAugmentationNode(final AugmentationIdentifier identifier) {
 133         tracker.startAugmentationNode(identifier);
 134     }
 135
 136     @Override
 137     public void startYangModeledAnyXmlNode(final NodeIdentifier name, final int childSizeHint) throws IOException {
 138         final SchemaNode schema = tracker.startYangModeledAnyXmlNode(name);
 139         startElement(schema.getQName());
 140     }
 141
 142     @Override
 143     public boolean startAnyxmlNode(final NodeIdentifier name, final Class<?> objectModel) throws IOException {
 144         if (DOMSource.class.isAssignableFrom(objectModel)) {
 145             tracker.startAnyxmlNode(name);
 146             startElement(name.getNodeType());
 147             return true;
 148         }
 149         return false;
 150     }
 151
 152     @Override
 153     public EffectiveModelContext getEffectiveModelContext() {
 154         return streamUtils.getEffectiveModelContext();
 155     }
 156
 157     @Override
 158     public void scalarValue(final Object value) throws IOException {
 159         final Object current = tracker.getParent();
 160         if (current instanceof TypedDataSchemaNode) {
 161             writeValue(value, (TypedDataSchemaNode) current);
 162         } else if (current instanceof AnydataSchemaNode) {
 163             anydataValue(value);
 164         } else {
 165             throw new IllegalStateException("Unexpected scalar value " + value + " with " + current);
 166         }
 167     }
 168
 169     @Override
 170     public void domSourceValue(final DOMSource value) throws IOException {
 171         final Object current = tracker.getParent();
 172         checkState(current instanceof AnyxmlSchemaNode, "Unexpected scala value %s with %s", value, current);
 173         anyxmlValue(value);
 174     }
 175
 176     @Override
 177     void startAnydata(final NodeIdentifier name) {
 178         tracker.startAnydataNode(name);
 179     }
 180 }