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
73 import java.util.LinkedHashMap
75 public class BindingGeneratorImpl implements BindingGenerator {
\r
77 * Outter key represents the package name. Outter value represents map of
\r
78 * all builders in the same package. Inner key represents the schema node
\r
79 * name (in JAVA class/interface name format). Inner value represents
\r
80 * instance of builder for schema node specified in key part.
\r
82 private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;
\r
85 * Provide methods for converting YANG types to JAVA types.
\r
87 private var TypeProvider typeProvider;
\r
90 * Holds reference to schema context to resolve data of augmented elemnt
\r
91 * when creating augmentation builder
\r
93 private var SchemaContext schemaContext;
\r
96 * Each grouping which is converted from schema node to generated type is
\r
97 * added to this map with its Schema path as key to make it easier to get
\r
98 * reference to it. In schema nodes in <code>uses</code> attribute there is
\r
99 * only Schema Path but when building list of implemented interfaces for
\r
100 * Schema node the object of type <code>Type</code> is required. So in this
\r
101 * case is used this map.
\r
103 private val allGroupings = new LinkedHashMap<SchemaPath, GeneratedType>();
\r
105 private val yangToJavaMapping = new HashMap<SchemaPath, Type>();
\r
108 * Constant with the concrete name of namespace.
\r
110 private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";
\r
113 * Constant with the concrete name of identifier.
\r
115 private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";
\r
118 * Resolves generated types from <code>context</code> schema nodes of all
\r
121 * Generated types are created for modules, groupings, types, containers,
\r
122 * lists, choices, augments, rpcs, notification, identities.
\r
125 * schema context which contains data about all schema nodes
\r
127 * @return list of types (usually <code>GeneratedType</code>
\r
128 * <code>GeneratedTransferObject</code>which are generated from
\r
129 * <code>context</code> data.
\r
130 * @throws IllegalArgumentException
\r
131 * if param <code>context</code> is null
\r
132 * @throws IllegalStateException
\r
133 * if <code>context</code> contain no modules
\r
135 override generateTypes(SchemaContext context) {
\r
136 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
\r
137 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
\r
138 schemaContext = context;
\r
139 typeProvider = new TypeProviderImpl(context);
\r
140 val Set<Module> modules = context.modules;
\r
141 return generateTypes(context, modules);
\r
145 * Resolves generated types from <code>context</code> schema nodes only for
\r
146 * modules specified in <code>modules</code>
\r
148 * Generated types are created for modules, groupings, types, containers,
\r
149 * lists, choices, augments, rpcs, notification, identities.
\r
152 * schema context which contains data about all schema nodes
\r
155 * set of modules for which schema nodes should be generated
\r
157 * @return list of types (usually <code>GeneratedType</code> or
\r
158 * <code>GeneratedTransferObject</code>) which:
\r
160 * <li>are generated from <code>context</code> schema nodes and</li>
\r
161 * <li>are also part of some of the module in <code>modules</code>
\r
164 * @throws IllegalArgumentException
\r
166 * <li>if param <code>context</code> is null or</li>
\r
167 * <li>if param <code>modules</code> is null</li>
\r
169 * @throws IllegalStateException
\r
170 * if <code>context</code> contain no modules
\r
172 override generateTypes(SchemaContext context, Set<Module> modules) {
\r
173 checkArgument(context !== null, "Schema Context reference cannot be NULL.");
\r
174 checkState(context.modules !== null, "Schema Context does not contain defined modules.");
\r
175 checkArgument(modules !== null, "Set of Modules cannot be NULL.");
\r
177 val List<Type> filteredGenTypes = new ArrayList();
\r
179 schemaContext = context;
\r
180 typeProvider = new TypeProviderImpl(context);
\r
181 val contextModules = ModuleDependencySort.sort(context.modules);
\r
182 genTypeBuilders = new HashMap();
\r
184 for (contextModule : contextModules) {
\r
185 val List<Type> generatedTypes = new ArrayList();
\r
186 generatedTypes.addAll(allTypeDefinitionsToGenTypes(contextModule));
\r
187 generatedTypes.addAll(allGroupingsToGenTypes(contextModule));
\r
188 if(false == contextModule.childNodes.isEmpty()) {
\r
189 generatedTypes.add(moduleToDataType(contextModule));
\r
191 generatedTypes.addAll(allContainersToGenTypes(contextModule));
\r
192 generatedTypes.addAll(allListsToGenTypes(contextModule));
\r
193 generatedTypes.addAll(allChoicesToGenTypes(contextModule));
\r
194 generatedTypes.addAll(allRPCMethodsToGenType(contextModule));
\r
195 generatedTypes.addAll(allNotificationsToGenType(contextModule));
\r
196 generatedTypes.addAll(allIdentitiesToGenTypes(contextModule, context));
\r
198 if(modules.contains(contextModule)) {
\r
199 filteredGenTypes.addAll(generatedTypes);
\r
202 for (contextModule : contextModules) {
\r
203 val generatedTypes = (allAugmentsToGenTypes(contextModule));
\r
204 if(modules.contains(contextModule)) {
\r
205 filteredGenTypes.addAll(generatedTypes);
\r
209 return filteredGenTypes;
\r
213 * Converts all extended type definitions of module to the list of
\r
214 * <code>Type</code> objects.
\r
217 * module from which is obtained set of type definitions
\r
218 * @return list of <code>Type</code> which are generated from extended
\r
219 * definition types (object of type <code>ExtendedType</code>)
\r
220 * @throws IllegalArgumentException
\r
222 * <li>if module equals null</li>
\r
223 * <li>if name of module equals null</li>
\r
224 * <li>if type definitions of module equal null</li>
\r
228 private def List<Type> allTypeDefinitionsToGenTypes(Module module) {
\r
229 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
230 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
231 val it = new DataNodeIterator(module);
\r
232 val List<TypeDefinition<?>> typeDefinitions = it.allTypedefs;
\r
233 checkState(typeDefinitions !== null, '''Type Definitions for module «module.name» cannot be NULL.''');
\r
235 val List<Type> generatedTypes = new ArrayList();
\r
236 for (TypeDefinition<?> typedef : typeDefinitions) {
\r
237 if(typedef !== null) {
\r
238 val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);
\r
239 if((type !== null) && !generatedTypes.contains(type)) {
\r
240 generatedTypes.add(type);
\r
244 return generatedTypes;
\r
247 private def List<Type> dataNodeContainerToGenType(String basePackageName, DataNodeContainer node, Module module) {
\r
248 if (node === null) {
\r
251 if (!(node instanceof SchemaNode)) {
\r
252 throw new IllegalArgumentException("node to generate must be instance of SchemaNode");
\r
254 val List<Type> result = new ArrayList();
\r
256 result.addAll(processUsesAugments(node, module));
\r
258 val packageName = packageNameForGeneratedType(basePackageName, (node as SchemaNode).path);
\r
259 val typeBuilder = addDefaultInterfaceDefinition(packageName, node as SchemaNode);
\r
260 val schemaNodes = node.childNodes;
\r
261 if (node instanceof ContainerSchemaNode) {
\r
262 resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);
\r
263 result.add(typeBuilder.toInstance());
\r
264 } else if (node instanceof ListSchemaNode) {
\r
265 val List<String> listKeys = listKeys(node as ListSchemaNode);
\r
266 val genTOBuilder = resolveListKeyTOBuilder(packageName, node as ListSchemaNode);
\r
268 if(genTOBuilder !== null) {
\r
269 val identifierMarker = IDENTIFIER.parameterizedTypeFor(typeBuilder);
\r
270 val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);
\r
271 genTOBuilder.addImplementsType(identifierMarker);
\r
272 typeBuilder.addImplementsType(identifiableMarker);
\r
274 for (schemaNode : schemaNodes) {
\r
275 if (!schemaNode.isAugmenting()) {
\r
276 addSchemaNodeToListBuilders(basePackageName, schemaNode, typeBuilder, genTOBuilder, listKeys);
\r
279 result.addAll(typeBuildersToGenTypes(typeBuilder, genTOBuilder));
\r
285 private def List<Type> processUsesAugments(DataNodeContainer node, Module module) {
\r
286 val List<Type> result = new ArrayList();
\r
287 val basePackageName = moduleNamespaceToPackageName(module);
\r
289 for (usesNode : node.uses) {
\r
290 for (augment : usesNode.augmentations) {
\r
291 result.addAll(augmentationToGenTypes(basePackageName, augment, module, usesNode));
\r
292 result.addAll(processUsesAugments(augment, module));
\r
300 * Converts all <b>containers</b> of the module to the list of
\r
301 * <code>Type</code> objects.
\r
304 * module from which is obtained DataNodeIterator to iterate over
\r
306 * @return list of <code>Type</code> which are generated from containers
\r
307 * (objects of type <code>ContainerSchemaNode</code>)
\r
308 * @throws IllegalArgumentException
\r
310 * <li>if the module equals null</li>
\r
311 * <li>if the name of module equals null</li>
\r
312 * <li>if the set of child nodes equals null</li>
\r
316 private def List<Type> allContainersToGenTypes(Module module) {
\r
317 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
319 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
321 if(module.childNodes === null) {
\r
322 throw new IllegalArgumentException(
\r
323 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");
\r
326 val List<Type> generatedTypes = new ArrayList();
\r
327 val it = new DataNodeIterator(module);
\r
328 val List<ContainerSchemaNode> schemaContainers = it.allContainers();
\r
329 val basePackageName = moduleNamespaceToPackageName(module);
\r
330 for (container : schemaContainers) {
\r
331 if(!container.isAddedByUses()) {
\r
332 generatedTypes.addAll(dataNodeContainerToGenType(basePackageName, container, module));
\r
335 return generatedTypes;
\r
339 * Converts all <b>lists</b> of the module to the list of <code>Type</code>
\r
343 * module from which is obtained DataNodeIterator to iterate over
\r
345 * @return list of <code>Type</code> which are generated from lists (objects
\r
346 * of type <code>ListSchemaNode</code>)
\r
347 * @throws IllegalArgumentException
\r
349 * <li>if the module equals null</li>
\r
350 * <li>if the name of module equals null</li>
\r
351 * <li>if the set of child nodes equals null</li>
\r
355 private def List<Type> allListsToGenTypes(Module module) {
\r
356 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
357 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
359 if(module.childNodes === null) {
\r
360 throw new IllegalArgumentException(
\r
361 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");
\r
364 val List<Type> generatedTypes = new ArrayList();
\r
365 val it = new DataNodeIterator(module);
\r
366 val List<ListSchemaNode> schemaLists = it.allLists();
\r
367 val basePackageName = moduleNamespaceToPackageName(module);
\r
368 if(schemaLists !== null) {
\r
369 for (list : schemaLists) {
\r
370 if(!list.isAddedByUses()) {
\r
371 generatedTypes.addAll(dataNodeContainerToGenType(basePackageName, list, module));
\r
375 return generatedTypes;
\r
379 * Converts all <b>choices</b> of the module to the list of
\r
380 * <code>Type</code> objects.
\r
383 * module from which is obtained DataNodeIterator to iterate over
\r
385 * @return list of <code>Type</code> which are generated from choices
\r
386 * (objects of type <code>ChoiceNode</code>)
\r
387 * @throws IllegalArgumentException
\r
389 * <li>if the module equals null</li>
\r
390 * <li>if the name of module equals null</li> *
\r
394 private def List<Type> allChoicesToGenTypes(Module module) {
\r
395 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
396 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
398 val it = new DataNodeIterator(module);
\r
399 val choiceNodes = it.allChoices();
\r
400 val basePackageName = moduleNamespaceToPackageName(module);
\r
402 val List<Type> generatedTypes = new ArrayList();
\r
403 for (choice : choiceNodes) {
\r
404 if((choice !== null) && !choice.isAddedByUses()) {
\r
405 generatedTypes.addAll(choiceToGeneratedType(basePackageName, choice, module));
\r
408 return generatedTypes;
\r
412 * Converts all <b>augmentation</b> of the module to the list
\r
413 * <code>Type</code> objects.
\r
416 * module from which is obtained list of all augmentation objects
\r
417 * to iterate over them
\r
418 * @return list of <code>Type</code> which are generated from augments
\r
419 * (objects of type <code>AugmentationSchema</code>)
\r
420 * @throws IllegalArgumentException
\r
422 * <li>if the module equals null</li>
\r
423 * <li>if the name of module equals null</li>
\r
424 * <li>if the set of child nodes equals null</li>
\r
428 private def List<Type> allAugmentsToGenTypes(Module module) {
\r
429 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
430 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
431 if(module.childNodes === null) {
\r
432 throw new IllegalArgumentException(
\r
433 "Reference to Set of Augmentation Definitions in module " + module.name + " cannot be NULL.");
\r
436 val List<Type> generatedTypes = new ArrayList();
\r
437 val basePackageName = moduleNamespaceToPackageName(module);
\r
438 val List<AugmentationSchema> augmentations = resolveAugmentations(module);
\r
439 for (augment : augmentations) {
\r
440 generatedTypes.addAll(augmentationToGenTypes(basePackageName, augment, module, null));
\r
442 return generatedTypes;
\r
446 * Returns list of <code>AugmentationSchema</code> objects. The objects are
\r
447 * sorted according to the length of their target path from the shortest to
\r
451 * module from which is obtained list of all augmentation objects
\r
452 * @return list of sorted <code>AugmentationSchema</code> objects obtained
\r
453 * from <code>module</code>
\r
454 * @throws IllegalArgumentException
\r
456 * <li>if the module equals null</li>
\r
457 * <li>if the set of augmentation equals null</li>
\r
461 private def List<AugmentationSchema> resolveAugmentations(Module module) {
\r
462 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
463 checkState(module.augmentations !== null, "Augmentations Set cannot be NULL.");
\r
465 val Set<AugmentationSchema> augmentations = module.augmentations;
\r
466 val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);
\r
467 Collections.sort(sortedAugmentations,
\r
468 [ augSchema1, augSchema2 |
\r
469 if(augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {
\r
471 } else if(augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {
\r
476 return sortedAugmentations;
\r
480 * Converts whole <b>module</b> to <code>GeneratedType</code> object.
\r
481 * Firstly is created the module builder object from which is vally
\r
482 * obtained reference to <code>GeneratedType</code> object.
\r
485 * module from which are obtained the module name, child nodes,
\r
486 * uses and is derived package name
\r
487 * @return <code>GeneratedType</code> which is internal representation of
\r
489 * @throws IllegalArgumentException
\r
490 * if the module equals null
\r
493 private def GeneratedType moduleToDataType(Module module) {
\r
494 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
496 val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");
\r
497 addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);
\r
498 moduleDataTypeBuilder.addImplementsType(DATA_ROOT);
\r
500 val basePackageName = moduleNamespaceToPackageName(module);
\r
501 if(moduleDataTypeBuilder !== null) {
\r
502 val Set<DataSchemaNode> dataNodes = module.childNodes;
\r
503 resolveDataSchemaNodes(basePackageName, moduleDataTypeBuilder, dataNodes);
\r
505 return moduleDataTypeBuilder.toInstance();
\r
509 * Converts all <b>rpcs</b> inputs and outputs substatements of the module
\r
510 * to the list of <code>Type</code> objects. In addition are to containers
\r
511 * and lists which belong to input or output also part of returning list.
\r
514 * module from which is obtained set of all rpc objects to
\r
515 * iterate over them
\r
516 * @return list of <code>Type</code> which are generated from rpcs inputs,
\r
517 * outputs + container and lists which are part of inputs or outputs
\r
518 * @throws IllegalArgumentException
\r
520 * <li>if the module equals null</li>
\r
521 * <li>if the name of module equals null</li>
\r
522 * <li>if the set of child nodes equals null</li>
\r
526 private def List<Type> allRPCMethodsToGenType(Module module) {
\r
527 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
529 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
531 if(module.childNodes === null) {
\r
532 throw new IllegalArgumentException(
\r
533 "Reference to Set of RPC Method Definitions in module " + module.name + " cannot be NULL.");
\r
536 val basePackageName = moduleNamespaceToPackageName(module);
\r
537 val Set<RpcDefinition> rpcDefinitions = module.rpcs;
\r
539 if(rpcDefinitions.isEmpty()) {
\r
540 return Collections.emptyList();
\r
543 val List<Type> genRPCTypes = new ArrayList();
\r
544 val interfaceBuilder = moduleTypeBuilder(module, "Service");
\r
545 interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));
\r
546 for (rpc : rpcDefinitions) {
\r
549 val rpcName = parseToClassName(rpc.QName.localName);
\r
550 val rpcMethodName = parseToValidParamName(rpcName);
\r
551 val method = interfaceBuilder.addMethod(rpcMethodName);
\r
553 val rpcInOut = new ArrayList();
\r
555 val input = rpc.input;
\r
556 val output = rpc.output;
\r
558 if(input !== null) {
\r
559 rpcInOut.add(new DataNodeIterator(input));
\r
560 val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);
\r
561 addImplementedInterfaceFromUses(input, inType);
\r
562 inType.addImplementsType(DATA_OBJECT);
\r
563 inType.addImplementsType(augmentable(inType));
\r
564 resolveDataSchemaNodes(basePackageName, inType, input.childNodes);
\r
565 val inTypeInstance = inType.toInstance();
\r
566 genRPCTypes.add(inTypeInstance);
\r
567 method.addParameter(inTypeInstance, "input");
\r
570 var Type outTypeInstance = VOID;
\r
571 if(output !== null) {
\r
572 rpcInOut.add(new DataNodeIterator(output));
\r
573 val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);
\r
574 addImplementedInterfaceFromUses(output, outType);
\r
575 outType.addImplementsType(DATA_OBJECT);
\r
576 outType.addImplementsType(augmentable(outType));
\r
578 resolveDataSchemaNodes(basePackageName, outType, output.childNodes);
\r
579 outTypeInstance = outType.toInstance();
\r
580 genRPCTypes.add(outTypeInstance);
\r
584 val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);
\r
585 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));
\r
586 for (iter : rpcInOut) {
\r
587 val List<ContainerSchemaNode> nContainers = iter.allContainers();
\r
588 if((nContainers !== null) && !nContainers.isEmpty()) {
\r
589 for (container : nContainers) {
\r
590 if(!container.isAddedByUses()) {
\r
591 genRPCTypes.addAll(dataNodeContainerToGenType(basePackageName, container, module));
\r
595 val List<ListSchemaNode> nLists = iter.allLists();
\r
596 if((nLists !== null) && !nLists.isEmpty()) {
\r
597 for (list : nLists) {
\r
598 if(!list.isAddedByUses()) {
\r
599 genRPCTypes.addAll(dataNodeContainerToGenType(basePackageName, list, module));
\r
603 val List<ChoiceNode> nChoices = iter.allChoices();
\r
604 if((nChoices !== null) && !nChoices.isEmpty()) {
\r
605 for (choice : nChoices) {
\r
606 if(!choice.isAddedByUses()) {
\r
607 genRPCTypes.addAll(choiceToGeneratedType(basePackageName, choice, module));
\r
614 genRPCTypes.add(interfaceBuilder.toInstance());
\r
615 return genRPCTypes;
\r
619 * Converts all <b>notifications</b> of the module to the list of
\r
620 * <code>Type</code> objects. In addition are to this list added containers
\r
621 * and lists which are part of this notification.
\r
624 * module from which is obtained set of all notification objects
\r
625 * to iterate over them
\r
626 * @return list of <code>Type</code> which are generated from notification
\r
627 * (object of type <code>NotificationDefinition</code>
\r
628 * @throws IllegalArgumentException
\r
630 * <li>if the module equals null</li>
\r
631 * <li>if the name of module equals null</li>
\r
632 * <li>if the set of child nodes equals null</li>
\r
636 private def List<Type> allNotificationsToGenType(Module module) {
\r
637 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
639 checkArgument(module.name !== null, "Module name cannot be NULL.");
\r
641 if(module.childNodes === null) {
\r
642 throw new IllegalArgumentException(
\r
643 "Reference to Set of Notification Definitions in module " + module.name + " cannot be NULL.");
\r
645 val notifications = module.notifications;
\r
646 if(notifications.isEmpty()) return Collections.emptyList();
\r
648 val listenerInterface = moduleTypeBuilder(module, "Listener");
\r
649 listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);
\r
651 val basePackageName = moduleNamespaceToPackageName(module);
\r
652 val List<Type> generatedTypes = new ArrayList();
\r
656 for (notification : notifications) {
\r
657 if(notification !== null) {
\r
658 generatedTypes.addAll(processUsesAugments(notification, module));
\r
660 val iter = new DataNodeIterator(notification);
\r
663 for (node : iter.allContainers()) {
\r
664 if(!node.isAddedByUses()) {
\r
665 generatedTypes.addAll(dataNodeContainerToGenType(basePackageName, node, module));
\r
670 for (node : iter.allLists()) {
\r
671 if(!node.isAddedByUses()) {
\r
672 generatedTypes.addAll(dataNodeContainerToGenType(basePackageName, node, module));
\r
675 val notificationInterface = addDefaultInterfaceDefinition(basePackageName, notification);
\r
676 notificationInterface.addImplementsType(NOTIFICATION);
\r
678 // Notification object
\r
679 resolveDataSchemaNodes(basePackageName, notificationInterface, notification.childNodes);
\r
681 listenerInterface.addMethod("on" + notificationInterface.name) //
\r
682 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification").
\r
683 setReturnType(Types.VOID);
\r
685 generatedTypes.add(notificationInterface.toInstance());
\r
688 generatedTypes.add(listenerInterface.toInstance());
\r
689 return generatedTypes;
\r
693 * Converts all <b>identities</b> of the module to the list of
\r
694 * <code>Type</code> objects.
\r
697 * module from which is obtained set of all identity objects to
\r
698 * iterate over them
\r
700 * schema context only used as input parameter for method
\r
701 * {@link identityToGenType}
\r
702 * @return list of <code>Type</code> which are generated from identities
\r
703 * (object of type <code>IdentitySchemaNode</code>
\r
706 private def List<Type> allIdentitiesToGenTypes(Module module, SchemaContext context) {
\r
707 val List<Type> genTypes = new ArrayList();
\r
709 val Set<IdentitySchemaNode> schemaIdentities = module.identities;
\r
711 val basePackageName = moduleNamespaceToPackageName(module);
\r
713 if(schemaIdentities !== null && !schemaIdentities.isEmpty()) {
\r
714 for (identity : schemaIdentities) {
\r
715 genTypes.add(identityToGenType(basePackageName, identity, context));
\r
722 * Converts the <b>identity</b> object to GeneratedType. Firstly it is
\r
723 * created transport object builder. If identity contains base identity then
\r
724 * reference to base identity is added to superior identity as its extend.
\r
725 * If identity doesn't contain base identity then only reference to abstract
\r
726 * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity
\r
727 * BaseIdentity} is added
\r
729 * @param basePackageName
\r
730 * string contains the module package name
\r
732 * IdentitySchemaNode which contains data about identity
\r
734 * SchemaContext which is used to get package and name
\r
735 * information about base of identity
\r
737 * @return GeneratedType which is generated from identity (object of type
\r
738 * <code>IdentitySchemaNode</code>
\r
741 private def GeneratedType identityToGenType(String basePackageName, IdentitySchemaNode identity,
\r
742 SchemaContext context) {
\r
743 if(identity === null) {
\r
747 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
\r
748 val genTypeName = parseToClassName(identity.QName.localName);
\r
749 val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);
\r
751 val baseIdentity = identity.baseIdentity;
\r
752 if(baseIdentity !== null) {
\r
753 val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);
\r
755 val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);
\r
756 val returnTypeName = parseToClassName(baseIdentity.QName.localName);
\r
758 val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();
\r
759 newType.setExtendsType(gto);
\r
761 newType.setExtendsType(Types.baseIdentityTO);
\r
763 newType.setAbstract(true);
\r
764 return newType.toInstance();
\r
768 * Converts all <b>groupings</b> of the module to the list of
\r
769 * <code>Type</code> objects. Firstly are groupings sorted according mutual
\r
770 * dependencies. At least dependend (indepedent) groupings are in the list
\r
771 * saved at first positions. For every grouping the record is added to map
\r
772 * {@link BindingGeneratorImpl#allGroupings allGroupings}
\r
775 * module from which is obtained set of all grouping objects to
\r
776 * iterate over them
\r
777 * @return list of <code>Type</code> which are generated from groupings
\r
778 * (object of type <code>GroupingDefinition</code>)
\r
781 private def List<Type> allGroupingsToGenTypes(Module module) {
\r
782 checkArgument(module !== null, "Module parameter can not be null");
\r
783 val List<Type> genTypes = new ArrayList();
\r
784 val basePackageName = moduleNamespaceToPackageName(module);
\r
785 val it = new DataNodeIterator(module);
\r
786 val List<GroupingDefinition> groupings = it.allGroupings();
\r
787 val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(
\r
790 for (grouping : groupingsSortedByDependencies) {
\r
791 val genType = groupingToGenType(basePackageName, grouping, module);
\r
792 genTypes.add(genType);
\r
793 genTypes.addAll(processUsesAugments(grouping, module));
\r
794 val schemaPath = grouping.path;
\r
795 allGroupings.put(schemaPath, genType);
\r
801 * Converts individual grouping to GeneratedType. Firstly generated type
\r
802 * builder is created and every child node of grouping is resolved to the
\r
805 * @param basePackageName
\r
806 * string contains the module package name
\r
808 * GroupingDefinition which contains data about grouping
\r
809 * @return GeneratedType which is generated from grouping (object of type
\r
810 * <code>GroupingDefinition</code>)
\r
812 private def GeneratedType groupingToGenType(String basePackageName, GroupingDefinition grouping, Module module) {
\r
813 if(grouping === null) {
\r
817 val packageName = packageNameForGeneratedType(basePackageName, grouping.path);
\r
818 val Set<DataSchemaNode> schemaNodes = grouping.childNodes;
\r
819 val typeBuilder = addDefaultInterfaceDefinition(packageName, grouping);
\r
821 resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);
\r
823 return typeBuilder.toInstance();
\r
827 * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base
\r
828 * type of <code>typeDefinition</code> is of the type ExtendedType then this
\r
829 * method is recursivelly called with this base type.
\r
831 * @param typeDefinition
\r
832 * TypeDefinition in which should be EnumTypeDefinition found as
\r
834 * @return EnumTypeDefinition if it is found inside
\r
835 * <code>typeDefinition</code> or <code>null</code> in other case
\r
837 private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {
\r
838 if(typeDefinition !== null) {
\r
839 if(typeDefinition.baseType instanceof EnumTypeDefinition) {
\r
840 return typeDefinition.baseType as EnumTypeDefinition;
\r
841 } else if(typeDefinition.baseType instanceof ExtendedType) {
\r
842 return enumTypeDefFromExtendedType(typeDefinition.baseType);
\r
849 * Adds enumeration builder created from <code>enumTypeDef</code> to
\r
850 * <code>typeBuilder</code>.
\r
852 * Each <code>enumTypeDef</code> item is added to builder with its name and
\r
855 * @param enumTypeDef
\r
856 * EnumTypeDefinition contains enum data
\r
858 * string contains name which will be assigned to enumeration
\r
860 * @param typeBuilder
\r
861 * GeneratedTypeBuilder to which will be enum builder assigned
\r
862 * @return enumeration builder which contais data from
\r
863 * <code>enumTypeDef</code>
\r
865 private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, String enumName,
\r
866 GeneratedTypeBuilder typeBuilder) {
\r
867 if((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&
\r
868 (enumTypeDef.QName.localName !== null)) {
\r
870 val enumerationName = parseToClassName(enumName);
\r
871 val enumBuilder = typeBuilder.addEnumeration(enumerationName);
\r
872 enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);
\r
874 return enumBuilder;
\r
880 * Generates type builder for <code>module</code>.
\r
883 * Module which is source of package name for generated type
\r
886 * string which is added to the module class name representation
\r
888 * @return instance of GeneratedTypeBuilder which represents
\r
889 * <code>module</code>.
\r
890 * @throws IllegalArgumentException
\r
891 * if <code>module</code> equals null
\r
893 private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {
\r
894 checkArgument(module !== null, "Module reference cannot be NULL.");
\r
895 val packageName = moduleNamespaceToPackageName(module);
\r
896 val moduleName = parseToClassName(module.name) + postfix;
\r
898 return new GeneratedTypeBuilderImpl(packageName, moduleName);
\r
902 * Converts <code>augSchema</code> to list of <code>Type</code> which
\r
903 * contains generated type for augmentation. In addition there are also
\r
904 * generated types for all containers, list and choices which are child of
\r
905 * <code>augSchema</code> node or a generated types for cases are added if
\r
906 * augmented node is choice.
\r
908 * @param augmentPackageName
\r
909 * string with the name of the package to which the augmentation
\r
912 * AugmentationSchema which is contains data about agumentation
\r
913 * (target path, childs...)
\r
914 * @return list of <code>Type</code> objects which contains generated type
\r
915 * for augmentation and for container, list and choice child nodes
\r
916 * @throws IllegalArgumentException
\r
918 * <li>if <code>augmentPackageName</code> equals null</li>
\r
919 * <li>if <code>augSchema</code> equals null</li>
\r
920 * <li>if target path of <code>augSchema</code> equals null</li>
\r
923 private def List<Type> augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module,
924 UsesNode parentUsesNode) {
925 checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");
926 checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");
927 checkState(augSchema.targetPath !== null,
928 "Augmentation Schema does not contain Target Path (Target Path is NULL).");
929 val List<Type> genTypes = new ArrayList();
930 genTypes.addAll(processUsesAugments(augSchema, module));
932 // EVERY augmented interface will extends Augmentation<T> interface
\r
933 // and DataObject interface!!!
\r
934 val targetPath = augSchema.targetPath;
935 var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);
936 if (targetSchemaNode instanceof DataSchemaNode && (targetSchemaNode as DataSchemaNode).isAddedByUses()) {
\r
937 if (parentUsesNode == null) {
\r
938 targetSchemaNode = findOriginal(targetSchemaNode as DataSchemaNode);
\r
940 targetSchemaNode = findOriginalTargetFromGrouping(targetSchemaNode.QName.localName, parentUsesNode);
\r
942 if (targetSchemaNode == null) {
\r
943 throw new NullPointerException(
\r
944 "Failed to find target node from grouping for augmentation " + augSchema + " in module " + module.name);
\r
948 if (targetSchemaNode !== null) {
949 var targetType = yangToJavaMapping.get(targetSchemaNode.path);
950 if (targetType == null) {
951 // FIXME: augmentation should be added as last, all types should already be generated
\r
952 // and have assigned Java Types,
\r
953 val targetModule = findParentModule(schemaContext, targetSchemaNode);
954 val targetBasePackage = moduleNamespaceToPackageName(targetModule);
955 val typePackage = packageNameForGeneratedType(targetBasePackage, targetSchemaNode.getPath());
956 val targetSchemaNodeName = targetSchemaNode.getQName().getLocalName();
957 val typeName = parseToClassName(targetSchemaNodeName);
958 targetType = new ReferencedTypeImpl(typePackage, typeName);
960 val augChildNodes = augSchema.childNodes;
962 if (!(targetSchemaNode instanceof ChoiceNode)) {
963 var packageName = augmentPackageName;
964 if (parentUsesNode != null) {
965 packageName = packageNameForGeneratedType(augmentPackageName, augSchema.targetPath);
967 val augTypeBuilder = addRawAugmentGenTypeDefinition(packageName, augmentPackageName, targetType,
969 val augType = augTypeBuilder.toInstance();
970 genTypes.add(augType);
973 generateTypesFromAugmentedChoiceCases(augmentPackageName, targetType, augChildNodes,
974 targetSchemaNode as ChoiceNode));
976 genTypes.addAll(augmentationBodyToGenTypes(augmentPackageName, augChildNodes, module));
983 * Utility method which search for original node defined in grouping.
\r
985 private def DataSchemaNode findOriginal(DataSchemaNode node) {
\r
986 var DataSchemaNode result = findCorrectTargetFromGrouping(node);
\r
987 if (result == null) {
\r
988 result = findCorrectTargetFromAugment(node);
\r
989 if (result != null) {
\r
990 if (result.addedByUses) {
\r
991 result = findOriginal(result);
\r
998 private def DataSchemaNode findCorrectTargetFromAugment(DataSchemaNode node) {
\r
999 if (!node.augmenting) {
\r
1003 var String currentName = node.QName.localName;
\r
1004 var tmpPath = new ArrayList<String>();
\r
1005 var YangNode parent = node;
\r
1006 var AugmentationSchema augment = null;
\r
1008 parent = (parent as DataSchemaNode).parent;
\r
1009 if (parent instanceof AugmentationTarget) {
\r
1010 tmpPath.add(currentName);
\r
1011 augment = findNodeInAugment((parent as AugmentationTarget).availableAugmentations, currentName);
\r
1012 if (augment == null) {
\r
1013 currentName = (parent as DataSchemaNode).QName.localName;
\r
1016 } while ((parent as DataSchemaNode).augmenting && augment == null);
\r
1018 if (augment == null) {
\r
1021 Collections.reverse(tmpPath);
\r
1022 var Object actualParent = augment;
\r
1023 var DataSchemaNode result = null;
\r
1024 for (name : tmpPath) {
\r
1025 if (actualParent instanceof DataNodeContainer) {
\r
1026 result = (actualParent as DataNodeContainer).getDataChildByName(name);
\r
1027 actualParent = (actualParent as DataNodeContainer).getDataChildByName(name);
\r
1029 if (actualParent instanceof ChoiceNode) {
\r
1030 result = (actualParent as ChoiceNode).getCaseNodeByName(name);
\r
1031 actualParent = (actualParent as ChoiceNode).getCaseNodeByName(name);
\r
1036 if (result.addedByUses) {
\r
1037 result = findCorrectTargetFromGrouping(result);
\r
1044 private def AugmentationSchema findNodeInAugment(Collection<AugmentationSchema> augments, String name) {
\r
1045 for (augment : augments) {
\r
1046 if (augment.getDataChildByName(name) != null) {
\r
1053 private def DataSchemaNode findCorrectTargetFromGrouping(DataSchemaNode node) {
\r
1054 if (node.path.path.size == 1) {
\r
1055 // uses is under module statement
\r
1056 val Module m = findParentModule(schemaContext, node);
\r
1057 var DataSchemaNode result = null;
\r
1058 for (u : m.uses) {
\r
1059 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
\r
1060 if (!(targetGrouping instanceof GroupingDefinition)) {
\r
1061 throw new IllegalArgumentException("Failed to generate code for augment in " + u);
\r
1063 var gr = targetGrouping as GroupingDefinition;
\r
1064 result = gr.getDataChildByName(node.QName.localName);
\r
1066 if (result == null) {
\r
1067 throw new IllegalArgumentException("Failed to generate code for augment");
\r
1071 var DataSchemaNode result = null;
\r
1072 var String currentName = node.QName.localName;
\r
1073 var tmpPath = new ArrayList<String>();
\r
1074 var YangNode parent = node.parent;
\r
1076 tmpPath.add(currentName);
\r
1077 val dataNodeParent = parent as DataNodeContainer;
\r
1078 for (u : dataNodeParent.uses) {
\r
1079 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, u.groupingPath.path);
\r
1080 if (!(targetGrouping instanceof GroupingDefinition)) {
\r
1081 throw new IllegalArgumentException("Failed to generate code for augment in " + u);
\r
1083 var gr = targetGrouping as GroupingDefinition;
\r
1084 result = gr.getDataChildByName(currentName);
\r
1086 if (result == null) {
\r
1087 currentName = (parent as SchemaNode).QName.localName;
\r
1088 if (parent instanceof DataSchemaNode) {
\r
1089 parent = (parent as DataSchemaNode).parent;
\r
1091 parent = (parent as DataNodeContainer).parent;
\r
1094 } while (result == null && !(parent instanceof Module));
\r
1096 if (result != null) {
\r
1097 if (tmpPath.size == 1) {
\r
1100 var DataSchemaNode newParent = result;
\r
1101 Collections.reverse(tmpPath);
\r
1102 tmpPath.remove(0);
\r
1103 for (name : tmpPath) {
\r
1104 newParent = (newParent as DataNodeContainer).getDataChildByName(name);
\r
1115 * Convenient method to find node added by uses statement.
\r
1117 private def DataSchemaNode findOriginalTargetFromGrouping(String targetSchemaNodeName, UsesNode parentUsesNode) {
\r
1118 var SchemaNode targetGrouping = findNodeInSchemaContext(schemaContext, parentUsesNode.groupingPath.path);
\r
1119 if (!(targetGrouping instanceof GroupingDefinition)) {
\r
1120 throw new IllegalArgumentException("Failed to generate code for augment in " + parentUsesNode);
\r
1123 var grouping = targetGrouping as GroupingDefinition;
\r
1124 var result = grouping.getDataChildByName(targetSchemaNodeName);
\r
1125 if (result == null) {
\r
1128 var boolean fromUses = result.addedByUses;
\r
1130 var Iterator<UsesNode> groupingUses = grouping.uses.iterator;
\r
1131 while (fromUses) {
\r
1132 if (groupingUses.hasNext()) {
\r
1133 grouping = findNodeInSchemaContext(schemaContext, groupingUses.next().groupingPath.path) as GroupingDefinition;
\r
1134 result = grouping.getDataChildByName(targetSchemaNodeName);
\r
1135 fromUses = result.addedByUses;
\r
1137 throw new NullPointerException("Failed to generate code for augment in " + parentUsesNode);
\r
1145 * Returns a generated type builder for an augmentation.
\r
1147 * The name of the type builder is equal to the name of augmented node with
\r
1148 * serial number as suffix.
\r
1150 * @param augmentPackageName
\r
1151 * string with contains the package name to which the augment
\r
1153 * @param targetPackageName
\r
1154 * string with the package name to which the augmented node
\r
1156 * @param targetSchemaNodeName
\r
1157 * string with the name of the augmented node
\r
1158 * @param augSchema
\r
1159 * augmentation schema which contains data about the child nodes
\r
1160 * and uses of augment
\r
1161 * @return generated type builder for augment
\r
1163 private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(String augmentPackageName, String basePackageName,
\r
1164 Type targetTypeRef, AugmentationSchema augSchema) {
\r
1165 var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);
\r
1166 if (augmentBuilders === null) {
\r
1167 augmentBuilders = new HashMap();
\r
1168 genTypeBuilders.put(augmentPackageName, augmentBuilders);
\r
1170 val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);
\r
1172 val augTypeName = if (augIdentifier !== null) {
\r
1173 parseToClassName(augIdentifier)
\r
1175 augGenTypeName(augmentBuilders, targetTypeRef.name);
\r
1178 val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);
\r
1180 augTypeBuilder.addImplementsType(DATA_OBJECT);
\r
1181 augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));
\r
1182 addImplementedInterfaceFromUses(augSchema, augTypeBuilder);
\r
1184 augSchemaNodeToMethods(basePackageName, augTypeBuilder, augSchema.childNodes);
\r
1185 augmentBuilders.put(augTypeName, augTypeBuilder);
\r
1186 return augTypeBuilder;
\r
1191 * @param unknownSchemaNodes
\r
1192 * @return nodeParameter of UnknownSchemaNode
\r
1194 private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {
\r
1195 for (unknownSchemaNode : unknownSchemaNodes) {
\r
1196 val nodeType = unknownSchemaNode.nodeType;
\r
1197 if(AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&
\r
1198 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {
\r
1199 return unknownSchemaNode.nodeParameter;
\r
1206 * Convert a container, list and choice subnodes (and recursivelly their
\r
1207 * subnodes) of augment to generated types
\r
1209 * @param augBasePackageName
\r
1210 * string with the augment package name
\r
1211 * @param augChildNodes
\r
1212 * set of data schema nodes which represents child nodes of the
\r
1215 * @return list of <code>Type</code> which represents container, list and
\r
1216 * choice subnodes of augment
\r
1218 private def List<Type> augmentationBodyToGenTypes(String augBasePackageName, Set<DataSchemaNode> augChildNodes, Module module) {
\r
1219 val List<Type> genTypes = new ArrayList();
\r
1220 val List<DataNodeIterator> augSchemaIts = new ArrayList();
\r
1221 for (childNode : augChildNodes) {
\r
1222 if (!childNode.addedByUses) {
\r
1225 if(childNode instanceof DataNodeContainer) {
\r
1226 augSchemaIts.add(new DataNodeIterator(childNode as DataNodeContainer));
\r
1228 if(childNode instanceof ContainerSchemaNode) {
\r
1229 genTypes.addAll(dataNodeContainerToGenType(augBasePackageName, childNode as ContainerSchemaNode, module));
\r
1230 } else if(childNode instanceof ListSchemaNode) {
\r
1231 genTypes.addAll(dataNodeContainerToGenType(augBasePackageName, childNode as ListSchemaNode, module));
\r
1233 } else if(childNode instanceof ChoiceNode) {
\r
1234 val choice = childNode as ChoiceNode;
\r
1235 for (caseNode : choice.cases) {
\r
1236 augSchemaIts.add(new DataNodeIterator(caseNode));
\r
1238 genTypes.addAll(choiceToGeneratedType(augBasePackageName, childNode as ChoiceNode, module));
\r
1245 for (it : augSchemaIts) {
\r
1246 val List<ContainerSchemaNode> augContainers = it.allContainers();
\r
1247 val List<ListSchemaNode> augLists = it.allLists();
\r
1248 val List<ChoiceNode> augChoices = it.allChoices();
\r
1250 if(augContainers !== null) {
\r
1251 for (container : augContainers) {
\r
1252 genTypes.addAll(dataNodeContainerToGenType(augBasePackageName, container, module));
\r
1255 if(augLists !== null) {
\r
1256 for (list : augLists) {
\r
1257 genTypes.addAll(dataNodeContainerToGenType(augBasePackageName, list, module));
\r
1260 if(augChoices !== null) {
\r
1261 for (choice : augChoices) {
\r
1262 genTypes.addAll(choiceToGeneratedType(augBasePackageName, choice, module));
\r
1270 * Returns first unique name for the augment generated type builder. The
\r
1271 * generated type builder name for augment consists from name of augmented
\r
1272 * node and serial number of its augmentation.
\r
1275 * map of builders which were created in the package to which the
\r
1276 * augmentation belongs
\r
1277 * @param genTypeName
\r
1278 * string with name of augmented node
\r
1279 * @return string with unique name for augmentation builder
\r
1281 private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {
\r
1283 while((builders !== null) && builders.containsKey(genTypeName + index)) {
\r
1284 index = index + 1;
\r
1286 return genTypeName + index;
\r
1290 * Adds the methods to <code>typeBuilder</code> which represent subnodes of
\r
1291 * node for which <code>typeBuilder</code> was created.
\r
1293 * The subnodes aren't mapped to the methods if they are part of grouping or
\r
1294 * augment (in this case are already part of them).
\r
1296 * @param basePackageName
\r
1297 * string contains the module package name
\r
1298 * @param typeBuilder
\r
1299 * generated type builder which represents any node. The subnodes
\r
1300 * of this node are added to the <code>typeBuilder</code> as
\r
1301 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1302 * container, choice.
\r
1303 * @param schemaNodes
\r
1304 * set of data schema nodes which are the children of the node
\r
1305 * for which <code>typeBuilder</code> was created
\r
1306 * @return generated type builder which is the same builder as input
\r
1307 * parameter. The getter methods (representing child nodes) could be
\r
1310 private def GeneratedTypeBuilder resolveDataSchemaNodes(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1311 Set<DataSchemaNode> schemaNodes) {
\r
1312 if((schemaNodes !== null) && (typeBuilder !== null)) {
\r
1313 for (schemaNode : schemaNodes) {
\r
1314 if(!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {
\r
1315 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
\r
1320 return typeBuilder;
\r
1323 private def GeneratedTypeBuilder resolveDataSchemaNodesAugmented(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1324 Set<DataSchemaNode> schemaNodes) {
\r
1325 if ((schemaNodes !== null) && (typeBuilder !== null)) {
\r
1326 for (schemaNode : schemaNodes) {
\r
1327 if (!schemaNode.isAddedByUses()) {
\r
1328 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
\r
1332 return typeBuilder;
\r
1336 * Adds the methods to <code>typeBuilder</code> what represents subnodes of
\r
1337 * node for which <code>typeBuilder</code> was created.
\r
1339 * @param basePackageName
\r
1340 * string contains the module package name
\r
1341 * @param typeBuilder
\r
1342 * generated type builder which represents any node. The subnodes
\r
1343 * of this node are added to the <code>typeBuilder</code> as
\r
1344 * methods. The subnode can be of type leaf, leaf-list, list,
\r
1345 * container, choice.
\r
1346 * @param schemaNodes
\r
1347 * set of data schema nodes which are the children of the node
\r
1348 * for which <code>typeBuilder</code> was created
\r
1349 * @return generated type builder which is the same object as the input
\r
1350 * parameter <code>typeBuilder</code>. The getter method could be
\r
1353 private def GeneratedTypeBuilder augSchemaNodeToMethods(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1354 Set<DataSchemaNode> schemaNodes) {
\r
1355 if((schemaNodes !== null) && (typeBuilder !== null)) {
\r
1356 for (schemaNode : schemaNodes) {
\r
1357 if (!schemaNode.isAugmenting()) {
\r
1358 addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);
\r
1362 return typeBuilder;
\r
1366 * Adds to <code>typeBuilder</code> a method which is derived from
\r
1367 * <code>schemaNode</code>.
\r
1369 * @param basePackageName
\r
1370 * string with the module package name
\r
1371 * @param schemaNode
\r
1372 * data schema node which is added to <code>typeBuilder</code> as
\r
1374 * @param typeBuilder
\r
1375 * generated type builder to which is <code>schemaNode</code>
\r
1376 * added as a method.
\r
1378 private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,
\r
1379 GeneratedTypeBuilder typeBuilder) {
\r
1380 if(node !== null && typeBuilder !== null) {
\r
1382 case node instanceof LeafSchemaNode:
\r
1383 resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)
\r
1384 case node instanceof LeafListSchemaNode:
\r
1385 resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)
\r
1386 case node instanceof ContainerSchemaNode:
\r
1387 resolveContainerSchemaNode(basePackageName, typeBuilder, node as ContainerSchemaNode)
\r
1388 case node instanceof ListSchemaNode:
\r
1389 resolveListSchemaNode(basePackageName, typeBuilder, node as ListSchemaNode)
\r
1390 case node instanceof ChoiceNode:
\r
1391 resolveChoiceSchemaNode(basePackageName, typeBuilder, node as ChoiceNode)
\r
1397 * Creates a getter method for a choice node.
\r
1399 * Firstly generated type builder for choice is created or found in
\r
1400 * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
\r
1401 * in the builder is created as concatenation of module package name and
\r
1402 * names of all parent nodes. In the end the getter method for choice is
\r
1403 * added to <code>typeBuilder</code> and return type is set to choice
\r
1406 * @param basePackageName
\r
1407 * string with the module package name
\r
1408 * @param typeBuilder
\r
1409 * generated type builder to which is <code>choiceNode</code>
\r
1410 * added as getter method
\r
1411 * @param choiceNode
\r
1412 * choice node which is mapped as a getter method
\r
1413 * @throws IllegalArgumentException
\r
1415 * <li>if <code>basePackageName</code> equals null</li>
\r
1416 * <li>if <code>typeBuilder</code> equals null</li>
\r
1417 * <li>if <code>choiceNode</code> equals null</li>
\r
1421 private def void resolveChoiceSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1422 ChoiceNode choiceNode) {
\r
1423 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1424 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
\r
1425 checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
\r
1427 val choiceName = choiceNode.QName.localName;
\r
1428 if(choiceName !== null && !choiceNode.isAddedByUses()) {
\r
1429 val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
\r
1430 val choiceType = addDefaultInterfaceDefinition(packageName, choiceNode);
\r
1431 constructGetter(typeBuilder, choiceName, choiceNode.description, choiceType);
\r
1436 * Converts <code>choiceNode</code> to the list of generated types for
\r
1437 * choice and its cases.
\r
1439 * The package names for choice and for its cases are created as
\r
1440 * concatenation of the module package (<code>basePackageName</code>) and
\r
1441 * names of all parents node.
\r
1443 * @param basePackageName
\r
1444 * string with the module package name
\r
1445 * @param choiceNode
\r
1446 * choice node which is mapped to generated type. Also child
\r
1447 * nodes - cases are mapped to generated types.
\r
1448 * @return list of generated types which contains generated type for choice
\r
1449 * and generated types for all cases which aren't added do choice
\r
1450 * through <i>uses</i>.
\r
1451 * @throws IllegalArgumentException
\r
1453 * <li>if <code>basePackageName</code> equals null</li>
\r
1454 * <li>if <code>choiceNode</code> equals null</li>
\r
1458 private def List<Type> choiceToGeneratedType(String basePackageName, ChoiceNode choiceNode, Module module) {
\r
1459 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1460 checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");
\r
1462 val List<Type> generatedTypes = new ArrayList();
\r
1463 val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);
\r
1464 val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);
\r
1466 choiceTypeBuilder.addImplementsType(DataContainer.typeForClass);
\r
1467 val choiceType = choiceTypeBuilder.toInstance();
\r
1469 generatedTypes.add(choiceType);
\r
1470 val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;
\r
1471 if((caseNodes !== null) && !caseNodes.isEmpty()) {
\r
1472 generatedTypes.addAll(generateTypesFromChoiceCases(basePackageName, choiceType, caseNodes, module));
\r
1474 return generatedTypes;
\r
1478 * Converts <code>caseNodes</code> set to list of corresponding generated
\r
1481 * For every <i>case</i> which isn't added through augment or <i>uses</i> is
\r
1482 * created generated type builder. The package names for the builder is
\r
1483 * created as concatenation of the module package (
\r
1484 * <code>basePackageName</code>) and names of all parents nodes of the
\r
1485 * concrete <i>case</i>. There is also relation "<i>implements type</i>"
\r
1486 * between every case builder and <i>choice</i> type
\r
1488 * @param basePackageName
\r
1489 * string with the module package name
\r
1490 * @param refChoiceType
\r
1491 * type which represents superior <i>case</i>
\r
1492 * @param caseNodes
\r
1493 * set of choice case nodes which are mapped to generated types
\r
1494 * @return list of generated types for <code>caseNodes</code>.
\r
1495 * @throws IllegalArgumentException
\r
1497 * <li>if <code>basePackageName</code> equals null</li>
\r
1498 * <li>if <code>refChoiceType</code> equals null</li>
\r
1499 * <li>if <code>caseNodes</code> equals null</li>
\r
1503 private def List<Type> generateTypesFromChoiceCases(String basePackageName, Type refChoiceType,
\r
1504 Set<ChoiceCaseNode> caseNodes, Module module) {
\r
1505 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1506 checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
\r
1507 checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
\r
1509 val List<Type> generatedTypes = new ArrayList();
\r
1510 for (caseNode : caseNodes) {
\r
1511 if(caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {
\r
1512 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
\r
1513 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
\r
1514 caseTypeBuilder.addImplementsType(refChoiceType);
\r
1516 val Set<DataSchemaNode> childNodes = caseNode.childNodes;
\r
1517 if(childNodes !== null) {
\r
1518 resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);
\r
1520 generatedTypes.add(caseTypeBuilder.toInstance());
\r
1523 generatedTypes.addAll(processUsesAugments(caseNode, module));
\r
1526 return generatedTypes;
\r
1530 * Generates list of generated types for all the cases of a choice which are
\r
1531 * added to the choice through the augment.
\r
1534 * @param basePackageName
\r
1535 * string contains name of package to which augment belongs. If
\r
1536 * an augmented choice is from an other package (pcg1) than an
\r
1537 * augmenting choice (pcg2) then case's of the augmenting choice
\r
1538 * will belong to pcg2.
\r
1539 * @param refChoiceType
\r
1540 * Type which represents the choice to which case belongs. Every
\r
1541 * case has to contain its choice in extend part.
\r
1542 * @param caseNodes
\r
1543 * set of choice case nodes for which is checked if are/aren't
\r
1544 * added to choice through augmentation
\r
1545 * @return list of generated types which represents augmented cases of
\r
1546 * choice <code>refChoiceType</code>
\r
1547 * @throws IllegalArgumentException
\r
1549 * <li>if <code>basePackageName</code> equals null</li>
\r
1550 * <li>if <code>refChoiceType</code> equals null</li>
\r
1551 * <li>if <code>caseNodes</code> equals null</li>
\r
1554 private def List<GeneratedType> generateTypesFromAugmentedChoiceCases(String basePackageName, Type refChoiceType,
\r
1555 Set<DataSchemaNode> caseNodes, ChoiceNode targetNode) {
\r
1556 checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");
\r
1557 checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");
\r
1558 checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");
\r
1560 val List<GeneratedType> generatedTypes = new ArrayList();
\r
1561 for (caseNode : caseNodes) {
\r
1562 if(caseNode !== null) {
\r
1563 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);
\r
1564 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);
\r
1565 caseTypeBuilder.addImplementsType(refChoiceType);
\r
1567 if (caseNode instanceof DataNodeContainer) {
\r
1568 val DataNodeContainer dataNodeCase = caseNode as DataNodeContainer;
\r
1569 val Set<DataSchemaNode> childNodes = dataNodeCase.childNodes;
\r
1570 if(childNodes !== null) {
\r
1571 resolveDataSchemaNodesAugmented(basePackageName, caseTypeBuilder, childNodes);
\r
1574 val ChoiceCaseNode node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());
\r
1575 val Set<DataSchemaNode> childNodes = node.childNodes;
\r
1576 if(childNodes !== null) {
\r
1577 resolveDataSchemaNodesAugmented(basePackageName, caseTypeBuilder, childNodes);
\r
1581 generatedTypes.add(caseTypeBuilder.toInstance());
\r
1585 return generatedTypes;
\r
1589 * Converts <code>leaf</code> to the getter method which is added to
\r
1590 * <code>typeBuilder</code>.
\r
1592 * @param typeBuilder
\r
1593 * generated type builder to which is added getter method as
\r
1594 * <code>leaf</code> mapping
\r
1596 * leaf schema node which is mapped as getter method which is
\r
1597 * added to <code>typeBuilder</code>
\r
1598 * @return boolean value
\r
1600 * <li>false - if <code>leaf</code> or <code>typeBuilder</code> are
\r
1602 * <li>true - in other cases</li>
\r
1605 private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {
\r
1606 if((leaf !== null) && (typeBuilder !== null)) {
\r
1607 val leafName = leaf.QName.localName;
\r
1608 var String leafDesc = leaf.description;
\r
1609 if(leafDesc === null) {
\r
1613 val parentModule = findParentModule(schemaContext, leaf);
\r
1614 if(leafName !== null && !leaf.isAddedByUses()) {
\r
1615 val TypeDefinition<?> typeDef = leaf.type;
\r
1617 var Type returnType = null;
\r
1618 if(typeDef instanceof EnumTypeDefinition) {
\r
1619 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
\r
1620 val enumTypeDef = typeDef as EnumTypeDefinition;
\r
1621 val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName, typeBuilder);
\r
1623 if(enumBuilder !== null) {
\r
1624 returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);
\r
1626 (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);
\r
1627 } else if(typeDef instanceof UnionType) {
\r
1628 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
\r
1629 if(genTOBuilder !== null) {
\r
1630 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1632 } else if(typeDef instanceof BitsTypeDefinition) {
\r
1633 val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);
\r
1634 if(genTOBuilder !== null) {
\r
1635 returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);
\r
1638 returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
\r
1640 if(returnType !== null) {
\r
1641 val MethodSignatureBuilder getter = constructGetter(typeBuilder, leafName, leafDesc, returnType);
\r
1642 processContextRefExtension(leaf, getter, parentModule);
\r
1650 private def void processContextRefExtension(LeafSchemaNode leaf, MethodSignatureBuilder getter, Module module) {
\r
1651 for (node : leaf.unknownSchemaNodes) {
\r
1652 val nodeType = node.nodeType;
\r
1653 if ("context-reference".equals(nodeType.localName)) {
\r
1654 val nodeParam = node.nodeParameter;
\r
1655 var IdentitySchemaNode identity = null;
\r
1656 var String basePackageName = null;
\r
1657 val String[] splittedElement = nodeParam.split(":");
\r
1658 if (splittedElement.length == 1) {
\r
1659 identity = findIdentityByName(module.identities, splittedElement.get(0));
\r
1660 basePackageName = moduleNamespaceToPackageName(module);
\r
1661 } else if (splittedElement.length == 2) {
\r
1662 var prefix = splittedElement.get(0);
\r
1663 val Module dependentModule = findModuleFromImports(module.imports, prefix)
\r
1664 if (dependentModule == null) {
\r
1665 throw new IllegalArgumentException("Failed to process context-reference: unknown prefix " + prefix);
\r
1667 identity = findIdentityByName(dependentModule.identities, splittedElement.get(1));
\r
1668 basePackageName = moduleNamespaceToPackageName(dependentModule);
\r
1670 throw new IllegalArgumentException("Failed to process context-reference: unknown identity " + nodeParam);
\r
1672 if (identity == null) {
\r
1673 throw new IllegalArgumentException("Failed to process context-reference: unknown identity " + nodeParam);
\r
1676 val Class<RoutingContext> clazz = typeof(RoutingContext);
\r
1677 val AnnotationTypeBuilder rc = getter.addAnnotation(clazz.package.name, clazz.simpleName);
\r
1678 val packageName = packageNameForGeneratedType(basePackageName, identity.path);
\r
1679 val genTypeName = parseToClassName(identity.QName.localName);
\r
1680 rc.addParameter("value", packageName + "." + genTypeName + ".class");
\r
1685 private def IdentitySchemaNode findIdentityByName(Set<IdentitySchemaNode> identities, String name) {
\r
1686 for (id : identities) {
\r
1687 if (id.QName.localName.equals(name)) {
\r
1694 private def Module findModuleFromImports(Set<ModuleImport> imports, String prefix) {
\r
1695 for (imp : imports) {
\r
1696 if (imp.prefix.equals(prefix)) {
\r
1697 return schemaContext.findModuleByName(imp.moduleName, imp.revision);
\r
1704 * Converts <code>leaf</code> schema node to property of generated TO
\r
1707 * @param toBuilder
\r
1708 * generated TO builder to which is <code>leaf</code> added as
\r
1711 * leaf schema node which is added to <code>toBuilder</code> as
\r
1713 * @param isReadOnly
\r
1714 * boolean value which says if leaf property is|isn't read only
\r
1715 * @return boolean value
\r
1717 * <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf
\r
1718 * name equals null or if leaf is added by <i>uses</i>.</li>
\r
1719 * <li>true - other cases</li>
\r
1722 private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,
\r
1723 boolean isReadOnly) {
\r
1724 if((leaf !== null) && (toBuilder !== null)) {
\r
1725 val leafName = leaf.QName.localName;
\r
1726 var String leafDesc = leaf.description;
\r
1727 if(leafDesc === null) {
\r
1731 if(leafName !== null) {
\r
1732 val TypeDefinition<?> typeDef = leaf.type;
\r
1734 // TODO: properly resolve enum types
\r
1735 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);
\r
1737 if(returnType !== null) {
\r
1738 val propBuilder = toBuilder.addProperty(parseToClassName(leafName));
\r
1740 propBuilder.setReadOnly(isReadOnly);
\r
1741 propBuilder.setReturnType(returnType);
\r
1742 propBuilder.setComment(leafDesc);
\r
1744 toBuilder.addEqualsIdentity(propBuilder);
\r
1745 toBuilder.addHashIdentity(propBuilder);
\r
1746 toBuilder.addToStringProperty(propBuilder);
\r
1756 * Converts <code>node</code> leaf list schema node to getter method of
\r
1757 * <code>typeBuilder</code>.
\r
1759 * @param typeBuilder
\r
1760 * generated type builder to which is <code>node</code> added as
\r
1763 * leaf list schema node which is added to
\r
1764 * <code>typeBuilder</code> as getter method
\r
1765 * @return boolean value
\r
1767 * <li>true - if <code>node</code>, <code>typeBuilder</code>,
\r
1768 * nodeName equal null or <code>node</code> is added by <i>uses</i></li>
\r
1769 * <li>false - other cases</li>
\r
1772 private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {
\r
1773 if((node !== null) && (typeBuilder !== null)) {
\r
1774 val nodeName = node.QName.localName;
\r
1775 var String nodeDesc = node.description;
\r
1776 if(nodeDesc === null) {
\r
1780 if(nodeName !== null && !node.isAddedByUses()) {
\r
1781 val TypeDefinition<?> type = node.type;
\r
1782 val listType = Types.listTypeFor(typeProvider.javaTypeForSchemaDefinitionType(type, node));
\r
1784 constructGetter(typeBuilder, nodeName, nodeDesc, listType);
\r
1792 * Creates a getter method for a container node.
\r
1794 * Firstly generated type builder for container is created or found in
\r
1795 * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
\r
1796 * in the builder is created as concatenation of module package name and
\r
1797 * names of all parent nodes. In the end the getter method for container is
\r
1798 * added to <code>typeBuilder</code> and return type is set to container
\r
1801 * @param basePackageName
\r
1802 * string with the module package name
\r
1803 * @param typeBuilder
\r
1804 * generated type builder to which is <code>containerNode</code>
\r
1805 * added as getter method
\r
1806 * @param containerNode
\r
1807 * container schema node which is mapped as getter method to
\r
1808 * <code>typeBuilder</code>
\r
1809 * @return boolean value
\r
1811 * <li>false - if <code>containerNode</code>,
\r
1812 * <code>typeBuilder</code>, container node name equal null or
\r
1813 * <code>containerNode</code> is added by uses</li>
\r
1814 * <li>true - other cases</li>
\r
1817 private def boolean resolveContainerSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1818 ContainerSchemaNode containerNode) {
\r
1819 if((containerNode !== null) && (typeBuilder !== null)) {
\r
1820 val nodeName = containerNode.QName.localName;
\r
1822 if(nodeName !== null && !containerNode.isAddedByUses()) {
\r
1823 val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);
\r
1825 val rawGenType = addDefaultInterfaceDefinition(packageName, containerNode);
\r
1826 constructGetter(typeBuilder, nodeName, containerNode.description, rawGenType);
\r
1835 * Creates a getter method for a list node.
\r
1837 * Firstly generated type builder for list is created or found in
\r
1838 * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name
\r
1839 * in the builder is created as concatenation of module package name and
\r
1840 * names of all parent nodes. In the end the getter method for list is added
\r
1841 * to <code>typeBuilder</code> and return type is set to list type builder.
\r
1843 * @param basePackageName
\r
1844 * string with the module package name
\r
1845 * @param typeBuilder
\r
1846 * generated type builder to which is <code></code> added as
\r
1849 * list schema node which is mapped as getter method to
\r
1850 * <code>typeBuilder</code>
\r
1851 * @return boolean value
\r
1853 * <li>false - if <code>listNode</code>, <code>typeBuilder</code>,
\r
1854 * list node name equal null or <code>listNode</code> is added by
\r
1856 * <li>true - other cases</li>
\r
1859 private def boolean resolveListSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,
\r
1860 ListSchemaNode listNode) {
\r
1861 if((listNode !== null) && (typeBuilder !== null)) {
\r
1862 val listName = listNode.QName.localName;
\r
1864 if(listName !== null && !listNode.isAddedByUses()) {
\r
1865 val packageName = packageNameForGeneratedType(basePackageName, listNode.path);
\r
1866 val rawGenType = addDefaultInterfaceDefinition(packageName, listNode);
\r
1867 constructGetter(typeBuilder, listName, listNode.description, Types.listTypeFor(rawGenType));
\r
1875 * Instantiates generated type builder with <code>packageName</code> and
\r
1876 * <code>schemaNode</code>.
\r
1878 * The new builder always implements
\r
1879 * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />
\r
1880 * If <code>schemaNode</code> is instance of GroupingDefinition it also
\r
1881 * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable
\r
1882 * Augmentable}.<br />
\r
1883 * If <code>schemaNode</code> is instance of
\r
1884 * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer
\r
1885 * DataNodeContainer} it can also implement nodes which are specified in
\r
1888 * @param packageName
\r
1889 * string with the name of the package to which
\r
1890 * <code>schemaNode</code> belongs.
\r
1891 * @param schemaNode
\r
1892 * schema node for which is created generated type builder
\r
1893 * @return generated type builder <code>schemaNode</code>
\r
1895 private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {
\r
1896 val builder = addRawInterfaceDefinition(packageName, schemaNode, "");
\r
1897 builder.addImplementsType(DATA_OBJECT);
\r
1898 if(!(schemaNode instanceof GroupingDefinition)) {
\r
1899 builder.addImplementsType(augmentable(builder));
\r
1902 if(schemaNode instanceof DataNodeContainer) {
\r
1903 addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, builder);
\r
1910 * Wraps the calling of the same overloaded method.
\r
1912 * @param packageName
\r
1913 * string with the package name to which returning generated type
\r
1915 * @param schemaNode
\r
1916 * schema node which provide data about the schema node name
\r
1917 * @return generated type builder for <code>schemaNode</code>
\r
1919 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {
\r
1920 return addRawInterfaceDefinition(packageName, schemaNode, "");
\r
1924 * Returns reference to generated type builder for specified
\r
1925 * <code>schemaNode</code> with <code>packageName</code>.
\r
1927 * Firstly the generated type builder is searched in
\r
1928 * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't
\r
1929 * found it is created and added to <code>genTypeBuilders</code>.
\r
1931 * @param packageName
\r
1932 * string with the package name to which returning generated type
\r
1934 * @param schemaNode
\r
1935 * schema node which provide data about the schema node name
\r
1936 * @return generated type builder for <code>schemaNode</code>
\r
1937 * @throws IllegalArgumentException
\r
1939 * <li>if <code>schemaNode</code> equals null</li>
\r
1940 * <li>if <code>packageName</code> equals null</li>
\r
1941 * <li>if Q name of schema node is null</li>
\r
1942 * <li>if schema node name is nul</li>
\r
1946 private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,
\r
1948 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
\r
1949 checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");
\r
1950 checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");
\r
1951 val schemaNodeName = schemaNode.QName.localName;
\r
1952 checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");
\r
1954 var String genTypeName;
\r
1955 if(prefix === null) {
\r
1956 genTypeName = parseToClassName(schemaNodeName);
\r
1958 genTypeName = prefix + parseToClassName(schemaNodeName);
\r
1961 //FIXME: Validation of name conflict
\r
1962 val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);
\r
1963 yangToJavaMapping.put(schemaNode.path, newType);
\r
1964 if(!genTypeBuilders.containsKey(packageName)) {
\r
1965 val Map<String, GeneratedTypeBuilder> builders = new HashMap();
\r
1966 builders.put(genTypeName, newType);
\r
1967 genTypeBuilders.put(packageName, builders);
\r
1969 val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);
\r
1970 if(!builders.containsKey(genTypeName)) {
\r
1971 builders.put(genTypeName, newType);
\r
1978 * Creates the name of the getter method from <code>methodName</code>.
\r
1980 * @param methodName
\r
1981 * string with the name of the getter method
\r
1982 * @return string with the name of the getter method for
\r
1983 * <code>methodName</code> in JAVA method format
\r
1985 private def String getterMethodName(String methodName, Type returnType) {
\r
1986 val method = new StringBuilder();
\r
1987 if(BOOLEAN.equals(returnType)) {
\r
1988 method.append("is");
\r
1990 method.append("get");
\r
1992 method.append(parseToClassName(methodName));
\r
1993 return method.toString();
\r
1997 * Created a method signature builder as part of
\r
1998 * <code>interfaceBuilder</code>.
\r
2000 * The method signature builder is created for the getter method of
\r
2001 * <code>schemaNodeName</code>. Also <code>comment</code> and
\r
2002 * <code>returnType</code> information are added to the builder.
\r
2004 * @param interfaceBuilder
\r
2005 * generated type builder for which the getter method should be
\r
2007 * @param schemaNodeName
\r
2008 * string with schema node name. The name will be the part of the
\r
2009 * getter method name.
\r
2011 * string with comment for the getter method
\r
2012 * @param returnType
\r
2013 * type which represents the return type of the getter method
\r
2014 * @return method signature builder which represents the getter method of
\r
2015 * <code>interfaceBuilder</code>
\r
2017 private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,
\r
2018 String comment, Type returnType) {
\r
2020 val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));
\r
2022 getMethod.setComment(comment);
\r
2023 getMethod.setReturnType(returnType);
\r
2029 * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method
\r
2030 * or to <code>genTOBuilder</code> as property.
\r
2032 * @param basePackageName
\r
2033 * string contains the module package name
\r
2034 * @param schemaNode
\r
2035 * data schema node which should be added as getter method to
\r
2036 * <code>typeBuilder</code> or as a property to
\r
2037 * <code>genTOBuilder</code> if is part of the list key
\r
2038 * @param typeBuilder
\r
2039 * generated type builder for the list schema node
\r
2040 * @param genTOBuilder
\r
2041 * generated TO builder for the list keys
\r
2043 * list of string which contains names of the list keys
\r
2044 * @throws IllegalArgumentException
\r
2046 * <li>if <code>schemaNode</code> equals null</li>
\r
2047 * <li>if <code>typeBuilder</code> equals null</li>
\r
2050 private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,
\r
2051 GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys) {
\r
2052 checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");
\r
2054 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
\r
2056 if(schemaNode instanceof LeafSchemaNode) {
\r
2057 val leaf = schemaNode as LeafSchemaNode;
\r
2058 val leafName = leaf.QName.localName;
\r
2059 if(!listKeys.contains(leafName)) {
\r
2060 resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);
\r
2062 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);
\r
2064 } else if (!schemaNode.addedByUses) {
\r
2065 if (schemaNode instanceof LeafListSchemaNode) {
\r
2066 resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);
\r
2067 } else if(schemaNode instanceof ContainerSchemaNode) {
\r
2068 resolveContainerSchemaNode(basePackageName, typeBuilder, schemaNode as ContainerSchemaNode);
\r
2069 } else if(schemaNode instanceof ChoiceNode) {
\r
2070 resolveChoiceSchemaNode(basePackageName,typeBuilder,schemaNode as ChoiceNode);
\r
2071 } else if(schemaNode instanceof ListSchemaNode) {
\r
2072 resolveListSchemaNode(basePackageName, typeBuilder, schemaNode as ListSchemaNode);
\r
2077 private def typeBuildersToGenTypes(GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {
\r
2078 val List<Type> genTypes = new ArrayList();
\r
2079 checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");
\r
2081 if(genTOBuilder !== null) {
\r
2082 val genTO = genTOBuilder.toInstance();
\r
2083 constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);
\r
2084 genTypes.add(genTO);
\r
2086 genTypes.add(typeBuilder.toInstance());
\r
2091 * Selects the names of the list keys from <code>list</code> and returns
\r
2092 * them as the list of the strings
\r
2095 * of string with names of the list keys
\r
2096 * @return list of string which represents names of the list keys. If the
\r
2097 * <code>list</code> contains no keys then the empty list is
\r
2100 private def listKeys(ListSchemaNode list) {
\r
2101 val List<String> listKeys = new ArrayList();
\r
2103 if(list.keyDefinition !== null) {
\r
2104 val keyDefinitions = list.keyDefinition;
\r
2105 for (keyDefinition : keyDefinitions) {
\r
2106 listKeys.add(keyDefinition.localName);
\r
2113 * Generates for the <code>list</code> which contains any list keys special
\r
2114 * generated TO builder.
\r
2116 * @param packageName
\r
2117 * string with package name to which the list belongs
\r
2119 * list schema node which is source of data about the list name
\r
2120 * @return generated TO builder which represents the keys of the
\r
2121 * <code>list</code> or null if <code>list</code> is null or list of
\r
2122 * key definitions is null or empty.
\r
2124 private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {
\r
2125 var GeneratedTOBuilder genTOBuilder = null;
\r
2126 if((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {
\r
2127 if(list !== null) {
\r
2128 val listName = list.QName.localName + "Key";
\r
2129 val String genTOName = parseToClassName(listName);
\r
2130 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);
\r
2133 return genTOBuilder;
\r
2138 * Builds generated TO builders for <code>typeDef</code> of type
\r
2139 * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or
\r
2140 * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition
\r
2141 * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as
\r
2142 * enclosing transfer object.
\r
2144 * If more then one generated TO builder is created for enclosing then all
\r
2145 * of the generated TO builders are added to <code>typeBuilder</code> as
\r
2146 * enclosing transfer objects.
\r
2149 * type definition which can be of type <code>UnionType</code> or
\r
2150 * <code>BitsTypeDefinition</code>
\r
2151 * @param typeBuilder
\r
2152 * generated type builder to which is added generated TO created
\r
2153 * from <code>typeDef</code>
\r
2155 * string with name for generated TO builder
\r
2156 * @return generated TO builder for <code>typeDef</code>
\r
2158 private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,
\r
2159 String leafName, LeafSchemaNode leaf, Module parentModule) {
\r
2160 val classNameFromLeaf = parseToClassName(leafName);
\r
2161 val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();
\r
2162 val packageName = typeBuilder.fullyQualifiedName;
\r
2163 if(typeDef instanceof UnionTypeDefinition) {
\r
2164 genTOBuilders.addAll(
\r
2165 (typeProvider as TypeProviderImpl).
\r
2166 provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),
\r
2167 classNameFromLeaf, leaf));
\r
2168 } else if(typeDef instanceof BitsTypeDefinition) {
\r
2169 genTOBuilders.add(
\r
2170 ((typeProvider as TypeProviderImpl) ).
\r
2171 provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));
\r
2173 if(genTOBuilders !== null && !genTOBuilders.isEmpty()) {
\r
2174 for (genTOBuilder : genTOBuilders) {
\r
2175 typeBuilder.addEnclosingTransferObject(genTOBuilder);
\r
2177 return genTOBuilders.get(0);
\r
2184 * Adds the implemented types to type builder.
\r
2186 * The method passes through the list of <i>uses</i> in
\r
2187 * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding
\r
2188 * generated type from {@link BindingGeneratorImpl#allGroupings
\r
2189 * allGroupings} which is added as <i>implements type</i> to
\r
2190 * <code>builder</code>
\r
2192 * @param dataNodeContainer
\r
2193 * element which contains the list of used YANG groupings
\r
2195 * builder to which are added implemented types according to
\r
2196 * <code>dataNodeContainer</code>
\r
2197 * @return generated type builder with all implemented types
\r
2199 private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {
\r
2200 for (usesNode : dataNodeContainer.uses) {
\r
2201 if(usesNode.groupingPath !== null) {
\r
2202 val genType = allGroupings.get(usesNode.groupingPath);
\r
2203 if(genType === null) {
\r
2204 throw new IllegalStateException(
\r
2205 "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);
\r
2207 builder.addImplementsType(genType);
\r
Code Review / yangtools.git / blob