yang/yang-data-api/src/main/java/org/opendaylight/yangtools/yang/data/api/schema/NormalizedNodes.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.api.schema;
   9
  10 import static com.google.common.base.Preconditions.checkNotNull;
  11
  12 import com.google.common.annotations.Beta;
  13 import com.google.common.base.Optional;
  14 import com.google.common.base.Strings;
  15 import com.google.common.collect.Maps;
  16 import java.util.Arrays;
  17 import java.util.Iterator;
  18 import java.util.Map;
  19 import javax.annotation.Nonnull;
  20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  25
  26 /**
  27  * A set of utility methods for interacting with {@link NormalizedNode} objects.
  28  */
  29 @Beta
  30 public final class NormalizedNodes {
  31     private static final int STRINGTREE_INDENT = 4;
  32
  33     private NormalizedNodes() {
  34         throw new UnsupportedOperationException("Utility class should not be instantiated");
  35     }
  36
  37     public static Optional<NormalizedNode<?, ?>> findNode(final YangInstanceIdentifier rootPath,
  38             final NormalizedNode<?, ?> rootNode, final YangInstanceIdentifier childPath) {
  39         final Optional<YangInstanceIdentifier> relativePath = childPath.relativeTo(rootPath);
  40         return relativePath.isPresent() ? findNode(rootNode, relativePath.get()) : Optional.absent();
  41     }
  42
  43     public static Optional<NormalizedNode<?, ?>> findNode(final Optional<NormalizedNode<?, ?>> parent,
  44             final Iterable<PathArgument> relativePath) {
  45         checkNotNull(parent, "Parent must not be null");
  46         checkNotNull(relativePath, "Relative path must not be null");
  47
  48         Optional<NormalizedNode<?, ?>> currentNode = parent;
  49         final Iterator<PathArgument> pathIterator = relativePath.iterator();
  50         while (currentNode.isPresent() && pathIterator.hasNext()) {
  51             currentNode = getDirectChild(currentNode.get(), pathIterator.next());
  52         }
  53         return currentNode;
  54     }
  55
  56     public static Optional<NormalizedNode<?, ?>> findNode(final Optional<NormalizedNode<?, ?>> parent,
  57             final PathArgument... relativePath) {
  58         return findNode(parent, Arrays.asList(relativePath));
  59     }
  60
  61     public static Optional<NormalizedNode<?, ?>> findNode(final NormalizedNode<?, ?> parent,
  62             final Iterable<PathArgument> relativePath) {
  63         return findNode(Optional.fromNullable(parent), relativePath);
  64     }
  65
  66     public static Optional<NormalizedNode<?, ?>> findNode(final NormalizedNode<?, ?> parent,
  67             final PathArgument... relativePath) {
  68         return findNode(parent, Arrays.asList(relativePath));
  69     }
  70
  71     public static Optional<NormalizedNode<?, ?>> findNode(final NormalizedNode<?, ?> tree,
  72             final YangInstanceIdentifier path) {
  73         checkNotNull(tree, "Tree must not be null");
  74         checkNotNull(path, "Path must not be null");
  75
  76         return findNode(Optional.of(tree), path.getPathArguments());
  77     }
  78
  79     @SuppressWarnings({ "unchecked", "rawtypes" })
  80     public static Optional<NormalizedNode<?, ?>> getDirectChild(final NormalizedNode<?, ?> node,
  81             final PathArgument pathArg) {
  82         if (node instanceof LeafNode<?> || node instanceof LeafSetEntryNode<?>) {
  83             return Optional.absent();
  84         } else if (node instanceof DataContainerNode<?>) {
  85             return (Optional) ((DataContainerNode<?>) node).getChild(pathArg);
  86         } else if (node instanceof MapNode && pathArg instanceof NodeIdentifierWithPredicates) {
  87             return (Optional) ((MapNode) node).getChild((NodeIdentifierWithPredicates) pathArg);
  88         } else if (node instanceof LeafSetNode<?>) {
  89             return (Optional) ((LeafSetNode<?>) node).getChild((NodeWithValue) pathArg);
  90         }
  91         return Optional.absent();
  92     }
  93
  94     /**
  95      * Convert a data subtree under a node into a human-readable string format.
  96      *
  97      * @param node Data subtree root
  98      * @return String containing a human-readable form of the subtree.
  99      */
 100     public static String toStringTree(final NormalizedNode<?, ?> node) {
 101         final StringBuilder builder = new StringBuilder();
 102         toStringTree(builder, node, 0);
 103         return builder.toString();
 104     }
 105
 106     private static void toStringTree(final StringBuilder builder, final NormalizedNode<?, ?> node, final int offset) {
 107         final String prefix = Strings.repeat(" ", offset);
 108
 109         builder.append(prefix).append(toStringTree(node.getIdentifier()));
 110         if (node instanceof NormalizedNodeContainer<?, ?, ?>) {
 111             final NormalizedNodeContainer<?, ?, ?> container = (NormalizedNodeContainer<?, ?, ?>) node;
 112
 113             builder.append(" {\n");
 114             for (NormalizedNode<?, ?> child : container.getValue()) {
 115                 toStringTree(builder, child, offset + STRINGTREE_INDENT);
 116             }
 117
 118             builder.append(prefix).append('}');
 119         } else {
 120             builder.append(' ').append(node.getValue());
 121         }
 122         builder.append('\n');
 123     }
 124
 125     private static String toStringTree(final PathArgument identifier) {
 126         if (identifier instanceof NodeIdentifierWithPredicates) {
 127             return identifier.getNodeType().getLocalName()
 128                 + ((NodeIdentifierWithPredicates) identifier).getKeyValues().values();
 129         } else if (identifier instanceof AugmentationIdentifier) {
 130             return "augmentation";
 131         } else {
 132             return identifier.getNodeType().getLocalName();
 133         }
 134     }
 135
 136     /**
 137      * Find duplicate NormalizedNode instances within a subtree. Duplicates are those, which compare
 138      * as equal, but do not refer to the same object.
 139      *
 140      * @param node A normalized node subtree, may not be null
 141      * @return A Map of NormalizedNode/DuplicateEntry relationships.
 142      */
 143     public static Map<NormalizedNode<?, ?>, DuplicateEntry> findDuplicates(@Nonnull final NormalizedNode<?, ?> node) {
 144         return Maps.filterValues(DuplicateFinder.findDuplicates(node), input -> !input.getDuplicates().isEmpty());
 145     }
 146 }