yang/yang-model-export/src/main/java/org/opendaylight/yangtools/yang/model/export/SingleModuleYinStatementWriter.java

   1 /*
   2  * Copyright (c) 2015 Cisco Systems, Inc. and others.  All rights reserved.
   3  *
   4  * This program and the accompanying materials are made available under the
   5  * terms of the Eclipse Public License v1.0 which accompanies this distribution,
   6  * and is available at http://www.eclipse.org/legal/epl-v10.html
   7  */
   8 package org.opendaylight.yangtools.yang.model.export;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.base.Preconditions;
  12 import com.google.common.collect.BiMap;
  13 import com.google.common.collect.HashBiMap;
  14 import java.net.URI;
  15 import java.util.Iterator;
  16 import java.util.Map;
  17 import java.util.Map.Entry;
  18 import javax.annotation.Nullable;
  19 import javax.annotation.concurrent.NotThreadSafe;
  20 import javax.xml.XMLConstants;
  21 import javax.xml.stream.XMLStreamException;
  22 import javax.xml.stream.XMLStreamWriter;
  23 import org.opendaylight.yangtools.yang.common.QName;
  24 import org.opendaylight.yangtools.yang.common.YangConstants;
  25 import org.opendaylight.yangtools.yang.model.api.RevisionAwareXPath;
  26 import org.opendaylight.yangtools.yang.model.api.Rfc6020Mapping;
  27 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  28 import org.opendaylight.yangtools.yang.model.api.meta.StatementDefinition;
  29
  30 @Beta
  31 @NotThreadSafe
  32 class SingleModuleYinStatementWriter implements StatementTextWriter {
  33
  34     private final XMLStreamWriter writer;
  35     private final URI currentModuleNs;
  36     private final BiMap<String, URI> prefixToNamespace;
  37     private StatementDefinition currentStatement;
  38
  39     private SingleModuleYinStatementWriter(final XMLStreamWriter writer, final URI moduleNamespace,
  40             final Map<String, URI> prefixToNs) {
  41         super();
  42         this.writer = writer;
  43         this.currentModuleNs = moduleNamespace;
  44         this.prefixToNamespace = HashBiMap.create(prefixToNs);
  45         initializeYinNamespaceInXml();
  46     }
  47
  48     private void initializeYinNamespaceInXml() {
  49        try {
  50             final String defaultNs = writer.getNamespaceContext().getNamespaceURI(XMLConstants.NULL_NS_URI);
  51             if (defaultNs == null) {
  52                 writer.setDefaultNamespace(YangConstants.RFC6020_YIN_NAMESPACE.toString());
  53             } else if (!YangConstants.RFC6020_YIN_NAMESPACE.toString().equals(defaultNs)) {
  54                 // FIXME: Implement support for exporting YIN as part of other XML document.
  55                 throw new UnsupportedOperationException("Not implemented support for nesting YIN in different XML element.");
  56             }
  57         } catch (final XMLStreamException e) {
  58             throw new IllegalStateException(e);
  59         }
  60     }
  61
  62     static StatementTextWriter create(final XMLStreamWriter writer, final URI moduleNs,
  63             final Map<String, URI> prefixToNs) {
  64         return new SingleModuleYinStatementWriter(writer, moduleNs, prefixToNs);
  65     }
  66
  67     @Override
  68     public void startStatement(final StatementDefinition statement) {
  69         currentStatement = Preconditions.checkNotNull(statement);
  70         try {
  71             writeStartXmlElement(statement.getStatementName());
  72             if (Rfc6020Mapping.MODULE.equals(statement) || Rfc6020Mapping.SUBMODULE.equals(statement)) {
  73                 declareXmlNamespaces(prefixToNamespace);
  74             }
  75         } catch (final XMLStreamException e) {
  76             // FIXME: Introduce proper expression
  77             throw new IllegalStateException(e);
  78         }
  79     }
  80
  81     @Override
  82     public void endStatement() {
  83         currentStatement = null;
  84         try {
  85             writeXmlEndElement();
  86         } catch (final XMLStreamException e) {
  87             // FIXME: Introduce proper expression
  88             throw new IllegalStateException(e);
  89         }
  90     }
  91
  92     @Override
  93     public void writeArgument(final String strRep) {
  94         checkArgumentApplicable();
  95         writeArgument0(strRep);
  96     }
  97
  98     @Override
  99     public void writeArgument(final QName value) {
 100         checkArgumentApplicable();
 101         final String valueStr = toPrefixedString(value);
 102         writeArgument0(valueStr);
 103     }
 104
 105     @Override
 106     public void writeArgument(final SchemaPath targetPath) {
 107         checkArgumentApplicable();
 108         final StringBuilder valueStr = new StringBuilder();
 109         if(targetPath.isAbsolute()) {
 110             valueStr.append("/");
 111         }
 112         final Iterator<QName> argIt = targetPath.getPathFromRoot().iterator();
 113         while(argIt.hasNext()) {
 114             valueStr.append(toPrefixedString(argIt.next()));
 115             if(argIt.hasNext()) {
 116                 valueStr.append("/");
 117             }
 118         }
 119         writeArgument0(valueStr.toString());
 120     }
 121
 122     @Override
 123     public void writeArgument(final RevisionAwareXPath xpath) {
 124         checkArgumentApplicable();
 125         // FIXME: This implementation assumes prefixes are unchanged
 126         // and were not changed in schema context.
 127         writeArgument0(xpath.toString());
 128     }
 129
 130
 131     private void writeArgument0(final String strRep) {
 132         try {
 133             if (isArgumentYinElement(currentStatement)) {
 134                 writeStartXmlElement(currentStatement.getArgumentName());
 135                 writeXmlText(strRep);
 136                 writeXmlEndElement();
 137             } else {
 138                 writeXmlArgument(currentStatement.getArgumentName(), strRep);
 139             }
 140         } catch (final XMLStreamException e) {
 141             // FIXME: throw proper exception
 142             throw new IllegalStateException(e);
 143         }
 144     }
 145
 146     private boolean isArgumentYinElement(StatementDefinition currentStatement) {
 147         if (currentStatement instanceof Rfc6020Mapping) {
 148             return ((Rfc6020Mapping) currentStatement).isArgumentYinElement();
 149         } else if (currentStatement instanceof ExtensionStatement) {
 150             return ((ExtensionStatement) currentStatement).isArgumentYinElement();
 151         }
 152         return false;
 153     }
 154
 155     private void checkArgumentApplicable() {
 156         Preconditions.checkState(currentStatement != null, "No statement is opened.");
 157         Preconditions.checkState(currentStatement.getArgumentName() != null, "Statement %s does not take argument.",
 158                 currentStatement.getArgumentName());
 159     }
 160
 161
 162
 163     private String toPrefixedString(@Nullable final String prefix, final String localName) {
 164         if (prefix == null || prefix.isEmpty()) {
 165             return localName;
 166         }
 167         return prefix + ":" + localName;
 168     }
 169
 170     private String toPrefixedString(final QName value) {
 171         final URI valueNs = value.getNamespace();
 172         final String valueLocal = value.getLocalName();
 173         if (currentModuleNs.equals(valueNs)) {
 174             return valueLocal;
 175         }
 176         final String prefix = ensureAndGetXmlNamespacePrefix(valueNs);
 177         return toPrefixedString(prefix, valueLocal);
 178     }
 179
 180     private @Nullable String ensureAndGetXmlNamespacePrefix(final URI namespace) {
 181         if(YangConstants.RFC6020_YANG_NAMESPACE.equals(namespace)) {
 182          // YANG namespace does not have prefix if used in arguments.
 183             return null;
 184
 185         }
 186         String prefix = writer.getNamespaceContext().getPrefix(namespace.toString());
 187         if (prefix == null) {
 188             // FIXME: declare prefix
 189             prefix =prefixToNamespace.inverse().get(namespace);
 190         }
 191         if(prefix == null) {
 192             throw new IllegalArgumentException("Namespace " + namespace + " is not bound to imported prefixes.");
 193         }
 194         return prefix;
 195     }
 196
 197     private void writeXmlText(final String strRep) throws XMLStreamException {
 198         writer.writeCharacters(strRep);
 199     }
 200
 201     private void declareXmlNamespaces(final Map<String, URI> prefixToNamespace) {
 202         try {
 203             writer.writeDefaultNamespace(YangConstants.RFC6020_YIN_NAMESPACE.toString());
 204             for (final Entry<String, URI> nsDeclaration : prefixToNamespace.entrySet()) {
 205                 writer.writeNamespace(nsDeclaration.getKey(), nsDeclaration.getValue().toString());
 206             }
 207         } catch (final XMLStreamException e) {
 208             throw new IllegalStateException(e);
 209         }
 210     }
 211
 212     private void writeXmlEndElement() throws XMLStreamException {
 213         writer.writeEndElement();
 214     }
 215
 216     private void writeXmlArgument(final QName qName, final String value) throws XMLStreamException {
 217         writer.writeAttribute(qName.getNamespace().toString(), qName.getLocalName(), value);
 218     }
 219
 220     private void writeStartXmlElement(final QName name) throws XMLStreamException {
 221         writer.writeStartElement(name.getNamespace().toString(), name.getLocalName());
 222     }
 223
 224 }