yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/codec/xml/XmlDocumentUtils.java

   1 /*
   2  * Copyright (c) 2013 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.data.impl.codec.xml;
   9
  10 import com.google.common.base.Optional;
  11 import com.google.common.base.Preconditions;
  12 import java.net.URI;
  13 import java.util.Map;
  14 import java.util.Map.Entry;
  15 import org.opendaylight.yangtools.util.xml.UntrustedXML;
  16 import org.opendaylight.yangtools.yang.common.QName;
  17 import org.opendaylight.yangtools.yang.data.api.AttributesContainer;
  18 import org.opendaylight.yangtools.yang.data.api.ModifyAction;
  19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  20 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
  21 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  22 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  23 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  24 import org.w3c.dom.Attr;
  25 import org.w3c.dom.Document;
  26 import org.w3c.dom.Element;
  27
  28 public final class XmlDocumentUtils {
  29     public static final QName OPERATION_ATTRIBUTE_QNAME = QName.create(SchemaContext.NAME, "operation");
  30
  31     private XmlDocumentUtils() {
  32         throw new UnsupportedOperationException("Utility class should not be instantiated");
  33     }
  34
  35     public static Document getDocument() {
  36         return UntrustedXML.newDocumentBuilder().newDocument();
  37     }
  38
  39     private static Element createElementFor(final Document doc, final QName qname, final Object obj) {
  40         final Element ret;
  41         if (qname.getNamespace() != null) {
  42             ret = doc.createElementNS(qname.getNamespace().toString(), qname.getLocalName());
  43         } else {
  44             ret = doc.createElementNS(null, qname.getLocalName());
  45         }
  46
  47         if (obj instanceof AttributesContainer) {
  48             final Map<QName, String> attrs = ((AttributesContainer)obj).getAttributes();
  49
  50             if (attrs != null) {
  51                 for (Entry<QName, String> attribute : attrs.entrySet()) {
  52                     ret.setAttributeNS(attribute.getKey().getNamespace().toString(), attribute.getKey().getLocalName(),
  53                             attribute.getValue());
  54                 }
  55             }
  56         }
  57
  58         return ret;
  59     }
  60
  61     public static Element createElementFor(final Document doc, final NormalizedNode<?, ?> data) {
  62         return createElementFor(doc, data.getNodeType(), data);
  63     }
  64
  65     public static QName qNameFromElement(final Element xmlElement) {
  66         String namespace = xmlElement.getNamespaceURI();
  67         String localName = xmlElement.getLocalName();
  68         return QName.create(namespace != null ? URI.create(namespace) : null, null, localName);
  69     }
  70
  71     public static Optional<ModifyAction> getModifyOperationFromAttributes(final Element xmlElement) {
  72         Attr attributeNodeNS = xmlElement.getAttributeNodeNS(OPERATION_ATTRIBUTE_QNAME.getNamespace().toString(),
  73             OPERATION_ATTRIBUTE_QNAME.getLocalName());
  74         if (attributeNodeNS == null) {
  75             return Optional.absent();
  76         }
  77
  78         ModifyAction action = ModifyAction.fromXmlValue(attributeNodeNS.getValue());
  79         Preconditions.checkArgument(action.isOnElementPermitted(), "Unexpected operation %s on %s", action, xmlElement);
  80
  81         return Optional.of(action);
  82     }
  83
  84     public static Optional<DataSchemaNode> findFirstSchema(final QName qname,
  85             final Iterable<DataSchemaNode> dataSchemaNode) {
  86         if (dataSchemaNode != null && qname != null) {
  87             for (DataSchemaNode dsn : dataSchemaNode) {
  88                 if (qname.isEqualWithoutRevision(dsn.getQName())) {
  89                     return Optional.of(dsn);
  90                 } else if (dsn instanceof ChoiceSchemaNode) {
  91                     for (ChoiceCaseNode choiceCase : ((ChoiceSchemaNode) dsn).getCases()) {
  92                         Optional<DataSchemaNode> foundDsn = findFirstSchema(qname, choiceCase.getChildNodes());
  93                         if (foundDsn != null && foundDsn.isPresent()) {
  94                             return foundDsn;
  95                         }
  96                     }
  97                 }
  98             }
  99         }
 100         return Optional.absent();
 101     }
 102
 103     public static XmlCodecProvider defaultValueCodecProvider() {
 104         return XmlUtils.DEFAULT_XML_CODEC_PROVIDER;
 105     }
 106 }