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.codec;
10 import static com.google.common.base.Preconditions.checkArgument;
12 import com.google.common.annotations.Beta;
13 import com.google.common.collect.Iterables;
14 import java.io.IOException;
15 import java.util.ArrayDeque;
16 import java.util.Collection;
17 import java.util.Deque;
18 import java.util.HashSet;
19 import java.util.Optional;
20 import org.opendaylight.yangtools.yang.common.QName;
21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
23 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
24 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
25 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaUtils;
26 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
27 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
29 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
30 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
32 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
33 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
34 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
35 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
38 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
39 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
40 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
41 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
42 import org.opendaylight.yangtools.yang.model.api.YangModeledAnyXmlSchemaNode;
43 import org.opendaylight.yangtools.yang.model.util.EffectiveAugmentationSchema;
44 import org.slf4j.Logger;
45 import org.slf4j.LoggerFactory;
48 * Utility class for tracking the underlying state of the underlying
52 public final class SchemaTracker {
53 private static final Logger LOG = LoggerFactory.getLogger(SchemaTracker.class);
54 private final Deque<Object> schemaStack = new ArrayDeque<>();
55 private final DataNodeContainer root;
57 private SchemaTracker(final SchemaContext context, final SchemaPath path) {
58 final Collection<SchemaNode> schemaNodes = SchemaUtils.findParentSchemaNodesOnPath(context, path);
59 checkArgument(!schemaNodes.isEmpty(), "Unable to find schema node for supplied schema path: %s", path);
60 if (schemaNodes.size() > 1) {
61 LOG.warn("More possible schema nodes {} for supplied schema path {}", schemaNodes, path);
63 final Optional<SchemaNode> current = schemaNodes.stream().filter(node -> node instanceof DataNodeContainer)
65 checkArgument(current.isPresent(),
66 "Schema path must point to container or list or an rpc input/output. Supplied path %s pointed to: %s",
68 root = (DataNodeContainer) current.get();
72 * Create a new writer with the specified context as its root.
74 * @param context Associated {@link SchemaContext}.
75 * @return A new {@link NormalizedNodeStreamWriter}
77 public static SchemaTracker create(final SchemaContext context) {
78 return create(context, SchemaPath.ROOT);
82 * Create a new writer with the specified context and rooted in the specified schema path.
84 * @param context Associated {@link SchemaContext}
85 * @param path schema path
86 * @return A new {@link NormalizedNodeStreamWriter}
88 public static SchemaTracker create(final SchemaContext context, final SchemaPath path) {
89 return new SchemaTracker(context, path);
92 public Object getParent() {
93 if (schemaStack.isEmpty()) {
96 return schemaStack.peek();
99 private SchemaNode getSchema(final PathArgument name) {
100 final Object parent = getParent();
101 SchemaNode schema = null;
102 final QName qname = name.getNodeType();
103 if (parent instanceof DataNodeContainer) {
104 schema = ((DataNodeContainer)parent).getDataChildByName(qname);
105 if (schema == null) {
106 if (parent instanceof GroupingDefinition) {
107 schema = (GroupingDefinition) parent;
108 } else if (parent instanceof NotificationDefinition) {
109 schema = (NotificationDefinition) parent;
112 } else if (parent instanceof ChoiceSchemaNode) {
113 schema = findChildInCases((ChoiceSchemaNode) parent, qname);
115 throw new IllegalStateException("Unsupported schema type " + parent.getClass() + " on stack.");
118 checkArgument(schema != null, "Could not find schema for node %s in %s", qname, parent);
122 private static SchemaNode findChildInCases(final ChoiceSchemaNode parent, final QName qname) {
123 DataSchemaNode schema = null;
124 for (final ChoiceCaseNode caze : parent.getCases().values()) {
125 final DataSchemaNode potential = caze.getDataChildByName(qname);
126 if (potential != null) {
134 private static SchemaNode findCaseByChild(final ChoiceSchemaNode parent, final QName qname) {
135 DataSchemaNode schema = null;
136 for (final ChoiceCaseNode caze : parent.getCases().values()) {
137 final DataSchemaNode potential = caze.getDataChildByName(qname);
138 if (potential != null) {
146 public void startList(final PathArgument name) {
147 final SchemaNode schema = getSchema(name);
148 checkArgument(schema instanceof ListSchemaNode, "Node %s is not a list", schema.getPath());
149 schemaStack.push(schema);
152 public void startListItem(final PathArgument name) throws IOException {
153 final Object schema = getParent();
154 checkArgument(schema instanceof ListSchemaNode, "List item is not appropriate");
155 schemaStack.push(schema);
158 public LeafSchemaNode leafNode(final NodeIdentifier name) throws IOException {
159 final SchemaNode schema = getSchema(name);
161 checkArgument(schema instanceof LeafSchemaNode, "Node %s is not a leaf", schema.getPath());
162 return (LeafSchemaNode) schema;
165 public LeafListSchemaNode startLeafSet(final NodeIdentifier name) {
166 final SchemaNode schema = getSchema(name);
168 checkArgument(schema instanceof LeafListSchemaNode, "Node %s is not a leaf-list", schema.getPath());
169 schemaStack.push(schema);
170 return (LeafListSchemaNode)schema;
174 public LeafListSchemaNode leafSetEntryNode() {
175 final Object parent = getParent();
177 checkArgument(parent instanceof LeafListSchemaNode, "Not currently in a leaf-list");
178 return (LeafListSchemaNode) parent;
181 public LeafListSchemaNode leafSetEntryNode(final QName qname) {
182 final Object parent = getParent();
183 if (parent instanceof LeafListSchemaNode) {
184 return (LeafListSchemaNode) parent;
187 final SchemaNode child = SchemaUtils.findDataChildSchemaByQName((SchemaNode) parent, qname);
188 checkArgument(child instanceof LeafListSchemaNode,
189 "Node %s is neither a leaf-list nor currently in a leaf-list", child.getPath());
190 return (LeafListSchemaNode) child;
193 public ChoiceSchemaNode startChoiceNode(final NodeIdentifier name) {
194 LOG.debug("Enter choice {}", name);
195 final SchemaNode schema = getSchema(name);
197 checkArgument(schema instanceof ChoiceSchemaNode, "Node %s is not a choice", schema.getPath());
198 schemaStack.push(schema);
199 return (ChoiceSchemaNode)schema;
202 public SchemaNode startContainerNode(final NodeIdentifier name) {
203 LOG.debug("Enter container {}", name);
204 final SchemaNode schema = getSchema(name);
206 boolean isAllowed = schema instanceof ContainerSchemaNode;
207 isAllowed |= schema instanceof NotificationDefinition;
209 checkArgument(isAllowed, "Node %s is not a container nor a notification", schema.getPath());
210 schemaStack.push(schema);
215 public SchemaNode startYangModeledAnyXmlNode(final NodeIdentifier name) {
216 LOG.debug("Enter yang modeled anyXml {}", name);
217 final SchemaNode schema = getSchema(name);
219 checkArgument(schema instanceof YangModeledAnyXmlSchemaNode, "Node %s is not an yang modeled anyXml.",
222 schemaStack.push(((YangModeledAnyXmlSchemaNode) schema).getSchemaOfAnyXmlData());
227 public AugmentationSchemaNode startAugmentationNode(final AugmentationIdentifier identifier) {
228 LOG.debug("Enter augmentation {}", identifier);
229 Object parent = getParent();
231 checkArgument(parent instanceof AugmentationTarget, "Augmentation not allowed under %s", parent);
232 if (parent instanceof ChoiceSchemaNode) {
233 final QName name = Iterables.get(identifier.getPossibleChildNames(), 0);
234 parent = findCaseByChild((ChoiceSchemaNode) parent, name);
236 checkArgument(parent instanceof DataNodeContainer, "Augmentation allowed only in DataNodeContainer", parent);
237 final AugmentationSchemaNode schema = SchemaUtils.findSchemaForAugment((AugmentationTarget) parent,
238 identifier.getPossibleChildNames());
239 final HashSet<DataSchemaNode> realChildSchemas = new HashSet<>();
240 for (final DataSchemaNode child : schema.getChildNodes()) {
241 realChildSchemas.add(((DataNodeContainer) parent).getDataChildByName(child.getQName()));
243 final AugmentationSchemaNode resolvedSchema = new EffectiveAugmentationSchema(schema, realChildSchemas);
244 schemaStack.push(resolvedSchema);
245 return resolvedSchema;
248 public AnyXmlSchemaNode anyxmlNode(final NodeIdentifier name) {
249 final SchemaNode schema = getSchema(name);
250 checkArgument(schema instanceof AnyXmlSchemaNode, "Node %s is not anyxml", schema.getPath());
251 return (AnyXmlSchemaNode)schema;
254 public Object endNode() {
255 return schemaStack.pop();