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 com.google.common.annotations.Beta;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import com.google.common.base.Predicate;
14 import com.google.common.collect.Iterables;
15 import java.io.IOException;
16 import java.util.ArrayDeque;
17 import java.util.Deque;
18 import java.util.HashSet;
19 import org.opendaylight.yangtools.yang.common.QName;
20 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.AugmentationIdentifier;
21 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.NodeIdentifier;
22 import org.opendaylight.yangtools.yang.data.api.YangInstanceIdentifier.PathArgument;
23 import org.opendaylight.yangtools.yang.data.api.schema.stream.NormalizedNodeStreamWriter;
24 import org.opendaylight.yangtools.yang.data.impl.schema.SchemaUtils;
25 import org.opendaylight.yangtools.yang.model.api.AnyXmlSchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
27 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
28 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
29 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
30 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
31 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
32 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
33 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
34 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
35 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
36 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
37 import org.opendaylight.yangtools.yang.model.api.NotificationDefinition;
38 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
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.util.EffectiveAugmentationSchema;
43 import org.slf4j.Logger;
44 import org.slf4j.LoggerFactory;
47 * Utility class for tracking the underlying state of the underlying
51 public final class SchemaTracker {
52 private static final Logger LOG = LoggerFactory.getLogger(SchemaTracker.class);
53 private final Deque<Object> schemaStack = new ArrayDeque<>();
54 private final DataNodeContainer root;
56 private SchemaTracker(final SchemaContext context, final SchemaPath path) {
57 SchemaNode current = Preconditions.checkNotNull(context);
58 for (final QName qname : path.getPathFromRoot()) {
60 if(current instanceof DataNodeContainer) {
61 child = ((DataNodeContainer) current).getDataChildByName(qname);
63 if (child == null && current instanceof SchemaContext) {
64 child = tryFindGroupings((SchemaContext) current, qname).orNull();
67 if(child == null && current instanceof SchemaContext) {
68 child = tryFindNotification((SchemaContext) current, qname)
69 .or(tryFindRpc(((SchemaContext) current), qname)).orNull();
71 } else if (current instanceof ChoiceSchemaNode) {
72 child = ((ChoiceSchemaNode) current).getCaseNodeByName(qname);
73 } else if (current instanceof RpcDefinition) {
74 switch (qname.getLocalName()) {
76 child = ((RpcDefinition) current).getInput();
79 child = ((RpcDefinition) current).getOutput();
86 throw new IllegalArgumentException(String.format("Schema node %s does not allow children.", current));
90 Preconditions.checkArgument(current instanceof DataNodeContainer,"Schema path must point to container or list or an rpc input/output. Supplied path %s pointed to: %s",path,current);
91 root = (DataNodeContainer) current;
94 private static Optional<SchemaNode> tryFindGroupings(final SchemaContext ctx, final QName qname) {
95 return Optional.<SchemaNode> fromNullable(Iterables.find(ctx.getGroupings(), new SchemaNodePredicate(qname), null));
98 private static Optional<SchemaNode> tryFindRpc(final SchemaContext ctx, final QName qname) {
99 return Optional.<SchemaNode>fromNullable(Iterables.find(ctx.getOperations(), new SchemaNodePredicate(qname), null));
102 private static Optional<SchemaNode> tryFindNotification(final SchemaContext ctx, final QName qname) {
103 return Optional.<SchemaNode>fromNullable(Iterables.find(ctx.getNotifications(), new SchemaNodePredicate(qname), null));
107 * Create a new writer with the specified context as its root.
109 * @param context Associated {@link SchemaContext}.
110 * @return A new {@link NormalizedNodeStreamWriter}
112 public static SchemaTracker create(final SchemaContext context) {
113 return create(context, SchemaPath.ROOT);
117 * Create a new writer with the specified context and rooted in the specified schema path
119 * @param context Associated {@link SchemaContext}
120 * @param path schema path
122 * @return A new {@link NormalizedNodeStreamWriter}
124 public static SchemaTracker create(final SchemaContext context, final SchemaPath path) {
125 return new SchemaTracker(context, path);
128 public Object getParent() {
129 if (schemaStack.isEmpty()) {
132 return schemaStack.peek();
135 private SchemaNode getSchema(final PathArgument name) {
136 final Object parent = getParent();
137 SchemaNode schema = null;
138 final QName qname = name.getNodeType();
139 if(parent instanceof DataNodeContainer) {
140 schema = ((DataNodeContainer)parent).getDataChildByName(qname);
142 if(schema == null && parent instanceof GroupingDefinition) {
143 schema = ((GroupingDefinition) parent);
146 if(schema == null && parent instanceof NotificationDefinition) {
147 schema = ((NotificationDefinition) parent);
149 } else if(parent instanceof ChoiceSchemaNode) {
150 schema = findChildInCases((ChoiceSchemaNode) parent, qname);
152 throw new IllegalStateException("Unsupported schema type "+ parent.getClass() +" on stack.");
154 Preconditions.checkArgument(schema != null, "Could not find schema for node %s in %s", qname, parent);
158 private static SchemaNode findChildInCases(final ChoiceSchemaNode parent, final QName qname) {
159 DataSchemaNode schema = null;
160 for(final ChoiceCaseNode caze : parent.getCases()) {
161 final DataSchemaNode potential = caze.getDataChildByName(qname);
162 if(potential != null) {
170 private static SchemaNode findCaseByChild(final ChoiceSchemaNode parent, final QName qname) {
171 DataSchemaNode schema = null;
172 for(final ChoiceCaseNode caze : parent.getCases()) {
173 final DataSchemaNode potential = caze.getDataChildByName(qname);
174 if(potential != null) {
182 public void startList(final PathArgument name) {
183 final SchemaNode schema = getSchema(name);
184 Preconditions.checkArgument(schema instanceof ListSchemaNode, "Node %s is not a list", schema.getPath());
185 schemaStack.push(schema);
188 public void startListItem(final PathArgument name) throws IOException {
189 final Object schema = getParent();
190 Preconditions.checkArgument(schema instanceof ListSchemaNode, "List item is not appropriate");
191 schemaStack.push(schema);
194 public LeafSchemaNode leafNode(final NodeIdentifier name) throws IOException {
195 final SchemaNode schema = getSchema(name);
197 Preconditions.checkArgument(schema instanceof LeafSchemaNode, "Node %s is not a leaf", schema.getPath());
198 return (LeafSchemaNode) schema;
201 public LeafListSchemaNode startLeafSet(final NodeIdentifier name) {
202 final SchemaNode schema = getSchema(name);
204 Preconditions.checkArgument(schema instanceof LeafListSchemaNode, "Node %s is not a leaf-list", schema.getPath());
205 schemaStack.push(schema);
206 return (LeafListSchemaNode)schema;
209 public LeafListSchemaNode leafSetEntryNode() {
210 final Object parent = getParent();
212 Preconditions.checkArgument(parent instanceof LeafListSchemaNode, "Not currently in a leaf-list");
213 return (LeafListSchemaNode) parent;
216 public ChoiceSchemaNode startChoiceNode(final NodeIdentifier name) {
217 LOG.debug("Enter choice {}", name);
218 final SchemaNode schema = getSchema(name);
220 Preconditions.checkArgument(schema instanceof ChoiceSchemaNode, "Node %s is not a choice", schema.getPath());
221 schemaStack.push(schema);
222 return (ChoiceSchemaNode)schema;
225 public SchemaNode startContainerNode(final NodeIdentifier name) {
226 LOG.debug("Enter container {}", name);
227 final SchemaNode schema = getSchema(name);
229 boolean isAllowed = schema instanceof ContainerSchemaNode;
230 isAllowed |= schema instanceof NotificationDefinition;
232 Preconditions.checkArgument(isAllowed, "Node %s is not a container nor a notification", schema.getPath());
233 schemaStack.push(schema);
237 public AugmentationSchema startAugmentationNode(final AugmentationIdentifier identifier) {
238 LOG.debug("Enter augmentation {}", identifier);
239 Object parent = getParent();
241 Preconditions.checkArgument(parent instanceof AugmentationTarget, "Augmentation not allowed under %s", parent);
242 if(parent instanceof ChoiceSchemaNode) {
243 final QName name = Iterables.get(identifier.getPossibleChildNames(), 0);
244 parent = findCaseByChild((ChoiceSchemaNode) parent, name);
246 Preconditions.checkArgument(parent instanceof DataNodeContainer, "Augmentation allowed only in DataNodeContainer",parent);
247 final AugmentationSchema schema = SchemaUtils.findSchemaForAugment((AugmentationTarget) parent, identifier.getPossibleChildNames());
248 final HashSet<DataSchemaNode> realChildSchemas = new HashSet<>();
249 for(final DataSchemaNode child : schema.getChildNodes()) {
250 realChildSchemas.add(((DataNodeContainer) parent).getDataChildByName(child.getQName()));
252 final AugmentationSchema resolvedSchema = new EffectiveAugmentationSchema(schema, realChildSchemas);
253 schemaStack.push(resolvedSchema);
254 return resolvedSchema;
257 public AnyXmlSchemaNode anyxmlNode(final NodeIdentifier name) {
258 final SchemaNode schema = getSchema(name);
260 Preconditions.checkArgument(schema instanceof AnyXmlSchemaNode, "Node %s is not anyxml", schema.getPath());
261 return (AnyXmlSchemaNode)schema;
264 public Object endNode() {
265 return schemaStack.pop();
268 private static final class SchemaNodePredicate implements Predicate<SchemaNode> {
269 private final QName qname;
271 public SchemaNodePredicate(final QName qname) {
276 public boolean apply(final SchemaNode input) {
277 return input.getQName().equals(qname);