yang/yang-data-impl/src/main/java/org/opendaylight/yangtools/yang/data/impl/schema/tree/InMemoryDataTreeFactory.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.schema.tree;
   9
  10 import static com.google.common.base.Preconditions.checkArgument;
  11
  12 import java.util.Optional;
  13 import org.kohsuke.MetaInfServices;
  14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
  15 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
  16 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
  17 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
  18 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
  19 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
  20 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTree;
  21 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
  22 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
  23 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeFactory;
  24 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
  25 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
  26 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
  27 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
  28 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
  29 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
  30 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
  31 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
  32 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
  33 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
  34 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
  35 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
  36 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
  37
  38 /**
  39  * A factory for creating in-memory data trees.
  40  */
  41 @MetaInfServices
  42 public final class InMemoryDataTreeFactory implements DataTreeFactory {
  43     private static final NormalizedNode<?, ?> ROOT_CONTAINER = ImmutableNodes.containerNode(SchemaContext.NAME);
  44
  45     @Override
  46     public DataTree create(final DataTreeConfiguration treeConfig) {
  47         return new InMemoryDataTree(TreeNodeFactory.createTreeNode(createRoot(treeConfig.getRootPath()),
  48             Version.initial()), treeConfig, null);
  49     }
  50
  51     @Override
  52     public DataTree create(final DataTreeConfiguration treeConfig, final SchemaContext initialSchemaContext) {
  53         return create(treeConfig, initialSchemaContext, true);
  54     }
  55
  56     @Override
  57     public DataTree create(final DataTreeConfiguration treeConfig, final SchemaContext initialSchemaContext,
  58             final NormalizedNodeContainer<?, ?, ?> initialRoot) throws DataValidationFailedException {
  59         final DataTree ret = create(treeConfig, initialSchemaContext, false);
  60
  61         final DataTreeModification mod = ret.takeSnapshot().newModification();
  62         mod.write(YangInstanceIdentifier.empty(), initialRoot);
  63         mod.ready();
  64
  65         ret.validate(mod);
  66         final DataTreeCandidate candidate = ret.prepare(mod);
  67         ret.commit(candidate);
  68         return ret;
  69     }
  70
  71     private static DataTree create(final DataTreeConfiguration treeConfig, final SchemaContext initialSchemaContext,
  72             final boolean maskMandatory) {
  73         final DataSchemaNode rootSchemaNode = getRootSchemaNode(initialSchemaContext, treeConfig.getRootPath());
  74         final NormalizedNode<?, ?> rootDataNode = createRoot((DataNodeContainer)rootSchemaNode,
  75             treeConfig.getRootPath());
  76         return new InMemoryDataTree(TreeNodeFactory.createTreeNode(rootDataNode, Version.initial()), treeConfig,
  77             initialSchemaContext, rootSchemaNode, maskMandatory);
  78     }
  79
  80     private static DataSchemaNode getRootSchemaNode(final SchemaContext schemaContext,
  81             final YangInstanceIdentifier rootPath) {
  82         final DataSchemaContextTree contextTree = DataSchemaContextTree.from(schemaContext);
  83         final Optional<DataSchemaContextNode<?>> rootContextNode = contextTree.findChild(rootPath);
  84         checkArgument(rootContextNode.isPresent(), "Failed to find root %s in schema context", rootPath);
  85
  86         final DataSchemaNode rootSchemaNode = rootContextNode.get().getDataSchemaNode();
  87         checkArgument(rootSchemaNode instanceof DataNodeContainer, "Root %s resolves to non-container type %s",
  88             rootPath, rootSchemaNode);
  89         return rootSchemaNode;
  90     }
  91
  92     private static NormalizedNode<?, ?> createRoot(final DataNodeContainer schemaNode,
  93             final YangInstanceIdentifier path) {
  94         if (path.isEmpty()) {
  95             checkArgument(schemaNode instanceof ContainerSchemaNode,
  96                 "Conceptual tree root has to be a container, not %s", schemaNode);
  97             return ROOT_CONTAINER;
  98         }
  99
 100         final PathArgument arg = path.getLastPathArgument();
 101         if (schemaNode instanceof ContainerSchemaNode) {
 102             checkArgument(arg instanceof NodeIdentifier, "Mismatched container %s path %s", schemaNode, path);
 103             return ImmutableContainerNodeBuilder.create().withNodeIdentifier((NodeIdentifier) arg).build();
 104         } else if (schemaNode instanceof ListSchemaNode) {
 105             // This can either be a top-level list or its individual entry
 106             if (arg instanceof NodeIdentifierWithPredicates) {
 107                 return ImmutableNodes.mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) arg).build();
 108             }
 109             checkArgument(arg instanceof NodeIdentifier, "Mismatched list %s path %s", schemaNode, path);
 110             return ImmutableNodes.mapNodeBuilder().withNodeIdentifier((NodeIdentifier) arg).build();
 111         } else {
 112             throw new IllegalArgumentException("Unsupported root schema " + schemaNode);
 113         }
 114     }
 115
 116     private static NormalizedNode<?, ?> createRoot(final YangInstanceIdentifier path) {
 117         if (path.isEmpty()) {
 118             return ROOT_CONTAINER;
 119         }
 120
 121         final PathArgument arg = path.getLastPathArgument();
 122         if (arg instanceof NodeIdentifier) {
 123             return ImmutableContainerNodeBuilder.create().withNodeIdentifier((NodeIdentifier) arg).build();
 124         }
 125         if (arg instanceof NodeIdentifierWithPredicates) {
 126             return ImmutableNodes.mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) arg).build();
 127         }
 128
 129         // FIXME: implement augmentations and leaf-lists
 130         throw new IllegalArgumentException("Unsupported root node " + arg);
 131     }
 132 }