2 * Copyright (c) 2014, 2015 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
9 package org.opendaylight.mdsal.binding.generator.impl;
11 import com.google.common.base.Optional;
12 import com.google.common.base.Preconditions;
13 import java.util.HashSet;
14 import java.util.Iterator;
16 import org.opendaylight.mdsal.binding.spec.naming.BindingMapping;
17 import org.opendaylight.mdsal.binding.spec.reflect.BindingReflections;
18 import org.opendaylight.yangtools.yang.binding.Augmentation;
19 import org.opendaylight.yangtools.yang.binding.ChildOf;
20 import org.opendaylight.yangtools.yang.binding.DataObject;
21 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier;
22 import org.opendaylight.yangtools.yang.binding.InstanceIdentifier.PathArgument;
23 import org.opendaylight.yangtools.yang.common.QName;
24 import org.opendaylight.yangtools.yang.common.QNameModule;
25 import org.opendaylight.yangtools.yang.model.api.AugmentationSchemaNode;
26 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget;
27 import org.opendaylight.yangtools.yang.model.api.CaseSchemaNode;
28 import org.opendaylight.yangtools.yang.model.api.ChoiceSchemaNode;
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.NotificationDefinition;
32 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
33 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
34 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
35 import org.opendaylight.yangtools.yang.model.util.SchemaNodeUtils;
37 public final class BindingSchemaContextUtils {
39 private BindingSchemaContextUtils() {
40 throw new UnsupportedOperationException("Utility class should not be instantiated");
43 // FIXME: THis method does not search in case augmentations.
44 public static Optional<DataNodeContainer> findDataNodeContainer(final SchemaContext ctx,
45 final InstanceIdentifier<?> path) {
46 Iterator<PathArgument> pathArguments = path.getPathArguments().iterator();
47 PathArgument currentArg = pathArguments.next();
48 Preconditions.checkArgument(currentArg != null);
49 QName currentQName = BindingReflections.findQName(currentArg.getType());
51 Optional<DataNodeContainer> currentContainer = Optional.absent();
52 if (BindingReflections.isNotification(currentArg.getType())) {
53 currentContainer = findNotification(ctx, currentQName);
54 } else if (BindingReflections.isRpcType(currentArg.getType())) {
55 currentContainer = findFirstDataNodeContainerInRpc(ctx, currentArg.getType());
56 if(currentQName == null && currentContainer.isPresent()) {
57 currentQName = ((DataSchemaNode) currentContainer.get()).getQName();
60 currentContainer = findDataNodeContainer(ctx, currentQName);
63 while (currentContainer.isPresent() && pathArguments.hasNext()) {
64 currentArg = pathArguments.next();
65 if (Augmentation.class.isAssignableFrom(currentArg.getType())) {
66 currentQName = BindingReflections.findQName(currentArg.getType());
67 if(pathArguments.hasNext()) {
68 currentArg = pathArguments.next();
70 return currentContainer;
73 if(ChildOf.class.isAssignableFrom(currentArg.getType()) && BindingReflections.isAugmentationChild(currentArg.getType())) {
74 currentQName = BindingReflections.findQName(currentArg.getType());
76 currentQName = BindingReflections.findQName(currentArg.getType()).withModule(currentQName.getModule());
78 Optional<DataNodeContainer> potential = findDataNodeContainer(currentContainer.get(), currentQName);
79 if (potential.isPresent()) {
80 currentContainer = potential;
82 return Optional.absent();
85 return currentContainer;
88 private static Optional<DataNodeContainer> findNotification(final SchemaContext ctx, final QName notificationQName) {
89 for (NotificationDefinition notification : ctx.getNotifications()) {
90 if (notification.getQName().equals(notificationQName)) {
91 return Optional.<DataNodeContainer> of(notification);
94 return Optional.absent();
97 private static Optional<DataNodeContainer> findDataNodeContainer(final DataNodeContainer ctx,
98 final QName targetQName) {
100 for (DataSchemaNode child : ctx.getChildNodes()) {
101 if (child instanceof ChoiceSchemaNode) {
102 DataNodeContainer potential = findInCases((ChoiceSchemaNode) child, targetQName);
103 if (potential != null) {
104 return Optional.of(potential);
106 } else if (child instanceof DataNodeContainer && child.getQName().equals(targetQName)) {
107 return Optional.of((DataNodeContainer) child);
108 } else if (child instanceof DataNodeContainer //
109 && child.isAddedByUses() //
110 && child.getQName().getLocalName().equals(targetQName.getLocalName())) {
111 return Optional.of((DataNodeContainer) child);
115 return Optional.absent();
118 private static DataNodeContainer findInCases(final ChoiceSchemaNode choiceNode, final QName targetQName) {
119 for (CaseSchemaNode caze : choiceNode.getCases().values()) {
120 Optional<DataNodeContainer> potential = findDataNodeContainer(caze, targetQName);
121 if (potential.isPresent()) {
122 return potential.get();
128 private static Optional<DataNodeContainer> findFirstDataNodeContainerInRpc(final SchemaContext ctx,
129 final Class<? extends DataObject> targetType) {
130 final QNameModule targetModule;
132 targetModule = BindingReflections.getModuleInfo(targetType).getName().getModule();
133 } catch (Exception e) {
134 throw new IllegalArgumentException(
135 String.format("Failed to load module information for class %s", targetType), e);
138 for (RpcDefinition rpc : ctx.getOperations()) {
139 if (targetModule.equals(rpc.getQName().getModule())) {
140 final Optional<DataNodeContainer> potential = findInputOutput(rpc,targetType.getSimpleName());
141 if (potential.isPresent()) {
146 return Optional.absent();
149 private static Optional<DataNodeContainer> findInputOutput(final RpcDefinition rpc, final String targetType) {
150 final String rpcName = BindingMapping.getClassName(rpc.getQName());
151 final String rpcInputName = rpcName + BindingMapping.RPC_INPUT_SUFFIX;
152 if (targetType.equals(rpcInputName)) {
153 return Optional.of(rpc.getInput());
155 final String rpcOutputName = rpcName + BindingMapping.RPC_OUTPUT_SUFFIX;
156 if (targetType.equals(rpcOutputName)) {
157 return Optional.of(rpc.getOutput());
159 return Optional.absent();
162 public static Set<AugmentationSchemaNode> collectAllAugmentationDefinitions(final SchemaContext currentSchema,
163 final AugmentationTarget ctxNode) {
164 HashSet<AugmentationSchemaNode> augmentations = new HashSet<>();
165 augmentations.addAll(ctxNode.getAvailableAugmentations());
166 if(ctxNode instanceof DataSchemaNode && ((DataSchemaNode) ctxNode).isAddedByUses()) {
168 System.out.println(ctxNode);
172 return augmentations;
175 public static Optional<ChoiceSchemaNode> findInstantiatedChoice(final DataNodeContainer parent,
176 final Class<?> choiceClass) {
177 return findInstantiatedChoice(parent, BindingReflections.findQName(choiceClass));
180 public static Optional<ChoiceSchemaNode> findInstantiatedChoice(final DataNodeContainer ctxNode,
181 final QName choiceName) {
182 DataSchemaNode potential = ctxNode.getDataChildByName(choiceName);
183 if (potential instanceof ChoiceSchemaNode) {
184 return Optional.of((ChoiceSchemaNode) potential);
187 return Optional.absent();
190 public static Optional<CaseSchemaNode> findInstantiatedCase(final ChoiceSchemaNode instantiatedChoice,
191 final CaseSchemaNode originalDefinition) {
192 CaseSchemaNode potential = instantiatedChoice.getCaseNodeByName(originalDefinition.getQName());
193 if(originalDefinition.equals(potential)) {
194 return Optional.of(potential);
196 if (potential != null) {
197 SchemaNode potentialRoot = SchemaNodeUtils.getRootOriginalIfPossible(potential);
198 if (originalDefinition.equals(potentialRoot)) {
199 return Optional.of(potential);
203 // We try to find case by name, then lookup its root definition
204 // and compare it with original definition
205 // This solves case, if choice was inside grouping
206 // which was used in different module and thus namespaces are
207 // different, but local names are still same.
209 // Still we need to check equality of definition, because local name is not
210 // sufficient to uniquelly determine equality of cases
212 for (CaseSchemaNode caze : instantiatedChoice.findCaseNodes(originalDefinition.getQName().getLocalName())) {
213 if (originalDefinition.equals(SchemaNodeUtils.getRootOriginalIfPossible(caze))) {
214 return Optional.of(caze);
217 return Optional.absent();