yang/yang-data-util/src/main/java/org/opendaylight/yangtools/yang/data/util/AbstractStringInstanceIdentifierCodec.java

   1 /*
   2  * Copyright (c) 2014 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.util;
   9
  10 import com.google.common.annotations.Beta;
  11 import com.google.common.base.Preconditions;
  12 import java.util.Map;
  13 import javax.annotation.Nonnull;
  14 import org.opendaylight.yangtools.yang.common.QName;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  18 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  19 import org.opendaylight.yangtools.yang.data.api.codec.InstanceIdentifierCodec;
  20 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  21
  22 /**
  23  * Abstract utility class for representations which encode {@link YangInstanceIdentifier} as a
  24  * prefix:name tuple. Typical uses are RESTCONF/JSON (module:name) and XML (prefix:name).
  25  */
  26 @Beta
  27 public abstract class AbstractStringInstanceIdentifierCodec extends AbstractNamespaceCodec
  28         implements InstanceIdentifierCodec<String> {
  29
  30     @Override
  31     public final String serialize(final YangInstanceIdentifier data) {
  32         StringBuilder sb = new StringBuilder();
  33         DataSchemaContextNode<?> current = getDataContextTree().getRoot();
  34         for (PathArgument arg : data.getPathArguments()) {
  35             current = current.getChild(arg);
  36             Preconditions.checkArgument(current != null,
  37                     "Invalid input %s: schema for argument %s (after %s) not found", data, arg, sb);
  38
  39             if (current.isMixin()) {
  40                 /*
  41                  * XML/YANG instance identifier does not have concept
  42                  * of augmentation identifier, or list as whole which
  43                  * identifies a mixin (same as the parent element),
  44                  * so we can safely ignore it if it is part of path
  45                  * (since child node) is identified in same fashion.
  46                  */
  47                 continue;
  48             }
  49
  50             sb.append('/');
  51             appendQName(sb, arg.getNodeType());
  52
  53             if (arg instanceof NodeIdentifierWithPredicates) {
  54                 for (Map.Entry<QName, Object> entry : ((NodeIdentifierWithPredicates) arg).getKeyValues().entrySet()) {
  55                     sb.append('[');
  56                     appendQName(sb, entry.getKey());
  57                     sb.append("='");
  58                     sb.append(String.valueOf(entry.getValue()));
  59                     sb.append("']");
  60                 }
  61             } else if (arg instanceof NodeWithValue) {
  62                 sb.append("[.='");
  63                 sb.append(((NodeWithValue<?>) arg).getValue());
  64                 sb.append("']");
  65             }
  66         }
  67         return sb.toString();
  68     }
  69
  70     /**
  71      * Returns DataSchemaContextTree associated with SchemaContext for which
  72      * serialization / deserialization occurs.
  73      *
  74      * <p>
  75      * Implementations MUST provide non-null Data Tree context, in order
  76      * for correct serialization / deserialization of PathArguments,
  77      * since XML representation does not have Augmentation arguments
  78      * and does not provide path arguments for cases.
  79      *
  80      * <p>
  81      * This effectively means same input XPath representation of Path Argument
  82      * may result in different YangInstanceIdentifiers if models are different
  83      * in uses of choices and cases.
  84      *
  85      * @return DataSchemaContextTree associated with SchemaContext for which
  86      *         serialization / deserialization occurs.
  87      */
  88     protected abstract @Nonnull DataSchemaContextTree getDataContextTree();
  89
  90     protected Object deserializeKeyValue(final DataSchemaNode schemaNode, final String value) {
  91         return value;
  92     }
  93
  94     @Override
  95     public final YangInstanceIdentifier deserialize(final String data) {
  96         Preconditions.checkNotNull(data, "Data may not be null");
  97         XpathStringParsingPathArgumentBuilder builder = new XpathStringParsingPathArgumentBuilder(this, data);
  98         return YangInstanceIdentifier.create(builder.build());
  99     }
 100
 101 }