2 * Copyright (c) 2014 Cisco Systems, Inc. and others. All rights reserved.
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
8 package org.opendaylight.yangtools.yang.data.impl.schema.tree;
10 import com.google.common.base.Preconditions;
11 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier;
12 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
13 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifierWithPredicates;
14 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
15 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNode;
16 import org.opendaylight.yangtools.yang.data.api.schema.NormalizedNodeContainer;
17 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeCandidate;
18 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeConfiguration;
19 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeFactory;
20 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataTreeModification;
21 import org.opendaylight.yangtools.yang.data.api.schema.tree.DataValidationFailedException;
22 import org.opendaylight.yangtools.yang.data.api.schema.tree.TipProducingDataTree;
23 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.TreeNodeFactory;
24 import org.opendaylight.yangtools.yang.data.api.schema.tree.spi.Version;
25 import org.opendaylight.yangtools.yang.data.impl.schema.ImmutableNodes;
26 import org.opendaylight.yangtools.yang.data.impl.schema.builder.impl.ImmutableContainerNodeBuilder;
27 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextNode;
28 import org.opendaylight.yangtools.yang.data.util.DataSchemaContextTree;
29 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
31 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
36 * A factory for creating in-memory data trees.
38 public final class InMemoryDataTreeFactory implements DataTreeFactory {
39 private static final InMemoryDataTreeFactory INSTANCE = new InMemoryDataTreeFactory();
40 private static final NormalizedNode<?, ?> ROOT_CONTAINER = ImmutableNodes.containerNode(SchemaContext.NAME);
42 private InMemoryDataTreeFactory() {
43 // Never instantiated externally
47 public TipProducingDataTree create(final DataTreeConfiguration treeConfig) {
48 return new InMemoryDataTree(TreeNodeFactory.createTreeNode(createRoot(treeConfig.getRootPath()),
49 Version.initial()), treeConfig, null);
53 public TipProducingDataTree create(final DataTreeConfiguration treeConfig,
54 final SchemaContext initialSchemaContext) {
55 return create(treeConfig, initialSchemaContext, true);
59 public TipProducingDataTree create(final DataTreeConfiguration treeConfig, final SchemaContext initialSchemaContext,
60 final NormalizedNodeContainer<?, ?, ?> initialRoot) throws DataValidationFailedException {
61 final TipProducingDataTree ret = create(treeConfig, initialSchemaContext, false);
63 final DataTreeModification mod = ret.takeSnapshot().newModification();
64 mod.write(YangInstanceIdentifier.EMPTY, initialRoot);
68 final DataTreeCandidate candidate = ret.prepare(mod);
69 ret.commit(candidate);
73 private static TipProducingDataTree create(final DataTreeConfiguration treeConfig,
74 final SchemaContext initialSchemaContext, final boolean maskMandatory) {
75 final DataSchemaNode rootSchemaNode = getRootSchemaNode(initialSchemaContext, treeConfig.getRootPath());
76 final NormalizedNode<?, ?> rootDataNode = createRoot((DataNodeContainer)rootSchemaNode,
77 treeConfig.getRootPath());
78 return new InMemoryDataTree(TreeNodeFactory.createTreeNode(rootDataNode, Version.initial()), treeConfig,
79 initialSchemaContext, rootSchemaNode, maskMandatory);
82 private static DataSchemaNode getRootSchemaNode(final SchemaContext schemaContext,
83 final YangInstanceIdentifier rootPath) {
84 final DataSchemaContextTree contextTree = DataSchemaContextTree.from(schemaContext);
85 final DataSchemaContextNode<?> rootContextNode = contextTree.getChild(rootPath);
86 Preconditions.checkArgument(rootContextNode != null, "Failed to find root %s in schema context", rootPath);
88 final DataSchemaNode rootSchemaNode = rootContextNode.getDataSchemaNode();
89 Preconditions.checkArgument(rootSchemaNode instanceof DataNodeContainer,
90 "Root %s resolves to non-container type %s", rootPath, rootSchemaNode);
91 return rootSchemaNode;
94 private static NormalizedNode<?, ?> createRoot(final DataNodeContainer schemaNode,
95 final YangInstanceIdentifier path) {
97 Preconditions.checkArgument(schemaNode instanceof ContainerSchemaNode,
98 "Conceptual tree root has to be a container, not %s", schemaNode);
99 return ROOT_CONTAINER;
102 final PathArgument arg = path.getLastPathArgument();
103 if (schemaNode instanceof ContainerSchemaNode) {
104 Preconditions.checkArgument(arg instanceof NodeIdentifier, "Mismatched container %s path %s", schemaNode,
106 return ImmutableContainerNodeBuilder.create().withNodeIdentifier((NodeIdentifier) arg).build();
107 } else if (schemaNode instanceof ListSchemaNode) {
108 // This can either be a top-level list or its individual entry
109 if (arg instanceof NodeIdentifierWithPredicates) {
110 return ImmutableNodes.mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) arg).build();
112 Preconditions.checkArgument(arg instanceof NodeIdentifier, "Mismatched list %s path %s", schemaNode, path);
113 return ImmutableNodes.mapNodeBuilder().withNodeIdentifier((NodeIdentifier) arg).build();
115 throw new IllegalArgumentException("Unsupported root schema " + schemaNode);
119 private static NormalizedNode<?, ?> createRoot(final YangInstanceIdentifier path) {
120 if (path.isEmpty()) {
121 return ROOT_CONTAINER;
124 final PathArgument arg = path.getLastPathArgument();
125 if (arg instanceof NodeIdentifier) {
126 return ImmutableContainerNodeBuilder.create().withNodeIdentifier((NodeIdentifier) arg).build();
128 if (arg instanceof NodeIdentifierWithPredicates) {
129 return ImmutableNodes.mapEntryBuilder().withNodeIdentifier((NodeIdentifierWithPredicates) arg).build();
132 // FIXME: implement augmentations and leaf-lists
133 throw new IllegalArgumentException("Unsupported root node " + arg);
137 * Get an instance of this factory. This method cannot fail.
139 * @return Data tree factory instance.
141 public static InMemoryDataTreeFactory getInstance() {