yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/codec/SchemaTracker.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.impl.codec;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11 import static java.util.Objects.requireNonNull;
  12
  13 import com.google.common.annotations.Beta;
  14 import com.google.common.collect.Iterables;
  15 import java.io.IOException;
  16 import java.util.ArrayDeque;
  17 import java.util.Collection;
  18 import java.util.Deque;
  19 import java.util.Optional;
  20 import org.eclipse.jdt.annotation.NonNull;
  21 import org.opendaylight.yangtools.odlext.model.api.YangModeledAnyXmlSchemaNode;
  22 import org.opendaylight.yangtools.yang.common.QName;
  23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
  24 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  25 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeWithValue;
  26 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  27 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
  28 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaUtils;
  29 import org.opendaylight.yangtools.yang.model.api.AnyDataSchemaNode;
  30 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
  31 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
  32 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
  33 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
  34 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  37 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  38 import org.opendaylight.yangtools.yang.model.api.DocumentedNode.WithStatus;
  39 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
  40 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
  41 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
  42 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  43 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
  44 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  45 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
  46 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
  47 import org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema;
  48 import org.slf4j.Logger;
  49 import org.slf4j.LoggerFactory;
  50
  51 /**
  52  * Utility class for tracking the underlying state of the underlying
  53  * schema node.
  54  */
  55 @Beta
  56 public final class SchemaTracker {
  57     private static final Logger LOG = LoggerFactory.getLogger(SchemaTracker.class);
  58     private final Deque<WithStatus> schemaStack = new ArrayDeque<>();
  59     private final DataNodeContainer root;
  60
  61     private SchemaTracker(final DataNodeContainer root) {
  62         this.root = requireNonNull(root);
  63     }
  64
  65     /**
  66      * Create a new writer with the specified node as its root.
  67      *
  68      * @param root Root node
  69      * @return A new {@link NormalizedNodeStreamWriter}
  70      */
  71     public static @NonNull SchemaTracker create(final DataNodeContainer root) {
  72         return new SchemaTracker(root);
  73     }
  74
  75     /**
  76      * Create a new writer with the specified context and rooted in the specified schema path.
  77      *
  78      * @param context Associated {@link SchemaContext}
  79      * @param path schema path
  80      * @return A new {@link NormalizedNodeStreamWriter}
  81      */
  82     public static @NonNull SchemaTracker create(final SchemaContext context, final SchemaPath path) {
  83         final Collection<SchemaNode> schemaNodes = SchemaUtils.findParentSchemaNodesOnPath(context, path);
  84         checkArgument(!schemaNodes.isEmpty(), "Unable to find schema node for supplied schema path: %s", path);
  85         if (schemaNodes.size() > 1) {
  86             LOG.warn("More possible schema nodes {} for supplied schema path {}", schemaNodes, path);
  87         }
  88         final Optional<DataNodeContainer> current = schemaNodes.stream()
  89                 .filter(node -> node instanceof DataNodeContainer).map(DataNodeContainer.class::cast)
  90                 .findFirst();
  91         checkArgument(current.isPresent(),
  92                 "Schema path must point to container or list or an rpc input/output. Supplied path %s pointed to: %s",
  93                 path, current);
  94         return new SchemaTracker(current.get());
  95     }
  96
  97     public Object getParent() {
  98         if (schemaStack.isEmpty()) {
  99             return root;
 100         }
 101         return schemaStack.peek();
 102     }
 103
 104     private SchemaNode getSchema(final PathArgument name) {
 105         final Object parent = getParent();
 106         SchemaNode schema = null;
 107         final QName qname = name.getNodeType();
 108         if (parent instanceof DataNodeContainer) {
 109             schema = ((DataNodeContainer)parent).getDataChildByName(qname);
 110             if (schema == null) {
 111                 if (parent instanceof GroupingDefinition) {
 112                     schema = (GroupingDefinition) parent;
 113                 } else if (parent instanceof NotificationDefinition) {
 114                     schema = (NotificationDefinition) parent;
 115                 }
 116             }
 117         } else if (parent instanceof ChoiceSchemaNode) {
 118             schema = findChildInCases((ChoiceSchemaNode) parent, qname);
 119         } else {
 120             throw new IllegalStateException("Unsupported schema type " + parent.getClass() + " on stack.");
 121         }
 122
 123         checkArgument(schema != null, "Could not find schema for node %s in %s", qname, parent);
 124         return schema;
 125     }
 126
 127     private static SchemaNode findChildInCases(final ChoiceSchemaNode parent, final QName qname) {
 128         for (final CaseSchemaNode caze : parent.getCases().values()) {
 129             final Optional<DataSchemaNode> potential = caze.findDataChildByName(qname);
 130             if (potential.isPresent()) {
 131                 return potential.get();
 132             }
 133         }
 134         return null;
 135     }
 136
 137     private static SchemaNode findCaseByChild(final ChoiceSchemaNode parent, final QName qname) {
 138         for (final CaseSchemaNode caze : parent.getCases().values()) {
 139             final Optional<DataSchemaNode> potential = caze.findDataChildByName(qname);
 140             if (potential.isPresent()) {
 141                 return caze;
 142             }
 143         }
 144         return null;
 145     }
 146
 147     public void startList(final PathArgument name) {
 148         final SchemaNode schema = getSchema(name);
 149         checkArgument(schema instanceof ListSchemaNode, "Node %s is not a list", schema.getPath());
 150         schemaStack.push(schema);
 151     }
 152
 153     public void startListItem(final PathArgument name) throws IOException {
 154         final Object schema = getParent();
 155         checkArgument(schema instanceof ListSchemaNode, "List item is not appropriate");
 156         schemaStack.push((ListSchemaNode) schema);
 157     }
 158
 159     public LeafSchemaNode leafNode(final NodeIdentifier name) throws IOException {
 160         final SchemaNode schema = getSchema(name);
 161
 162         checkArgument(schema instanceof LeafSchemaNode, "Node %s is not a leaf", schema.getPath());
 163         return (LeafSchemaNode) schema;
 164     }
 165
 166     public void startLeafNode(final NodeIdentifier name) throws IOException {
 167         schemaStack.push(leafNode(name));
 168     }
 169
 170     public LeafListSchemaNode startLeafSet(final NodeIdentifier name) {
 171         final SchemaNode schema = getSchema(name);
 172
 173         checkArgument(schema instanceof LeafListSchemaNode, "Node %s is not a leaf-list", schema.getPath());
 174         schemaStack.push(schema);
 175         return (LeafListSchemaNode)schema;
 176     }
 177
 178     public LeafListSchemaNode leafSetEntryNode(final QName qname) {
 179         final Object parent = getParent();
 180         if (parent instanceof LeafListSchemaNode) {
 181             return (LeafListSchemaNode) parent;
 182         }
 183
 184         final SchemaNode child = SchemaUtils.findDataChildSchemaByQName((SchemaNode) parent, qname);
 185         checkArgument(child instanceof LeafListSchemaNode,
 186             "Node %s is neither a leaf-list nor currently in a leaf-list", child.getPath());
 187         return (LeafListSchemaNode) child;
 188     }
 189
 190     public void startLeafSetEntryNode(final NodeWithValue<?> name) {
 191         schemaStack.push(leafSetEntryNode(name.getNodeType()));
 192     }
 193
 194     public ChoiceSchemaNode startChoiceNode(final NodeIdentifier name) {
 195         LOG.debug("Enter choice {}", name);
 196         final SchemaNode schema = getSchema(name);
 197
 198         checkArgument(schema instanceof ChoiceSchemaNode, "Node %s is not a choice", schema.getPath());
 199         schemaStack.push(schema);
 200         return (ChoiceSchemaNode)schema;
 201     }
 202
 203     public SchemaNode startContainerNode(final NodeIdentifier name) {
 204         LOG.debug("Enter container {}", name);
 205         final SchemaNode schema = getSchema(name);
 206
 207         boolean isAllowed = schema instanceof ContainerSchemaNode;
 208         isAllowed |= schema instanceof NotificationDefinition;
 209
 210         checkArgument(isAllowed, "Node %s is not a container nor a notification", schema.getPath());
 211         schemaStack.push(schema);
 212
 213         return schema;
 214     }
 215
 216     public SchemaNode startYangModeledAnyXmlNode(final NodeIdentifier name) {
 217         LOG.debug("Enter yang modeled anyXml {}", name);
 218         final SchemaNode schema = getSchema(name);
 219
 220         checkArgument(schema instanceof YangModeledAnyXmlSchemaNode, "Node %s is not an yang modeled anyXml.",
 221             schema.getPath());
 222
 223         schemaStack.push(((YangModeledAnyXmlSchemaNode) schema).getSchemaOfAnyXmlData());
 224
 225         return schema;
 226     }
 227
 228     public AugmentationSchemaNode startAugmentationNode(final AugmentationIdentifier identifier) {
 229         LOG.debug("Enter augmentation {}", identifier);
 230         Object parent = getParent();
 231
 232         checkArgument(parent instanceof AugmentationTarget, "Augmentation not allowed under %s", parent);
 233         if (parent instanceof ChoiceSchemaNode) {
 234             final QName name = Iterables.get(identifier.getPossibleChildNames(), 0);
 235             parent = findCaseByChild((ChoiceSchemaNode) parent, name);
 236         }
 237         checkArgument(parent instanceof DataNodeContainer, "Augmentation allowed only in DataNodeContainer", parent);
 238         final AugmentationSchemaNode schema = SchemaUtils.findSchemaForAugment((AugmentationTarget) parent,
 239             identifier.getPossibleChildNames());
 240         final AugmentationSchemaNode resolvedSchema = EffectiveAugmentationSchema.create(schema,
 241             (DataNodeContainer) parent);
 242         schemaStack.push(resolvedSchema);
 243         return resolvedSchema;
 244     }
 245
 246     public AnyXmlSchemaNode anyxmlNode(final NodeIdentifier name) {
 247         final SchemaNode schema = getSchema(name);
 248         checkArgument(schema instanceof AnyXmlSchemaNode, "Node %s is not anyxml", schema.getPath());
 249         return (AnyXmlSchemaNode)schema;
 250     }
 251
 252     public void startAnyxmlNode(final NodeIdentifier name) {
 253         schemaStack.push(anyxmlNode(name));
 254     }
 255
 256     public AnyDataSchemaNode anydataNode(final NodeIdentifier name) {
 257         final SchemaNode schema = getSchema(name);
 258         checkArgument(schema instanceof AnyDataSchemaNode, "Node %s is not anydata", schema.getPath());
 259         return (AnyDataSchemaNode)schema;
 260     }
 261
 262     public void startAnydataNode(final NodeIdentifier name) {
 263         schemaStack.push(anydataNode(name));
 264     }
 265
 266     public Object endNode() {
 267         return schemaStack.pop();
 268     }
 269 }