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