2 * Copyright (c) 2013 Cisco Systems, Inc. and others. All rights reserved.
\r
4 * This program and the accompanying materials are made available under the
\r
5 * terms of the Eclipse Public License v1.0 which accompanies this distribution,
\r
6 * and is available at http://www.eclipse.org/legal/epl-v10.html
\r
8 package org.opendaylight.yangtools.sal.binding.generator.impl;
\r
10 import java.util.ArrayList;
\r
11 import java.util.Collections;
\r
12 import java.util.HashMap;
\r
13 import java.util.List;
\r
14 import java.util.Map;
\r
15 import java.util.Set;
\r
16 import org.opendaylight.yangtools.binding.generator.util.BindingTypes;
\r
17 import org.opendaylight.yangtools.binding.generator.util.ReferencedTypeImpl;
\r
18 import org.opendaylight.yangtools.binding.generator.util.Types;
\r
19 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTOBuilderImpl;
\r
20 import org.opendaylight.yangtools.binding.generator.util.generated.type.builder.GeneratedTypeBuilderImpl;
\r
21 import org.opendaylight.yangtools.sal.binding.generator.api.BindingGenerator;
\r
22 import org.opendaylight.yangtools.sal.binding.generator.spi.TypeProvider;
\r
23 import org.opendaylight.yangtools.sal.binding.model.api.AccessModifier;
\r
24 import org.opendaylight.yangtools.sal.binding.model.api.GeneratedType;
\r
25 import org.opendaylight.yangtools.sal.binding.model.api.Type;
\r
26 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.EnumBuilder;
\r
27 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTOBuilder;
\r
28 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.GeneratedTypeBuilder;
\r
29 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.MethodSignatureBuilder;
\r
30 import org.opendaylight.yangtools.sal.binding.yang.types.GroupingDefinitionDependencySort;
\r
31 import org.opendaylight.yangtools.sal.binding.yang.types.TypeProviderImpl;
\r
32 import org.opendaylight.yangtools.yang.binding.RpcService;
\r
33 import org.opendaylight.yangtools.yang.common.RpcResult;
\r
34 import org.opendaylight.yangtools.yang.model.api.AugmentationSchema;
\r
35 import org.opendaylight.yangtools.yang.model.api.ChoiceCaseNode;
\r
36 import org.opendaylight.yangtools.yang.model.api.ChoiceNode;
\r
37 import org.opendaylight.yangtools.yang.model.api.ContainerSchemaNode;
\r
38 import org.opendaylight.yangtools.yang.model.api.DataNodeContainer;
\r
39 import org.opendaylight.yangtools.yang.model.api.DataSchemaNode;
\r
40 import org.opendaylight.yangtools.yang.model.api.GroupingDefinition;
\r
41 import org.opendaylight.yangtools.yang.model.api.IdentitySchemaNode;
\r
42 import org.opendaylight.yangtools.yang.model.api.LeafListSchemaNode;
\r
43 import org.opendaylight.yangtools.yang.model.api.LeafSchemaNode;
\r
44 import org.opendaylight.yangtools.yang.model.api.ListSchemaNode;
\r
45 import org.opendaylight.yangtools.yang.model.api.Module;
\r
46 import org.opendaylight.yangtools.yang.model.api.RpcDefinition;
\r
47 import org.opendaylight.yangtools.yang.model.api.SchemaContext;
\r
48 import org.opendaylight.yangtools.yang.model.api.SchemaNode;
\r
49 import org.opendaylight.yangtools.yang.model.api.SchemaPath;
\r
50 import org.opendaylight.yangtools.yang.model.api.TypeDefinition;
\r
51 import org.opendaylight.yangtools.yang.model.api.UnknownSchemaNode;
\r
52 import org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition;
\r
53 import org.opendaylight.yangtools.yang.model.api.type.EnumTypeDefinition;
\r
54 import org.opendaylight.yangtools.yang.model.api.type.UnionTypeDefinition;
\r
55 import org.opendaylight.yangtools.yang.model.util.DataNodeIterator;
\r
56 import org.opendaylight.yangtools.yang.model.util.SchemaContextUtil;
\r
57 import org.opendaylight.yangtools.yang.model.util.UnionType;
\r
58 import static com.google.common.base.Preconditions.*;
\r
59 import static extension org.opendaylight.yangtools.binding.generator.util.Types.*;
\r
60 import static org.opendaylight.yangtools.binding.generator.util.BindingGeneratorUtil.*;
\r
61 import static org.opendaylight.yangtools.binding.generator.util.BindingTypes.*;
\r
62 import static org.opendaylight.yangtools.yang.model.util.SchemaContextUtil.*;
\r
63 import org.opendaylight.yangtools.yang.parser.util.ModuleDependencySort
\r
64 import org.opendaylight.yangtools.yang.model.util.ExtendedType;
\r
65 import org.opendaylight.yangtools.yang.model.api.UsesNode
\r
66 import org.opendaylight.yangtools.yang.binding.annotations.RoutingContext
\r
67 import org.opendaylight.yangtools.sal.binding.model.api.type.builder.AnnotationTypeBuilder
\r
68 import org.opendaylight.yangtools.yang.model.api.ModuleImport
\r
69 import org.opendaylight.yangtools.yang.binding.DataContainer
\rimport java.util.Iterator
70 import org.opendaylight.yangtools.yang.model.api.AugmentationTarget
71 import java.util.Collection
72 import org.opendaylight.yangtools.yang.model.api.YangNode
74 public class BindingGeneratorImpl implements BindingGenerator {
\r
76 * Outter key represents the package name. Outter value represents map of
\r
77 * all builders in the same package. Inner key represents the schema node
\r
78 * name (in JAVA class/interface name format). Inner value represents
\r
79 * instance of builder for schema node specified in key part.
\r
81 private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
\r
84 * Provide methods for converting YANG types to JAVA types.
\r
86 private var TypeProvider typeProvider;
\r
89 * Holds reference to schema context to resolve data of augmented elemnt
\r
90 * when creating augmentation builder
\r
92 private var SchemaContext schemaContext;
\r
95 * Each grouping which is converted from schema node to generated type is
\r
96 * added to this map with its Schema path as key to make it easier to get
\r
97 * reference to it. In schema nodes in <code>uses</code> attribute there is
\r
98 * only Schema Path but when building list of implemented interfaces for
\r
99 * Schema node the object of type <code>Type</code> is required. So in this
\r
100 * case is used this map.
\r
102 private val allGroupings = new HashMap<SchemaPath, GeneratedType>();
\r
104 private val yangToJavaMapping = new HashMap<SchemaPath, Type>();
\r
107 * Constant with the concrete name of namespace.
\r
109 private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
\r
112 * Constant with the concrete name of identifier.
\r
114 private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
\r
117 * Resolves generated types from <code>context</code> schema nodes of all
\r
120 * Generated types are created for modules, groupings, types, containers,
\r
121 * lists, choices, augments, rpcs, notification, identities.
\r
124 * schema context which contains data about all schema nodes
\r
126 * @return list of types (usually <code>GeneratedType</code>
\r
127 * <code>GeneratedTransferObject</code>which are generated from
\r
128 * <code>context</code> data.
\r
129 * @throws IllegalArgumentException
\r
130 * if param <code>context</code> is null
\r
131 * @throws IllegalStateException
\r
132 * if <code>context</code> contain no modules
\r
134 override generateTypes(SchemaContext context) {
\r
135 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
\r
136 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
\r
137 schemaContext = context;
\r
138 typeProvider = new TypeProviderImpl(context);
\r
139 val Set<Module> modules = context.modules;
\r
140 return generateTypes(context, modules);
\r
144 * Resolves generated types from <code>context</code> schema nodes only for
\r
145 * modules specified in <code>modules</code>
\r
147 * Generated types are created for modules, groupings, types, containers,
\r
148 * lists, choices, augments, rpcs, notification, identities.
\r
151 * schema context which contains data about all schema nodes
\r
154 * set of modules for which schema nodes should be generated
\r
156 * @return list of types (usually <code>GeneratedType</code> or
\r
157 * <code>GeneratedTransferObject</code>) which:
\r
159 * <li>are generated from <code>context</code> schema nodes and</li>
\r
160 * <li>are also part of some of the module in <code>modules</code>
\r
163 * @throws IllegalArgumentException
\r
165 * <li>if param <code>context</code> is null or</li>
\r
166 * <li>if param <code>modules</code> is null</li>
\r
168 * @throws IllegalStateException
\r
169 * if <code>context</code> contain no modules
\r
171 override generateTypes(SchemaContext context, Set<Module> modules) {
\r
172 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
\r
173 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
\r
174 checkArgument(modules !== null, "Set of Modules cannot be NULL.");
\r
176 val List<Type> filteredGenTypes = new ArrayList();
\r
178 schemaContext = context;
\r
179 typeProvider = new TypeProviderImpl(context);
\r
180 val contextModules = ModuleDependencySort.sort(context.modules);
\r
181 genTypeBuilders = new HashMap();
\r
183 for (contextModule : contextModules) {
\r
184 val List<Type> generatedTypes = new ArrayList();
\r
185 generatedTypes.addAll(allTypeDefinitionsToGenTypes(contextModule));
\r
186 generatedTypes.addAll(allGroupingsToGenTypes(contextModule));
\r
187 if(false == contextModule.childNodes.isEmpty()) {
\r
188 generatedTypes.add(moduleToDataType(contextModule));
\r
190 generatedTypes.addAll(allContainersToGenTypes(contextModule));
\r
191 generatedTypes.addAll(allListsToGenTypes(contextModule));
\r
192 generatedTypes.addAll(allChoicesToGenTypes(contextModule));
\r
193 generatedTypes.addAll(allRPCMethodsToGenType(contextModule));
\r
194 generatedTypes.addAll(allNotificationsToGenType(contextModule));
\r
195 generatedTypes.addAll(allIdentitiesToGenTypes(contextModule, context));
\r
197 if(modules.contains(contextModule)) {
\r
198 filteredGenTypes.addAll(generatedTypes);
\r
201 for (contextModule : contextModules) {
\r
202 val generatedTypes = (allAugmentsToGenTypes(contextModule));
\r
203 if(modules.contains(contextModule)) {
\r
204 filteredGenTypes.addAll(generatedTypes);
\r
208 return filteredGenTypes;
\r
212 * Converts all extended type definitions of module to the list of
\r
213 * <code>Type</code> objects.
\r
216 * module from which is obtained set of type definitions
\r
217 * @return list of <code>Type</code> which are generated from extended
\r
218 * definition types (object of type <code>ExtendedType</code>)
\r
219 * @throws IllegalArgumentException
\r
221 * <li>if module equals null</li>
\r
222 * <li>if name of module equals null</li>
\r
223 * <li>if type definitions of module equal null</li>
\r
227 private def List<Type> allTypeDefinitionsToGenTypes(Module module) {
\r
228 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
229 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
230 val it = new DataNodeIterator(module);
\r
231 val List<TypeDefinition<?>> typeDefinitions = it.allTypedefs;
\r
232 checkState(typeDefinitions !== null, '''Type Definitions for module «module.name» cannot be NULL.''');
\r
234 val List<Type> generatedTypes = new ArrayList();
\r
235 for (TypeDefinition<?> typedef : typeDefinitions) {
\r
236 if(typedef !== null) {
\r
237 val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);
\r
238 if((type !== null) && !generatedTypes.contains(type)) {
\r
239 generatedTypes.add(type);
\r
243 return generatedTypes;
\r
246 private def List<Type> dataNodeContainerToGenType(String basePackageName, DataNodeContainer node, Module module) {
\r
247 if (node === null) {
\r
250 if (!(node instanceof SchemaNode)) {
\r
251 throw new IllegalArgumentException("node to generate must be instance of SchemaNode");
\r
253 val List<Type> result = new ArrayList();
\r
255 result.addAll(processUsesAugments(node, module));
\r
257 val packageName = packageNameForGeneratedType(basePackageName, (node as SchemaNode).path);
\r
258 val typeBuilder = addDefaultInterfaceDefinition(packageName, node as SchemaNode);
\r
259 val schemaNodes = node.childNodes;
\r
260 if (node instanceof ContainerSchemaNode) {
\r
261 resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);
\r
262 result.add(typeBuilder.toInstance());
\r
263 } else if (node instanceof ListSchemaNode) {
\r
264 val List<String> listKeys = listKeys(node as ListSchemaNode);
\r
265 val genTOBuilder = resolveListKeyTOBuilder(packageName, node as ListSchemaNode);
\r
267 if(genTOBuilder !== null) {
\r
268 val identifierMarker = IDENTIFIER.parameterizedTypeFor(typeBuilder);
\r
269 val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);
\r
270 genTOBuilder.addImplementsType(identifierMarker);
\r
271 typeBuilder.addImplementsType(identifiableMarker);
\r
273 for (schemaNode : schemaNodes) {
\r
274 if (!schemaNode.isAugmenting()) {
\r
275 addSchemaNodeToListBuilders(basePackageName, schemaNode, typeBuilder, genTOBuilder, listKeys);
\r
278 result.addAll(typeBuildersToGenTypes(typeBuilder, genTOBuilder));
\r
284 private def List<Type> processUsesAugments(DataNodeContainer node, Module module) {
\r
285 val List<Type> result = new ArrayList();
\r
286 val basePackageName = moduleNamespaceToPackageName(module);
\r
288 for (usesNode : node.uses) {
\r
289 for (augment : usesNode.augmentations) {
\r
290 result.addAll(augmentationToGenTypes(basePackageName, augment, module, usesNode));
\r
291 result.addAll(processUsesAugments(augment, module));
\r
299 * Converts all <b>containers</b> of the module to the list of
\r
300 * <code>Type</code> objects.
\r
303 * module from which is obtained DataNodeIterator to iterate over
\r
305 * @return list of <code>Type</code> which are generated from containers
\r
306 * (objects of type <code>ContainerSchemaNode</code>)
\r
307 * @throws IllegalArgumentException
\r
309 * <li>if the module equals null</li>
\r
310 * <li>if the name of module equals null</li>
\r
311 * <li>if the set of child nodes equals null</li>
\r
315 private def List<Type> allContainersToGenTypes(Module module) {
\r
316 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
318 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
320 if(module.childNodes === null) {
\r
321 throw new IllegalArgumentException(
\r
322 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");
\r
325 val List<Type> generatedTypes = new ArrayList();
\r
326 val it = new DataNodeIterator(module);
\r
327 val List<ContainerSchemaNode> schemaContainers = it.allContainers();
\r
328 val basePackageName = moduleNamespaceToPackageName(module);
\r
329 for (container : schemaContainers) {
\r
330 if(!container.isAddedByUses()) {
\r
331 generatedTypes.addAll(dataNodeContainerToGenType(basePackageName, container, module));
\r
334 return generatedTypes;
\r
338 * Converts all <b>lists</b> of the module to the list of <code>Type</code>
\r
342 * module from which is obtained DataNodeIterator to iterate over
\r
344 * @return list of <code>Type</code> which are generated from lists (objects
\r
345 * of type <code>ListSchemaNode</code>)
\r
346 * @throws IllegalArgumentException
\r
348 * <li>if the module equals null</li>
\r
349 * <li>if the name of module equals null</li>
\r
350 * <li>if the set of child nodes equals null</li>
\r
354 private def List<Type> allListsToGenTypes(Module module) {
\r
355 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
356 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
358 if(module.childNodes === null) {
\r
359 throw new IllegalArgumentException(
\r
360 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");
\r
363 val List<Type> generatedTypes = new ArrayList();
\r
364 val it = new DataNodeIterator(module);
\r
365 val List<ListSchemaNode> schemaLists = it.allLists();
\r
366 val basePackageName = moduleNamespaceToPackageName(module);
\r
367 if(schemaLists !== null) {
\r
368 for (list : schemaLists) {
\r
369 if(!list.isAddedByUses()) {
\r
370 generatedTypes.addAll(dataNodeContainerToGenType(basePackageName, list, module));
\r
374 return generatedTypes;
\r
378 * Converts all <b>choices</b> of the module to the list of
\r
379 * <code>Type</code> objects.
\r
382 * module from which is obtained DataNodeIterator to iterate over
\r
384 * @return list of <code>Type</code> which are generated from choices
\r
385 * (objects of type <code>ChoiceNode</code>)
\r
386 * @throws IllegalArgumentException
\r
388 * <li>if the module equals null</li>
\r
389 * <li>if the name of module equals null</li> *
\r
393 private def List<Type> allChoicesToGenTypes(Module module) {
\r
394 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
395 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
397 val it = new DataNodeIterator(module);
\r
398 val choiceNodes = it.allChoices();
\r
399 val basePackageName = moduleNamespaceToPackageName(module);
\r
401 val List<Type> generatedTypes = new ArrayList();
\r
402 for (choice : choiceNodes) {
\r
403 if((choice !== null) && !choice.isAddedByUses()) {
\r
404 generatedTypes.addAll(choiceToGeneratedType(basePackageName, choice, module));
\r
407 return generatedTypes;
\r
411 * Converts all <b>augmentation</b> of the module to the list
\r
412 * <code>Type</code> objects.
\r
415 * module from which is obtained list of all augmentation objects
\r
416 * to iterate over them
\r
417 * @return list of <code>Type</code> which are generated from augments
\r
418 * (objects of type <code>AugmentationSchema</code>)
\r
419 * @throws IllegalArgumentException
\r
421 * <li>if the module equals null</li>
\r
422 * <li>if the name of module equals null</li>
\r
423 * <li>if the set of child nodes equals null</li>
\r
427 private def List<Type> allAugmentsToGenTypes(Module module) {
\r
428 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
429 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
430 if(module.childNodes === null) {
\r
431 throw new IllegalArgumentException(
\r
432 "Reference to Set of Augmentation Definitions in module " + module.name + " cannot be NULL.");
\r
435 val List<Type> generatedTypes = new ArrayList();
\r
436 val basePackageName = moduleNamespaceToPackageName(module);
\r
437 val List<AugmentationSchema> augmentations = resolveAugmentations(module);
\r
438 for (augment : augmentations) {
\r
439 generatedTypes.addAll(augmentationToGenTypes(basePackageName, augment, module, null));
\r
441 return generatedTypes;
\r
445 * Returns list of <code>AugmentationSchema</code> objects. The objects are
\r
446 * sorted according to the length of their target path from the shortest to
\r
450 * module from which is obtained list of all augmentation objects
\r
451 * @return list of sorted <code>AugmentationSchema</code> objects obtained
\r
452 * from <code>module</code>
\r
453 * @throws IllegalArgumentException
\r
455 * <li>if the module equals null</li>
\r
456 * <li>if the set of augmentation equals null</li>
\r
460 private def List<AugmentationSchema> resolveAugmentations(Module module) {
\r
461 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
462 checkState(module.augmentations !== null, "Augmentations Set cannot be NULL.");
\r
464 val Set<AugmentationSchema> augmentations = module.augmentations;
\r
465 val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);
\r
466 Collections.sort(sortedAugmentations,
\r
467 [ augSchema1, augSchema2 |
\r
468 if(augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {
\r
470 } else if(augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {
\r
475 return sortedAugmentations;
\r
479 * Converts whole <b>module</b> to <code>GeneratedType</code> object.
\r
480 * Firstly is created the module builder object from which is vally
\r
481 * obtained reference to <code>GeneratedType</code> object.
\r
484 * module from which are obtained the module name, child nodes,
\r
485 * uses and is derived package name
\r
486 * @return <code>GeneratedType</code> which is internal representation of
\r
488 * @throws IllegalArgumentException
\r
489 * if the module equals null
\r
492 private def GeneratedType moduleToDataType(Module module) {
\r
493 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
495 val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
\r
496 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
\r
497 moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
\r
499 val basePackageName = moduleNamespaceToPackageName(module);
\r
500 if(moduleDataTypeBuilder !== null) {
\r
501 val Set<DataSchemaNode> dataNodes = module.childNodes;
\r
502 resolveDataSchemaNodes(basePackageName, moduleDataTypeBuilder, dataNodes);
\r
504 return moduleDataTypeBuilder.toInstance();
\r
508 * Converts all <b>rpcs</b> inputs and outputs substatements of the module
\r
509 * to the list of <code>Type</code> objects. In addition are to containers
\r
510 * and lists which belong to input or output also part of returning list.
\r
513 * module from which is obtained set of all rpc objects to
\r
514 * iterate over them
\r
515 * @return list of <code>Type</code> which are generated from rpcs inputs,
\r
516 * outputs + container and lists which are part of inputs or outputs
\r
517 * @throws IllegalArgumentException
\r
519 * <li>if the module equals null</li>
\r
520 * <li>if the name of module equals null</li>
\r
521 * <li>if the set of child nodes equals null</li>
\r
525 private def List<Type> allRPCMethodsToGenType(Module module) {
\r
526 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
528 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
530 if(module.childNodes === null) {
\r
531 throw new IllegalArgumentException(
\r
532 "Reference to Set of RPC Method Definitions in module " + module.name + " cannot be NULL.");
\r
535 val basePackageName = moduleNamespaceToPackageName(module);
\r
536 val Set<RpcDefinition> rpcDefinitions = module.rpcs;
\r
538 if(rpcDefinitions.isEmpty()) {
\r
539 return Collections.emptyList();
\r
542 val List<Type> genRPCTypes = new ArrayList();
\r
543 val interfaceBuilder = moduleTypeBuilder(module, "Service");
\r
544 interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));
\r
545 for (rpc : rpcDefinitions) {
\r
548 val rpcName = parseToClassName(rpc.QName.localName);
\r
549 val rpcMethodName = parseToValidParamName(rpcName);
\r
550 val method = interfaceBuilder.addMethod(rpcMethodName);
\r
552 val rpcInOut = new ArrayList();
\r
554 val input = rpc.input;
\r
555 val output = rpc.output;
\r
557 if(input !== null) {
\r
558 rpcInOut.add(new DataNodeIterator(input));
\r
559 val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
\r
560 addImplementedInterfaceFromUses(input, inType);
\r
561 inType.addImplementsType(DATA_OBJECT);
\r
562 inType.addImplementsType(augmentable(inType));
\r
563 resolveDataSchemaNodes(basePackageName, inType, input.childNodes);
\r
564 val inTypeInstance = inType.toInstance();
\r
565 genRPCTypes.add(inTypeInstance);
\r
566 method.addParameter(inTypeInstance, "input");
\r
569 var Type outTypeInstance = VOID;
\r
570 if(output !== null) {
\r
571 rpcInOut.add(new DataNodeIterator(output));
\r
572 val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
\r
573 addImplementedInterfaceFromUses(output, outType);
\r
574 outType.addImplementsType(DATA_OBJECT);
\r
575 outType.addImplementsType(augmentable(outType));
\r
577 resolveDataSchemaNodes(basePackageName, outType, output.childNodes);
\r
578 outTypeInstance = outType.toInstance();
\r
579 genRPCTypes.add(outTypeInstance);
\r
583 val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);
\r
584 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
\r
585 for (iter : rpcInOut) {
\r
586 val List<ContainerSchemaNode> nContainers = iter.allContainers();
\r
587 if((nContainers !== null) && !nContainers.isEmpty()) {
\r
588 for (container : nContainers) {
\r
589 if(!container.isAddedByUses()) {
\r
590 genRPCTypes.addAll(dataNodeContainerToGenType(basePackageName, container, module));
\r
594 val List<ListSchemaNode> nLists = iter.allLists();
\r
595 if((nLists !== null) && !nLists.isEmpty()) {
\r
596 for (list : nLists) {
\r
597 if(!list.isAddedByUses()) {
\r
598 genRPCTypes.addAll(dataNodeContainerToGenType(basePackageName, list, module));
\r
602 val List<ChoiceNode> nChoices = iter.allChoices();
\r
603 if((nChoices !== null) && !nChoices.isEmpty()) {
\r
604 for (choice : nChoices) {
\r
605 if(!choice.isAddedByUses()) {
\r
606 genRPCTypes.addAll(choiceToGeneratedType(basePackageName, choice, module));
\r
613 genRPCTypes.add(interfaceBuilder.toInstance());
\r
614 return genRPCTypes;
\r
618 * Converts all <b>notifications</b> of the module to the list of
\r
619 * <code>Type</code> objects. In addition are to this list added containers
\r
620 * and lists which are part of this notification.
\r
623 * module from which is obtained set of all notification objects
\r
624 * to iterate over them
\r
625 * @return list of <code>Type</code> which are generated from notification
\r
626 * (object of type <code>NotificationDefinition</code>
\r
627 * @throws IllegalArgumentException
\r
629 * <li>if the module equals null</li>
\r
630 * <li>if the name of module equals null</li>
\r
631 * <li>if the set of child nodes equals null</li>
\r
635 private def List<Type> allNotificationsToGenType(Module module) {
\r
636 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
638 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
640 if(module.childNodes === null) {
\r
641 throw new IllegalArgumentException(
\r
642 "Reference to Set of Notification Definitions in module " + module.name + " cannot be NULL.");
\r
644 val notifications = module.notifications;
\r
645 if(notifications.isEmpty()) return Collections.emptyList();
\r
647 val listenerInterface = moduleTypeBuilder(module, "Listener");
\r
648 listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
\r
650 val basePackageName = moduleNamespaceToPackageName(module);
\r
651 val List<Type> generatedTypes = new ArrayList();
\r
655 for (notification : notifications) {
\r
656 if(notification !== null) {
\r
657 generatedTypes.addAll(processUsesAugments(notification, module));
\r
659 val iter = new DataNodeIterator(notification);
\r
662 for (node : iter.allContainers()) {
\r
663 if(!node.isAddedByUses()) {
\r
664 generatedTypes.addAll(dataNodeContainerToGenType(basePackageName, node, module));
\r
669 for (node : iter.allLists()) {
\r
670 if(!node.isAddedByUses()) {
\r
671 generatedTypes.addAll(dataNodeContainerToGenType(basePackageName, node, module));
\r
674 val notificationInterface = addDefaultInterfaceDefinition(basePackageName, notification);
\r
675 notificationInterface.addImplementsType(NOTIFICATION);
\r
677 // Notification object
\r
678 resolveDataSchemaNodes(basePackageName, notificationInterface, notification.childNodes);
\r
680 listenerInterface.addMethod("on" + notificationInterface.name) //
\r
681 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification").
\r
682 setReturnType(Types.VOID);
\r
684 generatedTypes.add(notificationInterface.toInstance());
\r
687 generatedTypes.add(listenerInterface.toInstance());
\r
688 return generatedTypes;
\r
692 * Converts all <b>identities</b> of the module to the list of
\r
693 * <code>Type</code> objects.
\r
696 * module from which is obtained set of all identity objects to
\r
697 * iterate over them
\r
699 * schema context only used as input parameter for method
\r
700 * {@link identityToGenType}
\r
701 * @return list of <code>Type</code> which are generated from identities
\r
702 * (object of type <code>IdentitySchemaNode</code>
\r
705 private def List<Type> allIdentitiesToGenTypes(Module module, SchemaContext context) {
\r
706 val List<Type> genTypes = new ArrayList();
\r
708 val Set<IdentitySchemaNode> schemaIdentities = module.identities;
\r
710 val basePackageName = moduleNamespaceToPackageName(module);
\r
712 if(schemaIdentities !== null && !schemaIdentities.isEmpty()) {
\r
713 for (identity : schemaIdentities) {
\r
714 genTypes.add(identityToGenType(basePackageName, identity, context));
\r
721 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
\r
722 * created transport object builder. If identity contains base identity then
\r
723 * reference to base identity is added to superior identity as its extend.
\r
724 * If identity doesn't contain base identity then only reference to abstract
\r
725 * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
\r
726 * BaseIdentity} is added
\r
728 * @param basePackageName
\r
729 * string contains the module package name
\r
731 * IdentitySchemaNode which contains data about identity
\r
733 * SchemaContext which is used to get package and name
\r
734 * information about base of identity
\r
736 * @return GeneratedType which is generated from identity (object of type
\r
737 * <code>IdentitySchemaNode</code>
\r
740 private def GeneratedType identityToGenType(String basePackageName, IdentitySchemaNode identity,
\r
741 SchemaContext context) {
\r
742 if(identity === null) {
\r
746 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
\r
747 val genTypeName = parseToClassName(identity.QName.localName);
\r
748 val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
\r
750 val baseIdentity = identity.baseIdentity;
\r
751 if(baseIdentity !== null) {
\r
752 val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
\r
754 val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);
\r
755 val returnTypeName = parseToClassName(baseIdentity.QName.localName);
\r
757 val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();
\r
758 newType.setExtendsType(gto);
\r
760 newType.setExtendsType(Types.baseIdentityTO);
\r
762 newType.setAbstract(true);
\r
763 return newType.toInstance();
\r
767 * Converts all <b>groupings</b> of the module to the list of
\r
768 * <code>Type</code> objects. Firstly are groupings sorted according mutual
\r
769 * dependencies. At least dependend (indepedent) groupings are in the list
\r
770 * saved at first positions. For every grouping the record is added to map
\r
771 * {@link BindingGeneratorImpl#allGroupings allGroupings}
\r
774 * module from which is obtained set of all grouping objects to
\r
775 * iterate over them
\r
776 * @return list of <code>Type</code> which are generated from groupings
\r
777 * (object of type <code>GroupingDefinition</code>)
\r
780 private def List<Type> allGroupingsToGenTypes(Module module) {
\r
781 checkArgument(module !== null, "Module parameter can not be null");
\r
782 val List<Type> genTypes = new ArrayList();
\r
783 val basePackageName = moduleNamespaceToPackageName(module);
\r
784 val it = new DataNodeIterator(module);
\r
785 val List<GroupingDefinition> groupings = it.allGroupings();
\r
786 val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(
\r
789 for (grouping : groupingsSortedByDependencies) {
\r
790 val genType = groupingToGenType(basePackageName, grouping, module);
\r
791 genTypes.add(genType);
\r
792 genTypes.addAll(processUsesAugments(grouping, module));
\r
793 val schemaPath = grouping.path;
\r
794 allGroupings.put(schemaPath, genType);
\r
800 * Converts individual grouping to GeneratedType. Firstly generated type
\r
801 * builder is created and every child node of grouping is resolved to the
\r
804 * @param basePackageName
\r
805 * string contains the module package name
\r
807 * GroupingDefinition which contains data about grouping
\r
808 * @return GeneratedType which is generated from grouping (object of type
\r
809 * <code>GroupingDefinition</code>)
\r
811 private def GeneratedType groupingToGenType(String basePackageName, GroupingDefinition grouping, Module module) {
\r
812 if(grouping === null) {
\r
816 val packageName = packageNameForGeneratedType(basePackageName, grouping.path);
\r
817 val Set<DataSchemaNode> schemaNodes = grouping.childNodes;
\r
818 val typeBuilder = addDefaultInterfaceDefinition(packageName, grouping);
\r
820 resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);
\r
822 return typeBuilder.toInstance();
\r
826 * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base
\r
827 * type of <code>typeDefinition</code> is of the type ExtendedType then this
\r
828 * method is recursivelly called with this base type.
\r
830 * @param typeDefinition
\r
831 * TypeDefinition in which should be EnumTypeDefinition found as
\r
833 * @return EnumTypeDefinition if it is found inside
\r
834 * <code>typeDefinition</code> or <code>null</code> in other case
\r
836 private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {
\r
837 if(typeDefinition !== null) {
\r
838 if(typeDefinition.baseType instanceof EnumTypeDefinition) {
\r
839 return typeDefinition.baseType as EnumTypeDefinition;
\r
840 } else if(typeDefinition.baseType instanceof ExtendedType) {
\r
841 return enumTypeDefFromExtendedType(typeDefinition.baseType);
\r
848 * Adds enumeration builder created from <code>enumTypeDef</code> to
\r
849 * <code>typeBuilder</code>.
\r
851 * Each <code>enumTypeDef</code> item is added to builder with its name and
\r
854 * @param enumTypeDef
\r
855 * EnumTypeDefinition contains enum data
\r
857 * string contains name which will be assigned to enumeration
\r
859 * @param typeBuilder
\r
860 * GeneratedTypeBuilder to which will be enum builder assigned
\r
861 * @return enumeration builder which contais data from
\r
862 * <code>enumTypeDef</code>
\r
864 private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, String enumName,
\r
865 GeneratedTypeBuilder typeBuilder) {
\r
866 if((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&
\r
867 (enumTypeDef.QName.localName !== null)) {
\r
869 val enumerationName = parseToClassName(enumName);
\r
870 val enumBuilder = typeBuilder.addEnumeration(enumerationName);
\r
871 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
\r
873 return enumBuilder;
\r
879 * Generates type builder for <code>module</code>.
\r
882 * Module which is source of package name for generated type
\r
885 * string which is added to the module class name representation
\r
887 * @return instance of GeneratedTypeBuilder which represents
\r
888 * <code>module</code>.
\r
889 * @throws IllegalArgumentException
\r
890 * if <code>module</code> equals null
\r
892 private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {
\r
893 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
894 val packageName = moduleNamespaceToPackageName(module);
\r
895 val moduleName = parseToClassName(module.name) + postfix;
\r
897 return new GeneratedTypeBuilderImpl(packageName, moduleName);
\r
901 * Converts <code>augSchema</code> to list of <code>Type</code> which
\r
902 * contains generated type for augmentation. In addition there are also
\r
903 * generated types for all containers, list and choices which are child of
\r
904 * <code>augSchema</code> node or a generated types for cases are added if
\r
905 * augmented node is choice.
\r
907 * @param augmentPackageName
\r
908 * string with the name of the package to which the augmentation
\r
911 * AugmentationSchema which is contains data about agumentation
\r
912 * (target path, childs...)
\r
913 * @return list of <code>Type</code> objects which contains generated type
\r
914 * for augmentation and for container, list and choice child nodes
\r
915 * @throws IllegalArgumentException
\r
917 * <li>if <code>augmentPackageName</code> equals null</li>
\r
918 * <li>if <code>augSchema</code> equals null</li>
\r
919 * <li>if target path of <code>augSchema</code> equals null</li>
\r
922 private def List<Type> augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module,
923 UsesNode parentUsesNode) {
924 checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
925 checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
926 checkState(augSchema.targetPath !== null,
927 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
928 val List<Type> genTypes = new ArrayList();
929 genTypes.addAll(processUsesAugments(augSchema, module));
931 // EVERY augmented interface will extends Augmentation<T> interface
\r
932 // and DataObject interface!!!
\r
933 val targetPath = augSchema.targetPath;
934 var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
935 if (targetSchemaNode instanceof DataSchemaNode && (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
\r
936 if (parentUsesNode == null) {
\r
937 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
\r
939 targetSchemaNode = findOriginalTargetFromGrouping(targetSchemaNode.QName.localName, parentUsesNode);
\r
941 if (targetSchemaNode == null) {
\r
942 throw new NullPointerException(
\r
943 "Failed to find target node from grouping for augmentation " + augSchema + " in module " + module.name);
\r
947 if (targetSchemaNode !== null) {
948 var targetType = yangToJavaMapping.get(targetSchemaNode.path);
949 if (targetType == null) {
950 // FIXME: augmentation should be added as last, all types should already be generated
\r
951 // and have assigned Java Types,
\r
952 val targetModule = findParentModule(schemaContext, targetSchemaNode);
953 val targetBasePackage = moduleNamespaceToPackageName(targetModule);
954 val typePackage = packageNameForGeneratedType(targetBasePackage, targetSchemaNode.getPath());
955 val targetSchemaNodeName = targetSchemaNode.getQName().getLocalName();
956 val typeName = parseToClassName(targetSchemaNodeName);
957 targetType = new ReferencedTypeImpl(typePackage, typeName);
959 val augChildNodes = augSchema.childNodes;
961 if (!(targetSchemaNode instanceof ChoiceNode)) {
962 var packageName = augmentPackageName;
963 if (parentUsesNode != null) {
964 packageName = packageNameForGeneratedType(augmentPackageName, augSchema.targetPath);
966 val augTypeBuilder = addRawAugmentGenTypeDefinition(packageName, augmentPackageName, targetType,
968 val augType = augTypeBuilder.toInstance();
969 genTypes.add(augType);
972 generateTypesFromAugmentedChoiceCases(augmentPackageName, targetType, augChildNodes,
973 targetSchemaNode as ChoiceNode));
975 genTypes.addAll(augmentationBodyToGenTypes(augmentPackageName, augChildNodes, module));
982 * Utility method which search for original node defined in grouping.
\r
984 private def DataSchemaNode findOriginal(DataSchemaNode node) {
\r
985 var DataSchemaNode result = findCorrectTargetFromGrouping(node);
\r
986 if (result == null) {
\r
987 result = findCorrectTargetFromAugment(node);
\r
988 if (result != null) {
\r
989 if (result.addedByUses) {
\r
990 result = findOriginal(result);
\r
997 private def DataSchemaNode findCorrectTargetFromAugment(DataSchemaNode node) {
\r
998 if (!node.augmenting) {
\r
1002 var String currentName = node.QName.localName;
\r
1003 var tmpPath = new ArrayList<String>();
\r
1004 var YangNode parent = node;
\r
1005 var AugmentationSchema augment = null;
\r
1007 parent = (parent as DataSchemaNode).parent;
\r
1008 if (parent instanceof AugmentationTarget) {
\r
1009 tmpPath.add(currentName);
\r
1010 augment = findNodeInAugment((parent as AugmentationTarget).availableAugmentations, currentName);
\r
1011 if (augment == null) {
\r
1012 currentName = (parent as DataSchemaNode).QName.localName;
\r
1015 } while ((parent as DataSchemaNode).augmenting && augment == null);
\r
1017 if (augment == null) {
\r
1020 Collections.reverse(tmpPath);
\r
1021 var Object actualParent = augment;
\r
1022 var DataSchemaNode result = null;
\r
1023 for (name : tmpPath) {
\r
1024 if (actualParent instanceof DataNodeContainer) {
\r
1025 result = (actualParent as DataNodeContainer).getDataChildByName(name);
\r
1026 actualParent = (actualParent as DataNodeContainer).getDataChildByName(name);
\r
1028 if (actualParent instanceof ChoiceNode) {
\r
1029 result = (actualParent as ChoiceNode).getCaseNodeByName(name);
\r
1030 actualParent = (actualParent as ChoiceNode).getCaseNodeByName(name);
\r
1035 if (result.addedByUses) {
\r
1036 result = findCorrectTargetFromGrouping(result);
\r
1043 private def AugmentationSchema findNodeInAugment(Collection<AugmentationSchema> augments, String name) {
\r
1044 for (augment : augments) {
\r
1045 if (augment.getDataChildByName(name) != null) {
\r
1052 private def DataSchemaNode findCorrectTargetFromGrouping(DataSchemaNode node) {
\r
1053 if (node.path.path.size == 1) {
\r
1054 // uses is under module statement
\r
1055 val Module m = findParentModule(schemaContext, node);
\r
1056 var DataSchemaNode result = null;
\r
1057 for (u : m.uses) {
\r
1058 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
\r
1059 if (!(targetGrouping instanceof GroupingDefinition)) {
\r
1060 throw new IllegalArgumentException("Failed to generate code for augment in " + u);
\r
1062 var gr = targetGrouping as GroupingDefinition;
\r
1063 result = gr.getDataChildByName(node.QName.localName);
\r
1065 if (result == null) {
\r
1066 throw new IllegalArgumentException("Failed to generate code for augment");
\r
1070 var DataSchemaNode result = null;
\r
1071 var String currentName = node.QName.localName;
\r
1072 var tmpPath = new ArrayList<String>();
\r
1073 var YangNode parent = node.parent;
\r
1075 tmpPath.add(currentName);
\r
1076 val dataNodeParent = parent as DataNodeContainer;
\r
1077 for (u : dataNodeParent.uses) {
\r
1078 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
\r
1079 if (!(targetGrouping instanceof GroupingDefinition)) {
\r
1080 throw new IllegalArgumentException("Failed to generate code for augment in " + u);
\r
1082 var gr = targetGrouping as GroupingDefinition;
\r
1083 result = gr.getDataChildByName(currentName);
\r
1085 if (result == null) {
\r
1086 currentName = (parent as SchemaNode).QName.localName;
\r
1087 if (parent instanceof DataSchemaNode) {
\r
1088 parent = (parent as DataSchemaNode).parent;
\r
1090 parent = (parent as DataNodeContainer).parent;
\r
1093 } while (result == null && !(parent instanceof Module));
\r
1095 if (result != null) {
\r
1096 if (tmpPath.size == 1) {
\r
1099 var DataSchemaNode newParent = result;
\r
1100 Collections.reverse(tmpPath);
\r
1101 tmpPath.remove(0);
\r
1102 for (name : tmpPath) {
\r
1103 newParent = (newParent as DataNodeContainer).getDataChildByName(name);
\r
1114 * Convenient method to find node added by uses statement.
\r
1116 private def DataSchemaNode findOriginalTargetFromGrouping(String targetSchemaNodeName, UsesNode parentUsesNode) {
\r
1117 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.groupingPath.path);
\r
1118 if (!(targetGrouping instanceof GroupingDefinition)) {
\r
1119 throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
\r
1122 var grouping = targetGrouping as GroupingDefinition;
\r
1123 var result = grouping.getDataChildByName(targetSchemaNodeName);
\r
1124 if (result == null) {
\r
1127 var boolean fromUses = result.addedByUses;
\r
1129 var Iterator<UsesNode> groupingUses = grouping.uses.iterator;
\r
1130 while (fromUses) {
\r
1131 if (groupingUses.hasNext()) {
\r
1132 grouping = findNodeInSchemaContext(schemaContext, groupingUses.next().groupingPath.path) as GroupingDefinition;
\r
1133 result = grouping.getDataChildByName(targetSchemaNodeName);
\r
1134 fromUses = result.addedByUses;
\r
1136 throw new NullPointerException("Failed to generate code for augment in " + parentUsesNode);
\r
1144 * Returns a generated type builder for an augmentation.
\r
1146 * The name of the type builder is equal to the name of augmented node with
\r
1147 * serial number as suffix.
\r
1149 * @param augmentPackageName
\r
1150 * string with contains the package name to which the augment
\r
1152 * @param targetPackageName
\r
1153 * string with the package name to which the augmented node
\r
1155 * @param targetSchemaNodeName
\r
1156 * string with the name of the augmented node
\r
1157 * @param augSchema
\r
1158 * augmentation schema which contains data about the child nodes
\r
1159 * and uses of augment
\r
1160 * @return generated type builder for augment
\r
1162 private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(String augmentPackageName, String basePackageName,
\r
1163 Type targetTypeRef, AugmentationSchema augSchema) {
\r
1164 var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
\r
1165 if (augmentBuilders === null) {
\r
1166 augmentBuilders = new HashMap();
\r
1167 genTypeBuilders.put(augmentPackageName, augmentBuilders);
\r
1169 val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
\r
1171 val augTypeName = if (augIdentifier !== null) {
\r
1172 parseToClassName(augIdentifier)
\r
1174 augGenTypeName(augmentBuilders, targetTypeRef.name);
\r
1177 val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
\r
1179 augTypeBuilder.addImplementsType(DATA_OBJECT);
\r
1180 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
\r
1181 addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
\r
1183 augSchemaNodeToMethods(basePackageName, augTypeBuilder, augSchema.childNodes);
\r
1184 augmentBuilders.put(augTypeName, augTypeBuilder);
\r
1185 return augTypeBuilder;
\r
1190 * @param unknownSchemaNodes
\r
1191 * @return nodeParameter of UnknownSchemaNode
\r
1193 private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
\r
1194 for (unknownSchemaNode : unknownSchemaNodes) {
\r
1195 val nodeType = unknownSchemaNode.nodeType;
\r
1196 if(AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
\r
1197 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
\r
1198 return unknownSchemaNode.nodeParameter;
\r
1205 * Convert a container, list and choice subnodes (and recursivelly their
\r
1206 * subnodes) of augment to generated types
\r
1208 * @param augBasePackageName
\r
1209 * string with the augment package name
\r
1210 * @param augChildNodes
\r
1211 * set of data schema nodes which represents child nodes of the
\r
1214 * @return list of <code>Type</code> which represents container, list and
\r
1215 * choice subnodes of augment
\r
1217 private def List<Type> augmentationBodyToGenTypes(String augBasePackageName, Set<DataSchemaNode> augChildNodes, Module module) {
\r
1218 val List<Type> genTypes = new ArrayList();
\r
1219 val List<DataNodeIterator> augSchemaIts = new ArrayList();
\r
1220 for (childNode : augChildNodes) {
\r
1221 if (!childNode.addedByUses) {
\r
1224 if(childNode instanceof DataNodeContainer) {
\r
1225 augSchemaIts.add(new DataNodeIterator(childNode as DataNodeContainer));
\r
1227 if(childNode instanceof ContainerSchemaNode) {
\r
1228 genTypes.addAll(dataNodeContainerToGenType(augBasePackageName, childNode as ContainerSchemaNode, module));
\r
1229 } else if(childNode instanceof ListSchemaNode) {
\r
1230 genTypes.addAll(dataNodeContainerToGenType(augBasePackageName, childNode as ListSchemaNode, module));
\r
1232 } else if(childNode instanceof ChoiceNode) {
\r
1233 val choice = childNode as ChoiceNode;
\r
1234 for (caseNode : choice.cases) {
\r
1235 augSchemaIts.add(new DataNodeIterator(caseNode));
\r
1237 genTypes.addAll(choiceToGeneratedType(augBasePackageName, childNode as ChoiceNode, module));
\r
1244 for (it : augSchemaIts) {
\r
1245 val List<ContainerSchemaNode> augContainers = it.allContainers();
\r
1246 val List<ListSchemaNode> augLists = it.allLists();
\r
1247 val List<ChoiceNode> augChoices = it.allChoices();
\r
1249 if(augContainers !== null) {
\r
1250 for (container : augContainers) {
\r
1251 genTypes.addAll(dataNodeContainerToGenType(augBasePackageName, container, module));
\r
1254 if(augLists !== null) {
\r
1255 for (list : augLists) {
\r
1256 genTypes.addAll(dataNodeContainerToGenType(augBasePackageName, list, module));
\r
1259 if(augChoices !== null) {
\r
1260 for (choice : augChoices) {
\r
1261 genTypes.addAll(choiceToGeneratedType(augBasePackageName, choice, module));
\r
1269 * Returns first unique name for the augment generated type builder. The
\r
1270 * generated type builder name for augment consists from name of augmented
\r
1271 * node and serial number of its augmentation.
\r
1274 * map of builders which were created in the package to which the
\r
1275 * augmentation belongs
\r
1276 * @param genTypeName
\r
1277 * string with name of augmented node
\r
1278 * @return string with unique name for augmentation builder
\r
1280 private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
\r
1282 while((builders !== null) && builders.containsKey(genTypeName + index)) {
\r
1283 index = index + 1;
\r
1285 return genTypeName + index;
\r
1289 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
\r
1290 * node for which <code>typeBuilder</code> was created.
\r
1292 * The subnodes aren't mapped to the methods if they are part of grouping or
\r
1293 * augment (in this case are already part of them).
\r
1295 * @param basePackageName
\r
1296 * string contains the module package name
\r
1297 * @param typeBuilder
\r
1298 * generated type builder which represents any node. The subnodes
\r
1299 * of this node are added to the <code>typeBuilder</code> as
\r
1300 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1301 * container, choice.
\r
1302 * @param schemaNodes
\r
1303 * set of data schema nodes which are the children of the node
\r
1304 * for which <code>typeBuilder</code> was created
\r
1305 * @return generated type builder which is the same builder as input
\r
1306 * parameter. The getter methods (representing child nodes) could be
\r
1309 private def GeneratedTypeBuilder resolveDataSchemaNodes(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1310 Set<DataSchemaNode> schemaNodes) {
\r
1311 if((schemaNodes !== null) && (typeBuilder !== null)) {
\r
1312 for (schemaNode : schemaNodes) {
\r
1313 if(!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
\r
1314 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
\r
1319 return typeBuilder;
\r
1322 private def GeneratedTypeBuilder resolveDataSchemaNodesAugmented(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1323 Set<DataSchemaNode> schemaNodes) {
\r
1324 if ((schemaNodes !== null) && (typeBuilder !== null)) {
\r
1325 for (schemaNode : schemaNodes) {
\r
1326 if (!schemaNode.isAddedByUses()) {
\r
1327 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
\r
1331 return typeBuilder;
\r
1335 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
\r
1336 * node for which <code>typeBuilder</code> was created.
\r
1338 * @param basePackageName
\r
1339 * string contains the module package name
\r
1340 * @param typeBuilder
\r
1341 * generated type builder which represents any node. The subnodes
\r
1342 * of this node are added to the <code>typeBuilder</code> as
\r
1343 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1344 * container, choice.
\r
1345 * @param schemaNodes
\r
1346 * set of data schema nodes which are the children of the node
\r
1347 * for which <code>typeBuilder</code> was created
\r
1348 * @return generated type builder which is the same object as the input
\r
1349 * parameter <code>typeBuilder</code>. The getter method could be
\r
1352 private def GeneratedTypeBuilder augSchemaNodeToMethods(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1353 Set<DataSchemaNode> schemaNodes) {
\r
1354 if((schemaNodes !== null) && (typeBuilder !== null)) {
\r
1355 for (schemaNode : schemaNodes) {
\r
1356 if (!schemaNode.isAugmenting()) {
\r
1357 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
\r
1361 return typeBuilder;
\r
1365 * Adds to <code>typeBuilder</code> a method which is derived from
\r
1366 * <code>schemaNode</code>.
\r
1368 * @param basePackageName
\r
1369 * string with the module package name
\r
1370 * @param schemaNode
\r
1371 * data schema node which is added to <code>typeBuilder</code> as
\r
1373 * @param typeBuilder
\r
1374 * generated type builder to which is <code>schemaNode</code>
\r
1375 * added as a method.
\r
1377 private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
\r
1378 GeneratedTypeBuilder typeBuilder) {
\r
1379 if(node !== null && typeBuilder !== null) {
\r
1381 case node instanceof LeafSchemaNode:
\r
1382 resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
\r
1383 case node instanceof LeafListSchemaNode:
\r
1384 resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
\r
1385 case node instanceof ContainerSchemaNode:
\r
1386 resolveContainerSchemaNode(basePackageName, typeBuilder, node as ContainerSchemaNode)
\r
1387 case node instanceof ListSchemaNode:
\r
1388 resolveListSchemaNode(basePackageName, typeBuilder, node as ListSchemaNode)
\r
1389 case node instanceof ChoiceNode:
\r
1390 resolveChoiceSchemaNode(basePackageName, typeBuilder, node as ChoiceNode)
\r
1396 * Creates a getter method for a choice node.
\r
1398 * Firstly generated type builder for choice is created or found in
\r
1399 * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
\r
1400 * in the builder is created as concatenation of module package name and
\r
1401 * names of all parent nodes. In the end the getter method for choice is
\r
1402 * added to <code>typeBuilder</code> and return type is set to choice
\r
1405 * @param basePackageName
\r
1406 * string with the module package name
\r
1407 * @param typeBuilder
\r
1408 * generated type builder to which is <code>choiceNode</code>
\r
1409 * added as getter method
\r
1410 * @param choiceNode
\r
1411 * choice node which is mapped as a getter method
\r
1412 * @throws IllegalArgumentException
\r
1414 * <li>if <code>basePackageName</code> equals null</li>
\r
1415 * <li>if <code>typeBuilder</code> equals null</li>
\r
1416 * <li>if <code>choiceNode</code> equals null</li>
\r
1420 private def void resolveChoiceSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1421 ChoiceNode choiceNode) {
\r
1422 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1423 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
\r
1424 checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
\r
1426 val choiceName = choiceNode.QName.localName;
\r
1427 if(choiceName !== null && !choiceNode.isAddedByUses()) {
\r
1428 val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
\r
1429 val choiceType = addDefaultInterfaceDefinition(packageName, choiceNode);
\r
1430 constructGetter(typeBuilder, choiceName, choiceNode.description, choiceType);
\r
1435 * Converts <code>choiceNode</code> to the list of generated types for
\r
1436 * choice and its cases.
\r
1438 * The package names for choice and for its cases are created as
\r
1439 * concatenation of the module package (<code>basePackageName</code>) and
\r
1440 * names of all parents node.
\r
1442 * @param basePackageName
\r
1443 * string with the module package name
\r
1444 * @param choiceNode
\r
1445 * choice node which is mapped to generated type. Also child
\r
1446 * nodes - cases are mapped to generated types.
\r
1447 * @return list of generated types which contains generated type for choice
\r
1448 * and generated types for all cases which aren't added do choice
\r
1449 * through <i>uses</i>.
\r
1450 * @throws IllegalArgumentException
\r
1452 * <li>if <code>basePackageName</code> equals null</li>
\r
1453 * <li>if <code>choiceNode</code> equals null</li>
\r
1457 private def List<Type> choiceToGeneratedType(String basePackageName, ChoiceNode choiceNode, Module module) {
\r
1458 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1459 checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
\r
1461 val List<Type> generatedTypes = new ArrayList();
\r
1462 val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
\r
1463 val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
\r
1465 choiceTypeBuilder.addImplementsType(DataContainer.typeForClass);
\r
1466 val choiceType = choiceTypeBuilder.toInstance();
\r
1468 generatedTypes.add(choiceType);
\r
1469 val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
\r
1470 if((caseNodes !== null) && !caseNodes.isEmpty()) {
\r
1471 generatedTypes.addAll(generateTypesFromChoiceCases(basePackageName, choiceType, caseNodes, module));
\r
1473 return generatedTypes;
\r
1477 * Converts <code>caseNodes</code> set to list of corresponding generated
\r
1480 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
\r
1481 * created generated type builder. The package names for the builder is
\r
1482 * created as concatenation of the module package (
\r
1483 * <code>basePackageName</code>) and names of all parents nodes of the
\r
1484 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
\r
1485 * between every case builder and <i>choice</i> type
\r
1487 * @param basePackageName
\r
1488 * string with the module package name
\r
1489 * @param refChoiceType
\r
1490 * type which represents superior <i>case</i>
\r
1491 * @param caseNodes
\r
1492 * set of choice case nodes which are mapped to generated types
\r
1493 * @return list of generated types for <code>caseNodes</code>.
\r
1494 * @throws IllegalArgumentException
\r
1496 * <li>if <code>basePackageName</code> equals null</li>
\r
1497 * <li>if <code>refChoiceType</code> equals null</li>
\r
1498 * <li>if <code>caseNodes</code> equals null</li>
\r
1502 private def List<Type> generateTypesFromChoiceCases(String basePackageName, Type refChoiceType,
\r
1503 Set<ChoiceCaseNode> caseNodes, Module module) {
\r
1504 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1505 checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
\r
1506 checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
\r
1508 val List<Type> generatedTypes = new ArrayList();
\r
1509 for (caseNode : caseNodes) {
\r
1510 if(caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
\r
1511 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
\r
1512 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
\r
1513 caseTypeBuilder.addImplementsType(refChoiceType);
\r
1515 val Set<DataSchemaNode> childNodes = caseNode.childNodes;
\r
1516 if(childNodes !== null) {
\r
1517 resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);
\r
1519 generatedTypes.add(caseTypeBuilder.toInstance());
\r
1522 generatedTypes.addAll(processUsesAugments(caseNode, module));
\r
1525 return generatedTypes;
\r
1529 * Generates list of generated types for all the cases of a choice which are
\r
1530 * added to the choice through the augment.
\r
1533 * @param basePackageName
\r
1534 * string contains name of package to which augment belongs. If
\r
1535 * an augmented choice is from an other package (pcg1) than an
\r
1536 * augmenting choice (pcg2) then case's of the augmenting choice
\r
1537 * will belong to pcg2.
\r
1538 * @param refChoiceType
\r
1539 * Type which represents the choice to which case belongs. Every
\r
1540 * case has to contain its choice in extend part.
\r
1541 * @param caseNodes
\r
1542 * set of choice case nodes for which is checked if are/aren't
\r
1543 * added to choice through augmentation
\r
1544 * @return list of generated types which represents augmented cases of
\r
1545 * choice <code>refChoiceType</code>
\r
1546 * @throws IllegalArgumentException
\r
1548 * <li>if <code>basePackageName</code> equals null</li>
\r
1549 * <li>if <code>refChoiceType</code> equals null</li>
\r
1550 * <li>if <code>caseNodes</code> equals null</li>
\r
1553 private def List<GeneratedType> generateTypesFromAugmentedChoiceCases(String basePackageName, Type refChoiceType,
\r
1554 Set<DataSchemaNode> caseNodes, ChoiceNode targetNode) {
\r
1555 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1556 checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
\r
1557 checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
\r
1559 val List<GeneratedType> generatedTypes = new ArrayList();
\r
1560 for (caseNode : caseNodes) {
\r
1561 if(caseNode !== null) {
\r
1562 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
\r
1563 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
\r
1564 caseTypeBuilder.addImplementsType(refChoiceType);
\r
1566 if (caseNode instanceof DataNodeContainer) {
\r
1567 val DataNodeContainer dataNodeCase = caseNode as DataNodeContainer;
\r
1568 val Set<DataSchemaNode> childNodes = dataNodeCase.childNodes;
\r
1569 if(childNodes !== null) {
\r
1570 resolveDataSchemaNodesAugmented(basePackageName, caseTypeBuilder, childNodes);
\r
1573 val ChoiceCaseNode node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
\r
1574 val Set<DataSchemaNode> childNodes = node.childNodes;
\r
1575 if(childNodes !== null) {
\r
1576 resolveDataSchemaNodesAugmented(basePackageName, caseTypeBuilder, childNodes);
\r
1580 generatedTypes.add(caseTypeBuilder.toInstance());
\r
1584 return generatedTypes;
\r
1588 * Converts <code>leaf</code> to the getter method which is added to
\r
1589 * <code>typeBuilder</code>.
\r
1591 * @param typeBuilder
\r
1592 * generated type builder to which is added getter method as
\r
1593 * <code>leaf</code> mapping
\r
1595 * leaf schema node which is mapped as getter method which is
\r
1596 * added to <code>typeBuilder</code>
\r
1597 * @return boolean value
\r
1599 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
\r
1601 * <li>true - in other cases</li>
\r
1604 private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
\r
1605 if((leaf !== null) && (typeBuilder !== null)) {
\r
1606 val leafName = leaf.QName.localName;
\r
1607 var String leafDesc = leaf.description;
\r
1608 if(leafDesc === null) {
\r
1612 val parentModule = findParentModule(schemaContext, leaf);
\r
1613 if(leafName !== null && !leaf.isAddedByUses()) {
\r
1614 val TypeDefinition<?> typeDef = leaf.type;
\r
1616 var Type returnType = null;
\r
1617 if(typeDef instanceof EnumTypeDefinition) {
\r
1618 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
\r
1619 val enumTypeDef = typeDef as EnumTypeDefinition;
\r
1620 val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName, typeBuilder);
\r
1622 if(enumBuilder !== null) {
\r
1623 returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
\r
1625 (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
\r
1626 } else if(typeDef instanceof UnionType) {
\r
1627 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
\r
1628 if(genTOBuilder !== null) {
\r
1629 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1631 } else if(typeDef instanceof BitsTypeDefinition) {
\r
1632 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
\r
1633 if(genTOBuilder !== null) {
\r
1634 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1637 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
\r
1639 if(returnType !== null) {
\r
1640 val MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
\r
1641 processContextRefExtension(leaf, getter, parentModule);
\r
1649 private def void processContextRefExtension(LeafSchemaNode leaf, MethodSignatureBuilder getter, Module module) {
\r
1650 for (node : leaf.unknownSchemaNodes) {
\r
1651 val nodeType = node.nodeType;
\r
1652 if ("context-reference".equals(nodeType.localName)) {
\r
1653 val nodeParam = node.nodeParameter;
\r
1654 var IdentitySchemaNode identity = null;
\r
1655 var String basePackageName = null;
\r
1656 val String[] splittedElement = nodeParam.split(":");
\r
1657 if (splittedElement.length == 1) {
\r
1658 identity = findIdentityByName(module.identities, splittedElement.get(0));
\r
1659 basePackageName = moduleNamespaceToPackageName(module);
\r
1660 } else if (splittedElement.length == 2) {
\r
1661 var prefix = splittedElement.get(0);
\r
1662 val Module dependentModule = findModuleFromImports(module.imports, prefix)
\r
1663 if (dependentModule == null) {
\r
1664 throw new IllegalArgumentException("Failed to process context-reference: unknown prefix " + prefix);
\r
1666 identity = findIdentityByName(dependentModule.identities, splittedElement.get(1));
\r
1667 basePackageName = moduleNamespaceToPackageName(dependentModule);
\r
1669 throw new IllegalArgumentException("Failed to process context-reference: unknown identity " + nodeParam);
\r
1671 if (identity == null) {
\r
1672 throw new IllegalArgumentException("Failed to process context-reference: unknown identity " + nodeParam);
\r
1675 val Class<RoutingContext> clazz = typeof(RoutingContext);
\r
1676 val AnnotationTypeBuilder rc = getter.addAnnotation(clazz.package.name, clazz.simpleName);
\r
1677 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
\r
1678 val genTypeName = parseToClassName(identity.QName.localName);
\r
1679 rc.addParameter("value", packageName + "." + genTypeName + ".class");
\r
1684 private def IdentitySchemaNode findIdentityByName(Set<IdentitySchemaNode> identities, String name) {
\r
1685 for (id : identities) {
\r
1686 if (id.QName.localName.equals(name)) {
\r
1693 private def Module findModuleFromImports(Set<ModuleImport> imports, String prefix) {
\r
1694 for (imp : imports) {
\r
1695 if (imp.prefix.equals(prefix)) {
\r
1696 return schemaContext.findModuleByName(imp.moduleName, imp.revision);
\r
1703 * Converts <code>leaf</code> schema node to property of generated TO
\r
1706 * @param toBuilder
\r
1707 * generated TO builder to which is <code>leaf</code> added as
\r
1710 * leaf schema node which is added to <code>toBuilder</code> as
\r
1712 * @param isReadOnly
\r
1713 * boolean value which says if leaf property is|isn't read only
\r
1714 * @return boolean value
\r
1716 * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
\r
1717 * name equals null or if leaf is added by <i>uses</i>.</li>
\r
1718 * <li>true - other cases</li>
\r
1721 private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
\r
1722 boolean isReadOnly) {
\r
1723 if((leaf !== null) && (toBuilder !== null)) {
\r
1724 val leafName = leaf.QName.localName;
\r
1725 var String leafDesc = leaf.description;
\r
1726 if(leafDesc === null) {
\r
1730 if(leafName !== null) {
\r
1731 val TypeDefinition<?> typeDef = leaf.type;
\r
1733 // TODO: properly resolve enum types
\r
1734 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
\r
1736 if(returnType !== null) {
\r
1737 val propBuilder = toBuilder.addProperty(parseToClassName(leafName));
\r
1739 propBuilder.setReadOnly(isReadOnly);
\r
1740 propBuilder.setReturnType(returnType);
\r
1741 propBuilder.setComment(leafDesc);
\r
1743 toBuilder.addEqualsIdentity(propBuilder);
\r
1744 toBuilder.addHashIdentity(propBuilder);
\r
1745 toBuilder.addToStringProperty(propBuilder);
\r
1755 * Converts <code>node</code> leaf list schema node to getter method of
\r
1756 * <code>typeBuilder</code>.
\r
1758 * @param typeBuilder
\r
1759 * generated type builder to which is <code>node</code> added as
\r
1762 * leaf list schema node which is added to
\r
1763 * <code>typeBuilder</code> as getter method
\r
1764 * @return boolean value
\r
1766 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
\r
1767 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
\r
1768 * <li>false - other cases</li>
\r
1771 private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
\r
1772 if((node !== null) && (typeBuilder !== null)) {
\r
1773 val nodeName = node.QName.localName;
\r
1774 var String nodeDesc = node.description;
\r
1775 if(nodeDesc === null) {
\r
1779 if(nodeName !== null && !node.isAddedByUses()) {
\r
1780 val TypeDefinition<?> type = node.type;
\r
1781 val listType = Types.listTypeFor(typeProvider.javaTypeForSchemaDefinitionType(type, node));
\r
1783 constructGetter(typeBuilder, nodeName, nodeDesc, listType);
\r
1791 * Creates a getter method for a container node.
\r
1793 * Firstly generated type builder for container is created or found in
\r
1794 * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
\r
1795 * in the builder is created as concatenation of module package name and
\r
1796 * names of all parent nodes. In the end the getter method for container is
\r
1797 * added to <code>typeBuilder</code> and return type is set to container
\r
1800 * @param basePackageName
\r
1801 * string with the module package name
\r
1802 * @param typeBuilder
\r
1803 * generated type builder to which is <code>containerNode</code>
\r
1804 * added as getter method
\r
1805 * @param containerNode
\r
1806 * container schema node which is mapped as getter method to
\r
1807 * <code>typeBuilder</code>
\r
1808 * @return boolean value
\r
1810 * <li>false - if <code>containerNode</code>,
\r
1811 * <code>typeBuilder</code>, container node name equal null or
\r
1812 * <code>containerNode</code> is added by uses</li>
\r
1813 * <li>true - other cases</li>
\r
1816 private def boolean resolveContainerSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1817 ContainerSchemaNode containerNode) {
\r
1818 if((containerNode !== null) && (typeBuilder !== null)) {
\r
1819 val nodeName = containerNode.QName.localName;
\r
1821 if(nodeName !== null && !containerNode.isAddedByUses()) {
\r
1822 val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);
\r
1824 val rawGenType = addDefaultInterfaceDefinition(packageName, containerNode);
\r
1825 constructGetter(typeBuilder, nodeName, containerNode.description, rawGenType);
\r
1834 * Creates a getter method for a list node.
\r
1836 * Firstly generated type builder for list is created or found in
\r
1837 * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
\r
1838 * in the builder is created as concatenation of module package name and
\r
1839 * names of all parent nodes. In the end the getter method for list is added
\r
1840 * to <code>typeBuilder</code> and return type is set to list type builder.
\r
1842 * @param basePackageName
\r
1843 * string with the module package name
\r
1844 * @param typeBuilder
\r
1845 * generated type builder to which is <code></code> added as
\r
1848 * list schema node which is mapped as getter method to
\r
1849 * <code>typeBuilder</code>
\r
1850 * @return boolean value
\r
1852 * <li>false - if <code>listNode</code>, <code>typeBuilder</code>,
\r
1853 * list node name equal null or <code>listNode</code> is added by
\r
1855 * <li>true - other cases</li>
\r
1858 private def boolean resolveListSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1859 ListSchemaNode listNode) {
\r
1860 if((listNode !== null) && (typeBuilder !== null)) {
\r
1861 val listName = listNode.QName.localName;
\r
1863 if(listName !== null && !listNode.isAddedByUses()) {
\r
1864 val packageName = packageNameForGeneratedType(basePackageName, listNode.path);
\r
1865 val rawGenType = addDefaultInterfaceDefinition(packageName, listNode);
\r
1866 constructGetter(typeBuilder, listName, listNode.description, Types.listTypeFor(rawGenType));
\r
1874 * Instantiates generated type builder with <code>packageName</code> and
\r
1875 * <code>schemaNode</code>.
\r
1877 * The new builder always implements
\r
1878 * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />
\r
1879 * If <code>schemaNode</code> is instance of GroupingDefinition it also
\r
1880 * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
\r
1881 * Augmentable}.<br />
\r
1882 * If <code>schemaNode</code> is instance of
\r
1883 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
\r
1884 * DataNodeContainer} it can also implement nodes which are specified in
\r
1887 * @param packageName
\r
1888 * string with the name of the package to which
\r
1889 * <code>schemaNode</code> belongs.
\r
1890 * @param schemaNode
\r
1891 * schema node for which is created generated type builder
\r
1892 * @return generated type builder <code>schemaNode</code>
\r
1894 private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
\r
1895 val builder = addRawInterfaceDefinition(packageName, schemaNode, "");
\r
1896 builder.addImplementsType(DATA_OBJECT);
\r
1897 if(!(schemaNode instanceof GroupingDefinition)) {
\r
1898 builder.addImplementsType(augmentable(builder));
\r
1901 if(schemaNode instanceof DataNodeContainer) {
\r
1902 addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, builder);
\r
1909 * Wraps the calling of the same overloaded method.
\r
1911 * @param packageName
\r
1912 * string with the package name to which returning generated type
\r
1914 * @param schemaNode
\r
1915 * schema node which provide data about the schema node name
\r
1916 * @return generated type builder for <code>schemaNode</code>
\r
1918 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
\r
1919 return addRawInterfaceDefinition(packageName, schemaNode, "");
\r
1923 * Returns reference to generated type builder for specified
\r
1924 * <code>schemaNode</code> with <code>packageName</code>.
\r
1926 * Firstly the generated type builder is searched in
\r
1927 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
\r
1928 * found it is created and added to <code>genTypeBuilders</code>.
\r
1930 * @param packageName
\r
1931 * string with the package name to which returning generated type
\r
1933 * @param schemaNode
\r
1934 * schema node which provide data about the schema node name
\r
1935 * @return generated type builder for <code>schemaNode</code>
\r
1936 * @throws IllegalArgumentException
\r
1938 * <li>if <code>schemaNode</code> equals null</li>
\r
1939 * <li>if <code>packageName</code> equals null</li>
\r
1940 * <li>if Q name of schema node is null</li>
\r
1941 * <li>if schema node name is nul</li>
\r
1945 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
\r
1947 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
\r
1948 checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
\r
1949 checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
\r
1950 val schemaNodeName = schemaNode.QName.localName;
\r
1951 checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
\r
1953 var String genTypeName;
\r
1954 if(prefix === null) {
\r
1955 genTypeName = parseToClassName(schemaNodeName);
\r
1957 genTypeName = prefix + parseToClassName(schemaNodeName);
\r
1960 //FIXME: Validation of name conflict
\r
1961 val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
\r
1962 yangToJavaMapping.put(schemaNode.path, newType);
\r
1963 if(!genTypeBuilders.containsKey(packageName)) {
\r
1964 val Map<String, GeneratedTypeBuilder> builders = new HashMap();
\r
1965 builders.put(genTypeName, newType);
\r
1966 genTypeBuilders.put(packageName, builders);
\r
1968 val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
\r
1969 if(!builders.containsKey(genTypeName)) {
\r
1970 builders.put(genTypeName, newType);
\r
1977 * Creates the name of the getter method from <code>methodName</code>.
\r
1979 * @param methodName
\r
1980 * string with the name of the getter method
\r
1981 * @return string with the name of the getter method for
\r
1982 * <code>methodName</code> in JAVA method format
\r
1984 private def String getterMethodName(String methodName, Type returnType) {
\r
1985 val method = new StringBuilder();
\r
1986 if(BOOLEAN.equals(returnType)) {
\r
1987 method.append("is");
\r
1989 method.append("get");
\r
1991 method.append(parseToClassName(methodName));
\r
1992 return method.toString();
\r
1996 * Created a method signature builder as part of
\r
1997 * <code>interfaceBuilder</code>.
\r
1999 * The method signature builder is created for the getter method of
\r
2000 * <code>schemaNodeName</code>. Also <code>comment</code> and
\r
2001 * <code>returnType</code> information are added to the builder.
\r
2003 * @param interfaceBuilder
\r
2004 * generated type builder for which the getter method should be
\r
2006 * @param schemaNodeName
\r
2007 * string with schema node name. The name will be the part of the
\r
2008 * getter method name.
\r
2010 * string with comment for the getter method
\r
2011 * @param returnType
\r
2012 * type which represents the return type of the getter method
\r
2013 * @return method signature builder which represents the getter method of
\r
2014 * <code>interfaceBuilder</code>
\r
2016 private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
\r
2017 String comment, Type returnType) {
\r
2019 val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
\r
2021 getMethod.setComment(comment);
\r
2022 getMethod.setReturnType(returnType);
\r
2028 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
\r
2029 * or to <code>genTOBuilder</code> as property.
\r
2031 * @param basePackageName
\r
2032 * string contains the module package name
\r
2033 * @param schemaNode
\r
2034 * data schema node which should be added as getter method to
\r
2035 * <code>typeBuilder</code> or as a property to
\r
2036 * <code>genTOBuilder</code> if is part of the list key
\r
2037 * @param typeBuilder
\r
2038 * generated type builder for the list schema node
\r
2039 * @param genTOBuilder
\r
2040 * generated TO builder for the list keys
\r
2042 * list of string which contains names of the list keys
\r
2043 * @throws IllegalArgumentException
\r
2045 * <li>if <code>schemaNode</code> equals null</li>
\r
2046 * <li>if <code>typeBuilder</code> equals null</li>
\r
2049 private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
\r
2050 GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys) {
\r
2051 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
\r
2053 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
\r
2055 if(schemaNode instanceof LeafSchemaNode) {
\r
2056 val leaf = schemaNode as LeafSchemaNode;
\r
2057 val leafName = leaf.QName.localName;
\r
2058 if(!listKeys.contains(leafName)) {
\r
2059 resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
\r
2061 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);
\r
2063 } else if (!schemaNode.addedByUses) {
\r
2064 if (schemaNode instanceof LeafListSchemaNode) {
\r
2065 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
\r
2066 } else if(schemaNode instanceof ContainerSchemaNode) {
\r
2067 resolveContainerSchemaNode(basePackageName, typeBuilder, schemaNode as ContainerSchemaNode);
\r
2068 } else if(schemaNode instanceof ChoiceNode) {
\r
2069 resolveChoiceSchemaNode(basePackageName,typeBuilder,schemaNode as ChoiceNode);
\r
2070 } else if(schemaNode instanceof ListSchemaNode) {
\r
2071 resolveListSchemaNode(basePackageName, typeBuilder, schemaNode as ListSchemaNode);
\r
2076 private def typeBuildersToGenTypes(GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
\r
2077 val List<Type> genTypes = new ArrayList();
\r
2078 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
\r
2080 if(genTOBuilder !== null) {
\r
2081 val genTO = genTOBuilder.toInstance();
\r
2082 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
\r
2083 genTypes.add(genTO);
\r
2085 genTypes.add(typeBuilder.toInstance());
\r
2090 * Selects the names of the list keys from <code>list</code> and returns
\r
2091 * them as the list of the strings
\r
2094 * of string with names of the list keys
\r
2095 * @return list of string which represents names of the list keys. If the
\r
2096 * <code>list</code> contains no keys then the empty list is
\r
2099 private def listKeys(ListSchemaNode list) {
\r
2100 val List<String> listKeys = new ArrayList();
\r
2102 if(list.keyDefinition !== null) {
\r
2103 val keyDefinitions = list.keyDefinition;
\r
2104 for (keyDefinition : keyDefinitions) {
\r
2105 listKeys.add(keyDefinition.localName);
\r
2112 * Generates for the <code>list</code> which contains any list keys special
\r
2113 * generated TO builder.
\r
2115 * @param packageName
\r
2116 * string with package name to which the list belongs
\r
2118 * list schema node which is source of data about the list name
\r
2119 * @return generated TO builder which represents the keys of the
\r
2120 * <code>list</code> or null if <code>list</code> is null or list of
\r
2121 * key definitions is null or empty.
\r
2123 private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
\r
2124 var GeneratedTOBuilder genTOBuilder = null;
\r
2125 if((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
\r
2126 if(list !== null) {
\r
2127 val listName = list.QName.localName + "Key";
\r
2128 val String genTOName = parseToClassName(listName);
\r
2129 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
\r
2132 return genTOBuilder;
\r
2137 * Builds generated TO builders for <code>typeDef</code> of type
\r
2138 * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
\r
2139 * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
\r
2140 * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
\r
2141 * enclosing transfer object.
\r
2143 * If more then one generated TO builder is created for enclosing then all
\r
2144 * of the generated TO builders are added to <code>typeBuilder</code> as
\r
2145 * enclosing transfer objects.
\r
2148 * type definition which can be of type <code>UnionType</code> or
\r
2149 * <code>BitsTypeDefinition</code>
\r
2150 * @param typeBuilder
\r
2151 * generated type builder to which is added generated TO created
\r
2152 * from <code>typeDef</code>
\r
2154 * string with name for generated TO builder
\r
2155 * @return generated TO builder for <code>typeDef</code>
\r
2157 private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
\r
2158 String leafName, LeafSchemaNode leaf, Module parentModule) {
\r
2159 val classNameFromLeaf = parseToClassName(leafName);
\r
2160 val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
\r
2161 val packageName = typeBuilder.fullyQualifiedName;
\r
2162 if(typeDef instanceof UnionTypeDefinition) {
\r
2163 genTOBuilders.addAll(
\r
2164 (typeProvider as TypeProviderImpl).
\r
2165 provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),
\r
2166 classNameFromLeaf, leaf));
\r
2167 } else if(typeDef instanceof BitsTypeDefinition) {
\r
2168 genTOBuilders.add(
\r
2169 ((typeProvider as TypeProviderImpl) ).
\r
2170 provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
\r
2172 if(genTOBuilders !== null && !genTOBuilders.isEmpty()) {
\r
2173 for (genTOBuilder : genTOBuilders) {
\r
2174 typeBuilder.addEnclosingTransferObject(genTOBuilder);
\r
2176 return genTOBuilders.get(0);
\r
2183 * Adds the implemented types to type builder.
\r
2185 * The method passes through the list of <i>uses</i> in
\r
2186 * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding
\r
2187 * generated type from {@link BindingGeneratorImpl#allGroupings
\r
2188 * allGroupings} which is added as <i>implements type</i> to
\r
2189 * <code>builder</code>
\r
2191 * @param dataNodeContainer
\r
2192 * element which contains the list of used YANG groupings
\r
2194 * builder to which are added implemented types according to
\r
2195 * <code>dataNodeContainer</code>
\r
2196 * @return generated type builder with all implemented types
\r
2198 private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
\r
2199 for (usesNode : dataNodeContainer.uses) {
\r
2200 if(usesNode.groupingPath !== null) {
\r
2201 val genType = allGroupings.get(usesNode.groupingPath);
\r
2202 if(genType === null) {
\r
2203 throw new IllegalStateException(
\r
2204 "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
\r
2206 builder.addImplementsType(genType);
\r
Code Review / yangtools.git / blob