code-generator/binding-generator-impl/src/main/java/org/opendaylight/yangtools/sal/binding/generator/impl/BindingGeneratorImpl.xtend

   1 /*\r
   2  * Copyright (c) 2013 Cisco Systems, Inc. and others.  All rights reserved.\r
   3  *\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
   7  */\r
   8 package org.opendaylight.yangtools.sal.binding.generator.impl;\r
   9 \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;\rimport org.opendaylight.yangtools.yang.common.QName
  65 import org.opendaylight.yangtools.yang.model.api.UsesNode
  66 import java.util.HashSet
  67
  68 public class BindingGeneratorImpl implements BindingGenerator {\r
  69     /**\r
  70      * Outter key represents the package name. Outter value represents map of\r
  71      * all builders in the same package. Inner key represents the schema node\r
  72      * name (in JAVA class/interface name format). Inner value represents\r
  73      * instance of builder for schema node specified in key part.\r
  74      */\r
  75     private Map<String, Map<String, GeneratedTypeBuilder>> genTypeBuilders;\r
  76 \r
  77     /**\r
  78      * Provide methods for converting YANG types to JAVA types.\r
  79      */\r
  80     private var TypeProvider typeProvider;\r
  81 \r
  82     /**\r
  83      * Holds reference to schema context to resolve data of augmented elemnt\r
  84      * when creating augmentation builder\r
  85      */\r
  86     private var SchemaContext schemaContext;\r
  87 \r
  88     /**\r
  89      * Each grouping which is converted from schema node to generated type is\r
  90      * added to this map with its Schema path as key to make it easier to get\r
  91      * reference to it. In schema nodes in <code>uses</code> attribute there is\r
  92      * only Schema Path but when building list of implemented interfaces for\r
  93      * Schema node the object of type <code>Type</code> is required. So in this\r
  94      * case is used this map.\r
  95      */\r
  96     private val allGroupings = new HashMap<SchemaPath, GeneratedType>();\r
  97 \r
  98     private val yangToJavaMapping = new HashMap<SchemaPath, Type>();\r
  99 \r
 100     /**\r
 101      * Constant with the concrete name of namespace.\r
 102      */\r
 103     private val static String YANG_EXT_NAMESPACE = "urn:opendaylight:yang:extension:yang-ext";\r
 104 \r
 105     /**\r
 106      * Constant with the concrete name of identifier.\r
 107      */\r
 108     private val static String AUGMENT_IDENTIFIER_NAME = "augment-identifier";\r
 109 \r
 110     /**\r
 111      * Resolves generated types from <code>context</code> schema nodes of all\r
 112      * modules.\r
 113      *\r
 114      * Generated types are created for modules, groupings, types, containers,\r
 115      * lists, choices, augments, rpcs, notification, identities.\r
 116      *\r
 117      * @param context\r
 118      *            schema context which contains data about all schema nodes\r
 119      *            saved in modules\r
 120      * @return list of types (usually <code>GeneratedType</code>\r
 121      *         <code>GeneratedTransferObject</code>which are generated from\r
 122      *         <code>context</code> data.\r
 123      * @throws IllegalArgumentException\r
 124      *             if param <code>context</code> is null\r
 125      * @throws IllegalStateException\r
 126      *             if <code>context</code> contain no modules\r
 127      */\r
 128     override generateTypes(SchemaContext context) {\r
 129         checkArgument(context !== null, "Schema Context reference cannot be NULL.");\r
 130         checkState(context.modules !== null, "Schema Context does not contain defined modules.");\r
 131         schemaContext = context;\r
 132         typeProvider = new TypeProviderImpl(context);\r
 133         val Set<Module> modules = context.modules;\r
 134         return generateTypes(context, modules);\r
 135     }\r
 136 \r
 137     /**\r
 138      * Resolves generated types from <code>context</code> schema nodes only for\r
 139      * modules specified in <code>modules</code>\r
 140      *\r
 141      * Generated types are created for modules, groupings, types, containers,\r
 142      * lists, choices, augments, rpcs, notification, identities.\r
 143      *\r
 144      * @param context\r
 145      *            schema context which contains data about all schema nodes\r
 146      *            saved in modules\r
 147      * @param modules\r
 148      *            set of modules for which schema nodes should be generated\r
 149      *            types\r
 150      * @return list of types (usually <code>GeneratedType</code> or\r
 151      *         <code>GeneratedTransferObject</code>) which:\r
 152      *         <ul>\r
 153      *         <li>are generated from <code>context</code> schema nodes and</li>\r
 154      *         <li>are also part of some of the module in <code>modules</code>\r
 155      *         set</li>.\r
 156      *         </ul>\r
 157      * @throws IllegalArgumentException\r
 158      *             <ul>\r
 159      *             <li>if param <code>context</code> is null or</li>\r
 160      *             <li>if param <code>modules</code> is null</li>\r
 161      *             </ul>\r
 162      * @throws IllegalStateException\r
 163      *             if <code>context</code> contain no modules\r
 164      */\r
 165     override generateTypes(SchemaContext context, Set<Module> modules) {\r
 166         checkArgument(context !== null, "Schema Context reference cannot be NULL.");\r
 167         checkState(context.modules !== null, "Schema Context does not contain defined modules.");\r
 168         checkArgument(modules !== null, "Set of Modules cannot be NULL.");\r
 169 \r
 170         val List<Type> filteredGenTypes = new ArrayList();\r
 171 \r
 172         schemaContext = context;\r
 173         typeProvider = new TypeProviderImpl(context);\r
 174         val contextModules = ModuleDependencySort.sort(context.modules);\r
 175         genTypeBuilders = new HashMap();\r
 176 \r
 177         for (contextModule : contextModules) {\r
 178             val List<Type> generatedTypes = new ArrayList();\r
 179             generatedTypes.addAll(allTypeDefinitionsToGenTypes(contextModule));\r
 180             generatedTypes.addAll(allGroupingsToGenTypes(contextModule));\r
 181             if(false == contextModule.childNodes.isEmpty()) {\r
 182                 generatedTypes.add(moduleToDataType(contextModule));\r
 183             }\r
 184             generatedTypes.addAll(allContainersToGenTypes(contextModule));\r
 185             generatedTypes.addAll(allListsToGenTypes(contextModule));\r
 186             generatedTypes.addAll(allChoicesToGenTypes(contextModule));\r
 187             generatedTypes.addAll(allRPCMethodsToGenType(contextModule));\r
 188             generatedTypes.addAll(allNotificationsToGenType(contextModule));\r
 189             generatedTypes.addAll(allIdentitiesToGenTypes(contextModule, context));\r
 190 \r
 191             if(modules.contains(contextModule)) {\r
 192                 filteredGenTypes.addAll(generatedTypes);\r
 193             }\r
 194         }\r
 195         for (contextModule : contextModules) {\r
 196             val generatedTypes = (allAugmentsToGenTypes(contextModule));\r
 197             if(modules.contains(contextModule)) {\r
 198                 filteredGenTypes.addAll(generatedTypes);\r
 199             }\r
 200 \r
 201         }\r
 202         return filteredGenTypes;\r
 203     }\r
 204 \r
 205     /**\r
 206      * Converts all extended type definitions of module to the list of\r
 207      * <code>Type</code> objects.\r
 208      *\r
 209      * @param module\r
 210      *            module from which is obtained set of type definitions\r
 211      * @return list of <code>Type</code> which are generated from extended\r
 212      *         definition types (object of type <code>ExtendedType</code>)\r
 213      * @throws IllegalArgumentException\r
 214      *             <ul>\r
 215      *             <li>if module equals null</li>\r
 216      *             <li>if name of module equals null</li>\r
 217      *             <li>if type definitions of module equal null</li>\r
 218      *             </ul>\r
 219      *\r
 220      */\r
 221     private def List<Type> allTypeDefinitionsToGenTypes(Module module) {\r
 222         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 223         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 224         val Set<TypeDefinition<?>> typeDefinitions = module.typeDefinitions;\r
 225         checkState(typeDefinitions !== null, '''Type Definitions for module «module.name» cannot be NULL.''');\r
 226 \r
 227         val List<Type> generatedTypes = new ArrayList();\r
 228         for (TypeDefinition<?> typedef : typeDefinitions) {\r
 229             if(typedef !== null) {\r
 230                 val type = (typeProvider as TypeProviderImpl).generatedTypeForExtendedDefinitionType(typedef, typedef);\r
 231                 if((type !== null) && !generatedTypes.contains(type)) {\r
 232                     generatedTypes.add(type);\r
 233                 }\r
 234             }\r
 235         }\r
 236         return generatedTypes;\r
 237     }\r
 238 \r
 239     /**\r
 240      * Converts all <b>containers</b> of the module to the list of\r
 241      * <code>Type</code> objects.\r
 242      *\r
 243      * @param module\r
 244      *            module from which is obtained DataNodeIterator to iterate over\r
 245      *            all containers\r
 246      * @return list of <code>Type</code> which are generated from containers\r
 247      *         (objects of type <code>ContainerSchemaNode</code>)\r
 248      * @throws IllegalArgumentException\r
 249      *             <ul>\r
 250      *             <li>if the module equals null</li>\r
 251      *             <li>if the name of module equals null</li>\r
 252      *             <li>if the set of child nodes equals null</li>\r
 253      *             </ul>\r
 254      *\r
 255      */\r
 256     private def List<Type> allContainersToGenTypes(Module module) {\r
 257         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 258 \r
 259         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 260 \r
 261         if(module.childNodes === null) {\r
 262             throw new IllegalArgumentException(\r
 263                 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");\r
 264         }\r
 265 \r
 266         val List<Type> generatedTypes = new ArrayList();\r
 267         val it = new DataNodeIterator(module);\r
 268         val List<ContainerSchemaNode> schemaContainers = it.allContainers();\r
 269         val basePackageName = moduleNamespaceToPackageName(module);\r
 270         for (container : schemaContainers) {\r
 271             if(!container.isAddedByUses()) {\r
 272                 generatedTypes.add(containerToGenType(basePackageName, container));\r
 273             }\r
 274         }\r
 275         return generatedTypes;\r
 276     }\r
 277 \r
 278     /**\r
 279      * Converts all <b>lists</b> of the module to the list of <code>Type</code>\r
 280      * objects.\r
 281      *\r
 282      * @param module\r
 283      *            module from which is obtained DataNodeIterator to iterate over\r
 284      *            all lists\r
 285      * @return list of <code>Type</code> which are generated from lists (objects\r
 286      *         of type <code>ListSchemaNode</code>)\r
 287      * @throws IllegalArgumentException\r
 288      *             <ul>\r
 289      *             <li>if the module equals null</li>\r
 290      *             <li>if the name of module equals null</li>\r
 291      *             <li>if the set of child nodes equals null</li>\r
 292      *             </ul>\r
 293      *\r
 294      */\r
 295     private def List<Type> allListsToGenTypes(Module module) {\r
 296         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 297         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 298 \r
 299         if(module.childNodes === null) {\r
 300             throw new IllegalArgumentException(\r
 301                 "Reference to Set of Child Nodes in module " + module.name + " cannot be NULL.");\r
 302         }\r
 303 \r
 304         val List<Type> generatedTypes = new ArrayList();\r
 305         val it = new DataNodeIterator(module);\r
 306         val List<ListSchemaNode> schemaLists = it.allLists();\r
 307         val basePackageName = moduleNamespaceToPackageName(module);\r
 308         if(schemaLists !== null) {\r
 309             for (list : schemaLists) {\r
 310                 if(!list.isAddedByUses()) {\r
 311                     generatedTypes.addAll(listToGenType(basePackageName, list));\r
 312                 }\r
 313             }\r
 314         }\r
 315         return generatedTypes;\r
 316     }\r
 317 \r
 318     /**\r
 319      * Converts all <b>choices</b> of the module to the list of\r
 320      * <code>Type</code> objects.\r
 321      *\r
 322      * @param module\r
 323      *            module from which is obtained DataNodeIterator to iterate over\r
 324      *            all choices\r
 325      * @return list of <code>Type</code> which are generated from choices\r
 326      *         (objects of type <code>ChoiceNode</code>)\r
 327      * @throws IllegalArgumentException\r
 328      *             <ul>\r
 329      *             <li>if the module equals null</li>\r
 330      *             <li>if the name of module equals null</li> *\r
 331      *             </ul>\r
 332      *\r
 333      */\r
 334     private def List<GeneratedType> allChoicesToGenTypes(Module module) {\r
 335         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 336         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 337 \r
 338         val it = new DataNodeIterator(module);\r
 339         val choiceNodes = it.allChoices();\r
 340         val basePackageName = moduleNamespaceToPackageName(module);\r
 341 \r
 342         val List<GeneratedType> generatedTypes = new ArrayList();\r
 343         for (choice : choiceNodes) {\r
 344             if((choice !== null) && !choice.isAddedByUses()) {\r
 345                 generatedTypes.addAll(choiceToGeneratedType(basePackageName, choice));\r
 346             }\r
 347         }\r
 348         return generatedTypes;\r
 349     }\r
 350 \r
 351     /**\r
 352      * Converts all <b>augmentation</b> of the module to the list\r
 353      * <code>Type</code> objects.\r
 354      *\r
 355      * @param module\r
 356      *            module from which is obtained list of all augmentation objects\r
 357      *            to iterate over them\r
 358      * @return list of <code>Type</code> which are generated from augments\r
 359      *         (objects of type <code>AugmentationSchema</code>)\r
 360      * @throws IllegalArgumentException\r
 361      *             <ul>\r
 362      *             <li>if the module equals null</li>\r
 363      *             <li>if the name of module equals null</li>\r
 364      *             <li>if the set of child nodes equals null</li>\r
 365      *             </ul>\r
 366      *\r
 367      */\r
 368     private def List<Type> allAugmentsToGenTypes(Module module) {\r
 369         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 370         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 371         if(module.childNodes === null) {\r
 372             throw new IllegalArgumentException(\r
 373                 "Reference to Set of Augmentation Definitions in module " + module.name + " cannot be NULL.");\r
 374         }\r
 375 \r
 376         val List<Type> generatedTypes = new ArrayList();\r
 377         val basePackageName = moduleNamespaceToPackageName(module);\r
 378         val List<AugmentationSchema> augmentations = resolveAugmentations(module);\r
 379         for (augment : augmentations) {\r
 380             generatedTypes.addAll(augmentationToGenTypes(basePackageName, augment, module));\r
 381         }\r
 382         return generatedTypes;\r
 383     }\r
 384 \r
 385     /**\r
 386      * Returns list of <code>AugmentationSchema</code> objects. The objects are\r
 387      * sorted according to the length of their target path from the shortest to\r
 388      * the longest.\r
 389      *\r
 390      * @param module\r
 391      *            module from which is obtained list of all augmentation objects\r
 392      * @return list of sorted <code>AugmentationSchema</code> objects obtained\r
 393      *         from <code>module</code>\r
 394      * @throws IllegalArgumentException\r
 395      *             <ul>\r
 396      *             <li>if the module equals null</li>\r
 397      *             <li>if the set of augmentation equals null</li>\r
 398      *             </ul>\r
 399      *\r
 400      */\r
 401     private def List<AugmentationSchema> resolveAugmentations(Module module) {\r
 402         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 403         checkState(module.augmentations !== null, "Augmentations Set cannot be NULL.");\r
 404 \r
 405         val Set<AugmentationSchema> augmentations = module.augmentations;\r
 406         val List<AugmentationSchema> sortedAugmentations = new ArrayList(augmentations);\r
 407         Collections.sort(sortedAugmentations,\r
 408             [ augSchema1, augSchema2 |\r
 409                 if(augSchema1.targetPath.path.size() > augSchema2.targetPath.path.size()) {\r
 410                     return 1;\r
 411                 } else if(augSchema1.targetPath.path.size() < augSchema2.targetPath.path.size()) {\r
 412                     return -1;\r
 413                 }\r
 414                 return 0;\r
 415             ]);\r
 416         return sortedAugmentations;\r
 417     }\r
 418 \r
 419     /**\r
 420      * Converts whole <b>module</b> to <code>GeneratedType</code> object.\r
 421      * Firstly is created the module builder object from which is vally\r
 422      * obtained reference to <code>GeneratedType</code> object.\r
 423      *\r
 424      * @param module\r
 425      *            module from which are obtained the module name, child nodes,\r
 426      *            uses and is derived package name\r
 427      * @return <code>GeneratedType</code> which is internal representation of\r
 428      *         the module\r
 429      * @throws IllegalArgumentException\r
 430      *             if the module equals null\r
 431      *\r
 432      */\r
 433     private def GeneratedType moduleToDataType(Module module) {\r
 434         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 435 \r
 436         val moduleDataTypeBuilder = moduleTypeBuilder(module, "Data");\r
 437         addImplementedInterfaceFromUses(module, moduleDataTypeBuilder);\r
 438         moduleDataTypeBuilder.addImplementsType(DATA_ROOT);\r
 439 \r
 440         val basePackageName = moduleNamespaceToPackageName(module);\r
 441         if(moduleDataTypeBuilder !== null) {\r
 442             val Set<DataSchemaNode> dataNodes = module.childNodes;\r
 443             resolveDataSchemaNodes(basePackageName, moduleDataTypeBuilder, dataNodes);\r
 444         }\r
 445         return moduleDataTypeBuilder.toInstance();\r
 446     }\r
 447 \r
 448     /**\r
 449      * Converts all <b>rpcs</b> inputs and outputs substatements of the module\r
 450      * to the list of <code>Type</code> objects. In addition are to containers\r
 451      * and lists which belong to input or output also part of returning list.\r
 452      *\r
 453      * @param module\r
 454      *            module from which is obtained set of all rpc objects to\r
 455      *            iterate over them\r
 456      * @return list of <code>Type</code> which are generated from rpcs inputs,\r
 457      *         outputs + container and lists which are part of inputs or outputs\r
 458      * @throws IllegalArgumentException\r
 459      *             <ul>\r
 460      *             <li>if the module equals null</li>\r
 461      *             <li>if the name of module equals null</li>\r
 462      *             <li>if the set of child nodes equals null</li>\r
 463      *             </ul>\r
 464      *\r
 465      */\r
 466     private def List<Type> allRPCMethodsToGenType(Module module) {\r
 467         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 468 \r
 469         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 470 \r
 471         if(module.childNodes === null) {\r
 472             throw new IllegalArgumentException(\r
 473                 "Reference to Set of RPC Method Definitions in module " + module.name + " cannot be NULL.");\r
 474         }\r
 475 \r
 476         val basePackageName = moduleNamespaceToPackageName(module);\r
 477         val Set<RpcDefinition> rpcDefinitions = module.rpcs;\r
 478 \r
 479         if(rpcDefinitions.isEmpty()) {\r
 480             return Collections.emptyList();\r
 481         }\r
 482 \r
 483         val List<Type> genRPCTypes = new ArrayList();\r
 484         val interfaceBuilder = moduleTypeBuilder(module, "Service");\r
 485         interfaceBuilder.addImplementsType(Types.typeForClass(RpcService));\r
 486         for (rpc : rpcDefinitions) {\r
 487             if(rpc !== null) {\r
 488 \r
 489                 val rpcName = parseToClassName(rpc.QName.localName);\r
 490                 val rpcMethodName = parseToValidParamName(rpcName);\r
 491                 val method = interfaceBuilder.addMethod(rpcMethodName);\r
 492 \r
 493                 val rpcInOut = new ArrayList();\r
 494 \r
 495                 val input = rpc.input;\r
 496                 val output = rpc.output;\r
 497 \r
 498                 if(input !== null) {\r
 499                     rpcInOut.add(new DataNodeIterator(input));\r
 500                     val inType = addRawInterfaceDefinition(basePackageName, input, rpcName);\r
 501                     addImplementedInterfaceFromUses(input, inType);\r
 502                     inType.addImplementsType(DATA_OBJECT);\r
 503                     inType.addImplementsType(augmentable(inType));\r
 504                     resolveDataSchemaNodes(basePackageName, inType, input.childNodes);\r
 505                     val inTypeInstance = inType.toInstance();\r
 506                     genRPCTypes.add(inTypeInstance);\r
 507                     method.addParameter(inTypeInstance, "input");\r
 508                 }\r
 509 \r
 510                 var Type outTypeInstance = VOID;\r
 511                 if(output !== null) {\r
 512                     rpcInOut.add(new DataNodeIterator(output));\r
 513                     val outType = addRawInterfaceDefinition(basePackageName, output, rpcName);\r
 514                     addImplementedInterfaceFromUses(output, outType);\r
 515                     outType.addImplementsType(DATA_OBJECT);\r
 516                     outType.addImplementsType(augmentable(outType));\r
 517 \r
 518                     resolveDataSchemaNodes(basePackageName, outType, output.childNodes);\r
 519                     outTypeInstance = outType.toInstance();\r
 520                     genRPCTypes.add(outTypeInstance);\r
 521 \r
 522                 }\r
 523 \r
 524                 val rpcRes = Types.parameterizedTypeFor(Types.typeForClass(RpcResult), outTypeInstance);\r
 525                 method.setReturnType(Types.parameterizedTypeFor(FUTURE, rpcRes));\r
 526                 for (iter : rpcInOut) {\r
 527                     val List<ContainerSchemaNode> nContainers = iter.allContainers();\r
 528                     if((nContainers !== null) && !nContainers.isEmpty()) {\r
 529                         for (container : nContainers) {\r
 530                             if(!container.isAddedByUses()) {\r
 531                                 genRPCTypes.add(containerToGenType(basePackageName, container));\r
 532                             }\r
 533                         }\r
 534                     }\r
 535                     val List<ListSchemaNode> nLists = iter.allLists();\r
 536                     if((nLists !== null) && !nLists.isEmpty()) {\r
 537                         for (list : nLists) {\r
 538                             if(!list.isAddedByUses()) {\r
 539                                 genRPCTypes.addAll(listToGenType(basePackageName, list));\r
 540                             }\r
 541                         }\r
 542                     }\r
 543                     val List<ChoiceNode> nChoices = iter.allChoices();\r
 544                     if((nChoices !== null) && !nChoices.isEmpty()) {\r
 545                         for (choice : nChoices) {\r
 546                             if(!choice.isAddedByUses()) {\r
 547                                 genRPCTypes.addAll(choiceToGeneratedType(basePackageName, choice));\r
 548                             }\r
 549                         }\r
 550                     }\r
 551                 }\r
 552             }\r
 553         }\r
 554         genRPCTypes.add(interfaceBuilder.toInstance());\r
 555         return genRPCTypes;\r
 556     }\r
 557 \r
 558     /**\r
 559      * Converts all <b>notifications</b> of the module to the list of\r
 560      * <code>Type</code> objects. In addition are to this list added containers\r
 561      * and lists which are part of this notification.\r
 562      *\r
 563      * @param module\r
 564      *            module from which is obtained set of all notification objects\r
 565      *            to iterate over them\r
 566      * @return list of <code>Type</code> which are generated from notification\r
 567      *         (object of type <code>NotificationDefinition</code>\r
 568      * @throws IllegalArgumentException\r
 569      *             <ul>\r
 570      *             <li>if the module equals null</li>\r
 571      *             <li>if the name of module equals null</li>\r
 572      *             <li>if the set of child nodes equals null</li>\r
 573      *             </ul>\r
 574      *\r
 575      */\r
 576     private def List<Type> allNotificationsToGenType(Module module) {\r
 577         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 578 \r
 579         checkArgument(module.name !== null, "Module name cannot be NULL.");\r
 580 \r
 581         if(module.childNodes === null) {\r
 582             throw new IllegalArgumentException(\r
 583                 "Reference to Set of Notification Definitions in module " + module.name + " cannot be NULL.");\r
 584         }\r
 585         val notifications = module.notifications;\r
 586         if(notifications.isEmpty()) return Collections.emptyList();\r
 587 \r
 588         val listenerInterface = moduleTypeBuilder(module, "Listener");\r
 589         listenerInterface.addImplementsType(BindingTypes.NOTIFICATION_LISTENER);\r
 590 \r
 591         val basePackageName = moduleNamespaceToPackageName(module);\r
 592         val List<Type> generatedTypes = new ArrayList();\r
 593 \r
 594         for (notification : notifications) {\r
 595             if(notification !== null) {\r
 596                 val iter = new DataNodeIterator(notification);\r
 597 \r
 598                 // Containers\r
 599                 for (node : iter.allContainers()) {\r
 600                     if(!node.isAddedByUses()) {\r
 601                         generatedTypes.add(containerToGenType(basePackageName, node));\r
 602                     }\r
 603                 }\r
 604 \r
 605                 // Lists\r
 606                 for (node : iter.allLists()) {\r
 607                     if(!node.isAddedByUses()) {\r
 608                         generatedTypes.addAll(listToGenType(basePackageName, node));\r
 609                     }\r
 610                 }\r
 611                 val notificationInterface = addDefaultInterfaceDefinition(basePackageName, notification);\r
 612                 notificationInterface.addImplementsType(NOTIFICATION);\r
 613 \r
 614                 // Notification object\r
 615                 resolveDataSchemaNodes(basePackageName, notificationInterface, notification.childNodes);\r
 616 \r
 617                 listenerInterface.addMethod("on" + notificationInterface.name) //\r
 618                 .setAccessModifier(AccessModifier.PUBLIC).addParameter(notificationInterface, "notification").\r
 619                     setReturnType(Types.VOID);\r
 620 \r
 621                 generatedTypes.add(notificationInterface.toInstance());\r
 622             }\r
 623         }\r
 624         generatedTypes.add(listenerInterface.toInstance());\r
 625         return generatedTypes;\r
 626     }\r
 627 \r
 628     /**\r
 629      * Converts all <b>identities</b> of the module to the list of\r
 630      * <code>Type</code> objects.\r
 631      *\r
 632      * @param module\r
 633      *            module from which is obtained set of all identity objects to\r
 634      *            iterate over them\r
 635      * @param context\r
 636      *            schema context only used as input parameter for method\r
 637      *            {@link identityToGenType}\r
 638      * @return list of <code>Type</code> which are generated from identities\r
 639      *         (object of type <code>IdentitySchemaNode</code>\r
 640      *\r
 641      */\r
 642     private def List<Type> allIdentitiesToGenTypes(Module module, SchemaContext context) {\r
 643         val List<Type> genTypes = new ArrayList();\r
 644 \r
 645         val Set<IdentitySchemaNode> schemaIdentities = module.identities;\r
 646 \r
 647         val basePackageName = moduleNamespaceToPackageName(module);\r
 648 \r
 649         if(schemaIdentities !== null && !schemaIdentities.isEmpty()) {\r
 650             for (identity : schemaIdentities) {\r
 651                 genTypes.add(identityToGenType(basePackageName, identity, context));\r
 652             }\r
 653         }\r
 654         return genTypes;\r
 655     }\r
 656 \r
 657     /**\r
 658      * Converts the <b>identity</b> object to GeneratedType. Firstly it is\r
 659      * created transport object builder. If identity contains base identity then\r
 660      * reference to base identity is added to superior identity as its extend.\r
 661      * If identity doesn't contain base identity then only reference to abstract\r
 662      * class {@link org.opendaylight.yangtools.yang.model.api.BaseIdentity\r
 663      * BaseIdentity} is added\r
 664      *\r
 665      * @param basePackageName\r
 666      *            string contains the module package name\r
 667      * @param identity\r
 668      *            IdentitySchemaNode which contains data about identity\r
 669      * @param context\r
 670      *            SchemaContext which is used to get package and name\r
 671      *            information about base of identity\r
 672      *\r
 673      * @return GeneratedType which is generated from identity (object of type\r
 674      *         <code>IdentitySchemaNode</code>\r
 675      *\r
 676      */\r
 677     private def GeneratedType identityToGenType(String basePackageName, IdentitySchemaNode identity,\r
 678         SchemaContext context) {\r
 679         if(identity === null) {\r
 680             return null;\r
 681         }\r
 682 \r
 683         val packageName = packageNameForGeneratedType(basePackageName, identity.path);\r
 684         val genTypeName = parseToClassName(identity.QName.localName);\r
 685         val newType = new GeneratedTOBuilderImpl(packageName, genTypeName);\r
 686 \r
 687         val baseIdentity = identity.baseIdentity;\r
 688         if(baseIdentity !== null) {\r
 689             val baseIdentityParentModule = SchemaContextUtil.findParentModule(context, baseIdentity);\r
 690 \r
 691             val returnTypePkgName = moduleNamespaceToPackageName(baseIdentityParentModule);\r
 692             val returnTypeName = parseToClassName(baseIdentity.QName.localName);\r
 693 \r
 694             val gto = new GeneratedTOBuilderImpl(returnTypePkgName, returnTypeName).toInstance();\r
 695             newType.setExtendsType(gto);\r
 696         } else {\r
 697             newType.setExtendsType(Types.baseIdentityTO);\r
 698         }\r
 699         newType.setAbstract(true);\r
 700         return newType.toInstance();\r
 701     }\r
 702 \r
 703     /**\r
 704      * Converts all <b>groupings</b> of the module to the list of\r
 705      * <code>Type</code> objects. Firstly are groupings sorted according mutual\r
 706      * dependencies. At least dependend (indepedent) groupings are in the list\r
 707      * saved at first positions. For every grouping the record is added to map\r
 708      * {@link BindingGeneratorImpl#allGroupings allGroupings}\r
 709      *\r
 710      * @param module\r
 711      *            module from which is obtained set of all grouping objects to\r
 712      *            iterate over them\r
 713      * @return list of <code>Type</code> which are generated from groupings\r
 714      *         (object of type <code>GroupingDefinition</code>)\r
 715      *\r
 716      */\r
 717     private def List<Type> allGroupingsToGenTypes(Module module) {\r
 718         checkArgument(module !== null, "Module parameter can not be null");\r
 719         val List<Type> genTypes = new ArrayList();\r
 720         val basePackageName = moduleNamespaceToPackageName(module);\r
 721         val Set<GroupingDefinition> groupings = module.groupings;\r
 722         val List<GroupingDefinition> groupingsSortedByDependencies = new GroupingDefinitionDependencySort().sort(\r
 723             groupings);\r
 724 \r
 725         for (grouping : groupingsSortedByDependencies) {\r
 726             val genType = groupingToGenType(basePackageName, grouping);\r
 727             genTypes.add(genType);\r
 728             val schemaPath = grouping.path;\r
 729             allGroupings.put(schemaPath, genType);\r
 730         }\r
 731         return genTypes;\r
 732     }\r
 733 \r
 734     /**\r
 735      * Converts individual grouping to GeneratedType. Firstly generated type\r
 736      * builder is created and every child node of grouping is resolved to the\r
 737      * method.\r
 738      *\r
 739      * @param basePackageName\r
 740      *            string contains the module package name\r
 741      * @param grouping\r
 742      *            GroupingDefinition which contains data about grouping\r
 743      * @return GeneratedType which is generated from grouping (object of type\r
 744      *         <code>GroupingDefinition</code>)\r
 745      */\r
 746     private def GeneratedType groupingToGenType(String basePackageName, GroupingDefinition grouping) {\r
 747         if(grouping === null) {\r
 748             return null;\r
 749         }\r
 750 \r
 751         val packageName = packageNameForGeneratedType(basePackageName, grouping.path);\r
 752         val Set<DataSchemaNode> schemaNodes = grouping.childNodes;\r
 753         val typeBuilder = addDefaultInterfaceDefinition(packageName, grouping);\r
 754 \r
 755         resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);\r
 756         return typeBuilder.toInstance();\r
 757     }\r
 758 \r
 759     /**\r
 760      * Tries to find EnumTypeDefinition in <code>typeDefinition</code>. If base\r
 761      * type of <code>typeDefinition</code> is of the type ExtendedType then this\r
 762      * method is recursivelly called with this base type.\r
 763      *\r
 764      * @param typeDefinition\r
 765      *            TypeDefinition in which should be EnumTypeDefinition found as\r
 766      *            base type\r
 767      * @return EnumTypeDefinition if it is found inside\r
 768      *         <code>typeDefinition</code> or <code>null</code> in other case\r
 769      */\r
 770     private def EnumTypeDefinition enumTypeDefFromExtendedType(TypeDefinition<?> typeDefinition) {\r
 771         if(typeDefinition !== null) {\r
 772             if(typeDefinition.baseType instanceof EnumTypeDefinition) {\r
 773                 return typeDefinition.baseType as EnumTypeDefinition;\r
 774             } else if(typeDefinition.baseType instanceof ExtendedType) {\r
 775                 return enumTypeDefFromExtendedType(typeDefinition.baseType);\r
 776             }\r
 777         }\r
 778         return null;\r
 779     }\r
 780 \r
 781     /**\r
 782      * Adds enumeration builder created from <code>enumTypeDef</code> to\r
 783      * <code>typeBuilder</code>.\r
 784      *\r
 785      * Each <code>enumTypeDef</code> item is added to builder with its name and\r
 786      * value.\r
 787      *\r
 788      * @param enumTypeDef\r
 789      *            EnumTypeDefinition contains enum data\r
 790      * @param enumName\r
 791      *            string contains name which will be assigned to enumeration\r
 792      *            builder\r
 793      * @param typeBuilder\r
 794      *            GeneratedTypeBuilder to which will be enum builder assigned\r
 795      * @return enumeration builder which contais data from\r
 796      *         <code>enumTypeDef</code>\r
 797      */\r
 798     private def EnumBuilder resolveInnerEnumFromTypeDefinition(EnumTypeDefinition enumTypeDef, String enumName,\r
 799         GeneratedTypeBuilder typeBuilder) {\r
 800         if((enumTypeDef !== null) && (typeBuilder !== null) && (enumTypeDef.QName !== null) &&\r
 801             (enumTypeDef.QName.localName !== null)) {\r
 802 \r
 803             val enumerationName = parseToClassName(enumName);\r
 804             val enumBuilder = typeBuilder.addEnumeration(enumerationName);\r
 805             enumBuilder.updateEnumPairsFromEnumTypeDef(enumTypeDef);\r
 806 \r
 807             return enumBuilder;\r
 808         }\r
 809         return null;\r
 810     }\r
 811 \r
 812     /**\r
 813      * Generates type builder for <code>module</code>.\r
 814      *\r
 815      * @param module\r
 816      *            Module which is source of package name for generated type\r
 817      *            builder\r
 818      * @param postfix\r
 819      *            string which is added to the module class name representation\r
 820      *            as suffix\r
 821      * @return instance of GeneratedTypeBuilder which represents\r
 822      *         <code>module</code>.\r
 823      * @throws IllegalArgumentException\r
 824      *             if <code>module</code> equals null\r
 825      */\r
 826     private def GeneratedTypeBuilder moduleTypeBuilder(Module module, String postfix) {\r
 827         checkArgument(module !== null, "Module reference cannot be NULL.");\r
 828         val packageName = moduleNamespaceToPackageName(module);\r
 829         val moduleName = parseToClassName(module.name) + postfix;\r
 830 \r
 831         return new GeneratedTypeBuilderImpl(packageName, moduleName);\r
 832     }\r
 833 \r
 834     /**\r
 835      * Converts <code>augSchema</code> to list of <code>Type</code> which\r
 836      * contains generated type for augmentation. In addition there are also\r
 837      * generated types for all containers, list and choices which are child of\r
 838      * <code>augSchema</code> node or a generated types for cases are added if\r
 839      * augmented node is choice.\r
 840      *\r
 841      * @param augmentPackageName\r
 842      *            string with the name of the package to which the augmentation\r
 843      *            belongs\r
 844      * @param augSchema\r
 845      *            AugmentationSchema which is contains data about agumentation\r
 846      *            (target path, childs...)\r
 847      * @return list of <code>Type</code> objects which contains generated type\r
 848      *         for augmentation and for container, list and choice child nodes\r
 849      * @throws IllegalArgumentException\r
 850      *             <ul>\r
 851      *             <li>if <code>augmentPackageName</code> equals null</li>\r
 852      *             <li>if <code>augSchema</code> equals null</li>\r
 853      *             <li>if target path of <code>augSchema</code> equals null</li>\r
 854      *             </ul>\r
 855      */\r
 856     private def List<Type> augmentationToGenTypes(String augmentPackageName, AugmentationSchema augSchema, Module module) {\r
 857         checkArgument(augmentPackageName !== null, "Package Name cannot be NULL.");\r
 858         checkArgument(augSchema !== null, "Augmentation Schema cannot be NULL.");\r
 859         checkState(augSchema.targetPath !== null,\r
 860             "Augmentation Schema does not contain Target Path (Target Path is NULL).");\r
 861         val List<Type> genTypes = new ArrayList();\r
 862 \r
 863         // EVERY augmented interface will extends Augmentation<T> interface\r
 864         // and DataObject interface!!!\r
 865         val targetPath = augSchema.targetPath;\r
 866         var targetSchemaNode = findDataSchemaNode(schemaContext, targetPath);\r
 867         if (targetSchemaNode instanceof DataSchemaNode && (targetSchemaNode as DataSchemaNode).isAddedByUses()) {\r
 868                         targetSchemaNode = findOriginalTargetFromGrouping(targetPath, module, targetSchemaNode as DataSchemaNode);\r
 869         }\r
 870 \r
 871         if(targetSchemaNode !== null) {\r
 872             var targetType = yangToJavaMapping.get(targetSchemaNode.path);\r
 873             if(targetType == null) {\r
 874 \r
 875                 // FIXME: augmentation should be added as last, all types should already be generated\r
 876                 // and have assigned Java Types,\r
 877                 val targetModule = findParentModule(schemaContext, targetSchemaNode);\r
 878                 val targetBasePackage = moduleNamespaceToPackageName(targetModule);\r
 879                 val typePackage = packageNameForGeneratedType(targetBasePackage, targetSchemaNode.getPath());\r
 880                 val targetSchemaNodeName = targetSchemaNode.getQName().getLocalName();\r
 881                 val typeName = parseToClassName(targetSchemaNodeName);\r
 882                 targetType = new ReferencedTypeImpl(typePackage, typeName);\r
 883             }\r
 884             val augChildNodes = augSchema.childNodes;\r
 885             if(!(targetSchemaNode instanceof ChoiceNode)) {\r
 886                 val augTypeBuilder = addRawAugmentGenTypeDefinition(augmentPackageName, targetType, augSchema);\r
 887                 val augType = augTypeBuilder.toInstance();\r
 888                 genTypes.add(augType);\r
 889             } else {\r
 890                 genTypes.addAll(generateTypesFromAugmentedChoiceCases(augmentPackageName, targetType, augChildNodes, targetSchemaNode as ChoiceNode));\r
 891             }\r
 892             genTypes.addAll(augmentationBodyToGenTypes(augmentPackageName, augChildNodes));\r
 893         }\r
 894                 \r
 895         return genTypes;\r
 896     }\r
 897 \r
 898     private def DataSchemaNode findOriginalTargetFromGrouping(SchemaPath targetPath, Module module, DataSchemaNode targetSchemaNode) {\r
 899         val path = new ArrayList<QName>(targetPath.getPath());\r
 900         path.remove(path.size()-1);\r
 901         var DataNodeContainer parent = null;\r
 902 \r
 903         if (path.isEmpty()) {\r
 904             parent = module;\r
 905         } else {\r
 906             parent = findNodeInSchemaContext(schemaContext, path) as DataNodeContainer;\r
 907         }\r
 908 \r
 909         val Set<UsesNode> usesNodes = parent.getUses();\r
 910         if (usesNodes == null || usesNodes.isEmpty()) {\r
 911             return targetSchemaNode;\r
 912         }\r
 913         val Set<SchemaPath> groupingPaths = new HashSet<SchemaPath>();\r
 914         for (uses : usesNodes) {\r
 915             groupingPaths.add(uses.getGroupingPath());\r
 916         }\r
 917         val Set<GroupingDefinition> groupings = new HashSet<GroupingDefinition>();\r
 918         for (gp : groupingPaths) {\r
 919             groupings.add(findGrouping(schemaContext, module, gp.getPath()));\r
 920         }\r
 921 \r
 922         var DataSchemaNode result = findNodeInGroupings(groupings, targetSchemaNode.getQName().localName);\r
 923         return result;\r
 924     }\r
 925 \r
 926     private def DataSchemaNode findNodeInGroupings(Set<GroupingDefinition> groupings, String name) {\r
 927         for (gr : groupings) {\r
 928             var DataSchemaNode node = gr.getDataChildByName(name);\r
 929             if (node != null) {\r
 930                 return node;\r
 931             }\r
 932         }\r
 933         return null;\r
 934     }\r
 935 \r
 936     /**\r
 937      * Returns a generated type builder for an augmentation.\r
 938      *\r
 939      * The name of the type builder is equal to the name of augmented node with\r
 940      * serial number as suffix.\r
 941      *\r
 942      * @param augmentPackageName\r
 943      *            string with contains the package name to which the augment\r
 944      *            belongs\r
 945      * @param targetPackageName\r
 946      *            string with the package name to which the augmented node\r
 947      *            belongs\r
 948      * @param targetSchemaNodeName\r
 949      *            string with the name of the augmented node\r
 950      * @param augSchema\r
 951      *            augmentation schema which contains data about the child nodes\r
 952      *            and uses of augment\r
 953      * @return generated type builder for augment\r
 954      */\r
 955     private def GeneratedTypeBuilder addRawAugmentGenTypeDefinition(String augmentPackageName, Type targetTypeRef,\r
 956         AugmentationSchema augSchema) {\r
 957         var Map<String, GeneratedTypeBuilder> augmentBuilders = genTypeBuilders.get(augmentPackageName);\r
 958         if(augmentBuilders === null) {\r
 959             augmentBuilders = new HashMap();\r
 960             genTypeBuilders.put(augmentPackageName, augmentBuilders);\r
 961         }\r
 962         val augIdentifier = getAugmentIdentifier(augSchema.unknownSchemaNodes);\r
 963 \r
 964         val augTypeName = if(augIdentifier !== null) {\r
 965                 parseToClassName(augIdentifier)\r
 966             } else {\r
 967                 augGenTypeName(augmentBuilders, targetTypeRef.name);\r
 968             }\r
 969         val Set<DataSchemaNode> augChildNodes = augSchema.childNodes;\r
 970 \r
 971         val augTypeBuilder = new GeneratedTypeBuilderImpl(augmentPackageName, augTypeName);\r
 972 \r
 973         augTypeBuilder.addImplementsType(DATA_OBJECT);\r
 974         augTypeBuilder.addImplementsType(Types.augmentationTypeFor(targetTypeRef));\r
 975         addImplementedInterfaceFromUses(augSchema, augTypeBuilder);\r
 976 \r
 977         augSchemaNodeToMethods(augmentPackageName, augTypeBuilder, augChildNodes);\r
 978         augmentBuilders.put(augTypeName, augTypeBuilder);\r
 979         return augTypeBuilder;\r
 980     }\r
 981 \r
 982     /**\r
 983      *\r
 984      * @param unknownSchemaNodes\r
 985      * @return nodeParameter of UnknownSchemaNode\r
 986      */\r
 987     private def String getAugmentIdentifier(List<UnknownSchemaNode> unknownSchemaNodes) {\r
 988         for (unknownSchemaNode : unknownSchemaNodes) {\r
 989             val nodeType = unknownSchemaNode.nodeType;\r
 990             if(AUGMENT_IDENTIFIER_NAME.equals(nodeType.localName) &&\r
 991                 YANG_EXT_NAMESPACE.equals(nodeType.namespace.toString())) {\r
 992                 return unknownSchemaNode.nodeParameter;\r
 993             }\r
 994         }\r
 995         return null;\r
 996     }\r
 997 \r
 998     /**\r
 999      * Convert a container, list and choice subnodes (and recursivelly their\r
1000      * subnodes) of augment to generated types\r
1001      *\r
1002      * @param augBasePackageName\r
1003      *            string with the augment package name\r
1004      * @param augChildNodes\r
1005      *            set of data schema nodes which represents child nodes of the\r
1006      *            augment\r
1007      *\r
1008      * @return list of <code>Type</code> which represents container, list and\r
1009      *         choice subnodes of augment\r
1010      */\r
1011     private def List<Type> augmentationBodyToGenTypes(String augBasePackageName, Set<DataSchemaNode> augChildNodes) {\r
1012         val List<Type> genTypes = new ArrayList();\r
1013         val List<DataNodeIterator> augSchemaIts = new ArrayList();\r
1014         for (childNode : augChildNodes) {\r
1015             if(childNode instanceof DataNodeContainer) {\r
1016                 augSchemaIts.add(new DataNodeIterator(childNode as DataNodeContainer));\r
1017 \r
1018                 if(childNode instanceof ContainerSchemaNode) {\r
1019                     genTypes.add(containerToGenType(augBasePackageName, childNode as ContainerSchemaNode));\r
1020                 } else if(childNode instanceof ListSchemaNode) {\r
1021                     genTypes.addAll(listToGenType(augBasePackageName, childNode as ListSchemaNode));\r
1022                 }\r
1023             } else if(childNode instanceof ChoiceNode) {\r
1024                 val choice = childNode as ChoiceNode;\r
1025                 for (caseNode : choice.cases) {\r
1026                     augSchemaIts.add(new DataNodeIterator(caseNode));\r
1027                 }\r
1028                 genTypes.addAll(choiceToGeneratedType(augBasePackageName, childNode as ChoiceNode));\r
1029             }\r
1030         }\r
1031 \r
1032         for (it : augSchemaIts) {\r
1033             val List<ContainerSchemaNode> augContainers = it.allContainers();\r
1034             val List<ListSchemaNode> augLists = it.allLists();\r
1035             val List<ChoiceNode> augChoices = it.allChoices();\r
1036 \r
1037             if(augContainers !== null) {\r
1038                 for (container : augContainers) {\r
1039                     genTypes.add(containerToGenType(augBasePackageName, container));\r
1040                 }\r
1041             }\r
1042             if(augLists !== null) {\r
1043                 for (list : augLists) {\r
1044                     genTypes.addAll(listToGenType(augBasePackageName, list));\r
1045                 }\r
1046             }\r
1047             if(augChoices !== null) {\r
1048                 for (choice : augChoices) {\r
1049                     genTypes.addAll(choiceToGeneratedType(augBasePackageName, choice));\r
1050                 }\r
1051             }\r
1052         }\r
1053         return genTypes;\r
1054     }\r
1055 \r
1056     /**\r
1057      * Returns first unique name for the augment generated type builder. The\r
1058      * generated type builder name for augment consists from name of augmented\r
1059      * node and serial number of its augmentation.\r
1060      *\r
1061      * @param builders\r
1062      *            map of builders which were created in the package to which the\r
1063      *            augmentation belongs\r
1064      * @param genTypeName\r
1065      *            string with name of augmented node\r
1066      * @return string with unique name for augmentation builder\r
1067      */\r
1068     private def String augGenTypeName(Map<String, GeneratedTypeBuilder> builders, String genTypeName) {\r
1069         var index = 1;\r
1070         while((builders !== null) && builders.containsKey(genTypeName + index)) {\r
1071             index = index + 1;\r
1072         }\r
1073         return genTypeName + index;\r
1074     }\r
1075 \r
1076     /**\r
1077      * Converts <code>containerNode</code> to generated type. Firstly the\r
1078      * generated type builder is created. The subnodes of\r
1079      * <code>containerNode</code> are added as methods and the instance of\r
1080      * <code>GeneratedType</code> is returned.\r
1081      *\r
1082      * @param basePackageName\r
1083      *            string contains the module package name\r
1084      * @param containerNode\r
1085      *            container schema node with the data about childs nodes and\r
1086      *            schema paths\r
1087      * @return generated type for <code>containerNode</code>\r
1088      */\r
1089     private def GeneratedType containerToGenType(String basePackageName, ContainerSchemaNode containerNode) {\r
1090         if(containerNode === null) {\r
1091             return null;\r
1092         }\r
1093 \r
1094         val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);\r
1095         val schemaNodes = containerNode.childNodes;\r
1096         val typeBuilder = addDefaultInterfaceDefinition(packageName, containerNode);\r
1097 \r
1098         resolveDataSchemaNodes(basePackageName, typeBuilder, schemaNodes);\r
1099         return typeBuilder.toInstance();\r
1100     }\r
1101 \r
1102     /**\r
1103      * Adds the methods to <code>typeBuilder</code> which represent subnodes of\r
1104      * node for which <code>typeBuilder</code> was created.\r
1105      *\r
1106      * The subnodes aren't mapped to the methods if they are part of grouping or\r
1107      * augment (in this case are already part of them).\r
1108      *\r
1109      * @param basePackageName\r
1110      *            string contains the module package name\r
1111      * @param typeBuilder\r
1112      *            generated type builder which represents any node. The subnodes\r
1113      *            of this node are added to the <code>typeBuilder</code> as\r
1114      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1115      *            container, choice.\r
1116      * @param schemaNodes\r
1117      *            set of data schema nodes which are the children of the node\r
1118      *            for which <code>typeBuilder</code> was created\r
1119      * @return generated type builder which is the same builder as input\r
1120      *         parameter. The getter methods (representing child nodes) could be\r
1121      *         added to it.\r
1122      */\r
1123     private def GeneratedTypeBuilder resolveDataSchemaNodes(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1124         Set<DataSchemaNode> schemaNodes) {\r
1125         if((schemaNodes !== null) && (typeBuilder !== null)) {\r
1126             for (schemaNode : schemaNodes) {\r
1127                 if(!schemaNode.isAugmenting() && !schemaNode.isAddedByUses()) {\r
1128                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);\r
1129                 }\r
1130 \r
1131             }\r
1132         }\r
1133         return typeBuilder;\r
1134     }\r
1135         \r
1136         private def GeneratedTypeBuilder resolveDataSchemaNodesAugmented(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1137                 Set<DataSchemaNode> schemaNodes) {\r
1138                 if ((schemaNodes !== null) && (typeBuilder !== null)) {\r
1139                         for (schemaNode : schemaNodes) {\r
1140                                 if (!schemaNode.isAddedByUses()) {\r
1141                                         addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);\r
1142                                 }\r
1143                         }\r
1144                 }\r
1145                 return typeBuilder;\r
1146         }\r
1147 \r
1148     /**\r
1149      * Adds the methods to <code>typeBuilder</code> what represents subnodes of\r
1150      * node for which <code>typeBuilder</code> was created.\r
1151      *\r
1152      * @param basePackageName\r
1153      *            string contains the module package name\r
1154      * @param typeBuilder\r
1155      *            generated type builder which represents any node. The subnodes\r
1156      *            of this node are added to the <code>typeBuilder</code> as\r
1157      *            methods. The subnode can be of type leaf, leaf-list, list,\r
1158      *            container, choice.\r
1159      * @param schemaNodes\r
1160      *            set of data schema nodes which are the children of the node\r
1161      *            for which <code>typeBuilder</code> was created\r
1162      * @return generated type builder which is the same object as the input\r
1163      *         parameter <code>typeBuilder</code>. The getter method could be\r
1164      *         added to it.\r
1165      */\r
1166     private def GeneratedTypeBuilder augSchemaNodeToMethods(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1167         Set<DataSchemaNode> schemaNodes) {\r
1168         if((schemaNodes !== null) && (typeBuilder !== null)) {\r
1169             for (schemaNode : schemaNodes) {\r
1170                             if (!schemaNode.isAugmenting()) {\r
1171                                     addSchemaNodeToBuilderAsMethod(basePackageName, schemaNode, typeBuilder);\r
1172                                 }\r
1173                         }\r
1174                 }\r
1175                 return typeBuilder;\r
1176         }\r
1177 \r
1178     /**\r
1179      * Adds to <code>typeBuilder</code> a method which is derived from\r
1180      * <code>schemaNode</code>.\r
1181      *\r
1182      * @param basePackageName\r
1183      *            string with the module package name\r
1184      * @param schemaNode\r
1185      *            data schema node which is added to <code>typeBuilder</code> as\r
1186      *            a method\r
1187      * @param typeBuilder\r
1188      *            generated type builder to which is <code>schemaNode</code>\r
1189      *            added as a method.\r
1190      */\r
1191     private def void addSchemaNodeToBuilderAsMethod(String basePackageName, DataSchemaNode node,\r
1192         GeneratedTypeBuilder typeBuilder) {\r
1193         if(node !== null && typeBuilder !== null) {\r
1194             switch (node) {\r
1195                 case node instanceof LeafSchemaNode:\r
1196                     resolveLeafSchemaNodeAsMethod(typeBuilder, node as LeafSchemaNode)\r
1197                 case node instanceof LeafListSchemaNode:\r
1198                     resolveLeafListSchemaNode(typeBuilder, node as LeafListSchemaNode)\r
1199                 case node instanceof ContainerSchemaNode:\r
1200                     resolveContainerSchemaNode(basePackageName, typeBuilder, node as ContainerSchemaNode)\r
1201                 case node instanceof ListSchemaNode:\r
1202                     resolveListSchemaNode(basePackageName, typeBuilder, node as ListSchemaNode)\r
1203                 case node instanceof ChoiceNode:\r
1204                     resolveChoiceSchemaNode(basePackageName, typeBuilder, node as ChoiceNode)\r
1205             }\r
1206         }\r
1207     }\r
1208 \r
1209     /**\r
1210      * Creates a getter method for a choice node.\r
1211      *\r
1212      * Firstly generated type builder for choice is created or found in\r
1213      * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name\r
1214      * in the builder is created as concatenation of module package name and\r
1215      * names of all parent nodes. In the end the getter method for choice is\r
1216      * added to <code>typeBuilder</code> and return type is set to choice\r
1217      * builder.\r
1218      *\r
1219      * @param basePackageName\r
1220      *            string with the module package name\r
1221      * @param typeBuilder\r
1222      *            generated type builder to which is <code>choiceNode</code>\r
1223      *            added as getter method\r
1224      * @param choiceNode\r
1225      *            choice node which is mapped as a getter method\r
1226      * @throws IllegalArgumentException\r
1227      *             <ul>\r
1228      *             <li>if <code>basePackageName</code> equals null</li>\r
1229      *             <li>if <code>typeBuilder</code> equals null</li>\r
1230      *             <li>if <code>choiceNode</code> equals null</li>\r
1231      *             </ul>\r
1232      *\r
1233      */\r
1234     private def void resolveChoiceSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1235         ChoiceNode choiceNode) {\r
1236         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");\r
1237         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");\r
1238         checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");\r
1239 \r
1240         val choiceName = choiceNode.QName.localName;\r
1241         if(choiceName !== null && !choiceNode.isAddedByUses()) {\r
1242             val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);\r
1243             val choiceType = addDefaultInterfaceDefinition(packageName, choiceNode);\r
1244             constructGetter(typeBuilder, choiceName, choiceNode.description, choiceType);\r
1245         }\r
1246     }\r
1247 \r
1248     /**\r
1249      * Converts <code>choiceNode</code> to the list of generated types for\r
1250      * choice and its cases.\r
1251      *\r
1252      * The package names for choice and for its cases are created as\r
1253      * concatenation of the module package (<code>basePackageName</code>) and\r
1254      * names of all parents node.\r
1255      *\r
1256      * @param basePackageName\r
1257      *            string with the module package name\r
1258      * @param choiceNode\r
1259      *            choice node which is mapped to generated type. Also child\r
1260      *            nodes - cases are mapped to generated types.\r
1261      * @return list of generated types which contains generated type for choice\r
1262      *         and generated types for all cases which aren't added do choice\r
1263      *         through <i>uses</i>.\r
1264      * @throws IllegalArgumentException\r
1265      *             <ul>\r
1266      *             <li>if <code>basePackageName</code> equals null</li>\r
1267      *             <li>if <code>choiceNode</code> equals null</li>\r
1268      *             </ul>\r
1269      *\r
1270      */\r
1271     private def List<GeneratedType> choiceToGeneratedType(String basePackageName, ChoiceNode choiceNode) {\r
1272         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");\r
1273         checkArgument(choiceNode !== null, "Choice Schema Node cannot be NULL.");\r
1274 \r
1275         val List<GeneratedType> generatedTypes = new ArrayList();\r
1276         val packageName = packageNameForGeneratedType(basePackageName, choiceNode.path);\r
1277         val choiceTypeBuilder = addRawInterfaceDefinition(packageName, choiceNode);\r
1278 \r
1279         //choiceTypeBuilder.addImplementsType(DATA_OBJECT);\r
1280         val choiceType = choiceTypeBuilder.toInstance();\r
1281 \r
1282         generatedTypes.add(choiceType);\r
1283         val Set<ChoiceCaseNode> caseNodes = choiceNode.cases;\r
1284         if((caseNodes !== null) && !caseNodes.isEmpty()) {\r
1285             generatedTypes.addAll(generateTypesFromChoiceCases(basePackageName, choiceType, caseNodes));\r
1286         }\r
1287         return generatedTypes;\r
1288     }\r
1289 \r
1290     /**\r
1291      * Converts <code>caseNodes</code> set to list of corresponding generated\r
1292      * types.\r
1293      *\r
1294      * For every <i>case</i> which isn't added through augment or <i>uses</i> is\r
1295      * created generated type builder. The package names for the builder is\r
1296      * created as concatenation of the module package (\r
1297      * <code>basePackageName</code>) and names of all parents nodes of the\r
1298      * concrete <i>case</i>. There is also relation "<i>implements type</i>"\r
1299      * between every case builder and <i>choice</i> type\r
1300      *\r
1301      * @param basePackageName\r
1302      *            string with the module package name\r
1303      * @param refChoiceType\r
1304      *            type which represents superior <i>case</i>\r
1305      * @param caseNodes\r
1306      *            set of choice case nodes which are mapped to generated types\r
1307      * @return list of generated types for <code>caseNodes</code>.\r
1308      * @throws IllegalArgumentException\r
1309      *             <ul>\r
1310      *             <li>if <code>basePackageName</code> equals null</li>\r
1311      *             <li>if <code>refChoiceType</code> equals null</li>\r
1312      *             <li>if <code>caseNodes</code> equals null</li>\r
1313      *             </ul>\r
1314      *             *\r
1315      */\r
1316     private def List<GeneratedType> generateTypesFromChoiceCases(String basePackageName, Type refChoiceType,\r
1317         Set<ChoiceCaseNode> caseNodes) {\r
1318         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");\r
1319         checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");\r
1320         checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");\r
1321 \r
1322         val List<GeneratedType> generatedTypes = new ArrayList();\r
1323         for (caseNode : caseNodes) {\r
1324             if(caseNode !== null && !caseNode.isAddedByUses() && !caseNode.isAugmenting()) {\r
1325                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);\r
1326                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);\r
1327                 caseTypeBuilder.addImplementsType(refChoiceType);\r
1328 \r
1329                 val Set<DataSchemaNode> childNodes = caseNode.childNodes;\r
1330                 if(childNodes !== null) {\r
1331                     resolveDataSchemaNodes(basePackageName, caseTypeBuilder, childNodes);\r
1332                 }\r
1333                 generatedTypes.add(caseTypeBuilder.toInstance());\r
1334             }\r
1335         }\r
1336 \r
1337         return generatedTypes;\r
1338     }\r
1339 \r
1340     /**\r
1341      * Generates list of generated types for all the cases of a choice which are\r
1342      * added to the choice through the augment.\r
1343      *\r
1344      *\r
1345      * @param basePackageName\r
1346      *            string contains name of package to which augment belongs. If\r
1347      *            an augmented choice is from an other package (pcg1) than an\r
1348      *            augmenting choice (pcg2) then case's of the augmenting choice\r
1349      *            will belong to pcg2.\r
1350      * @param refChoiceType\r
1351      *            Type which represents the choice to which case belongs. Every\r
1352      *            case has to contain its choice in extend part.\r
1353      * @param caseNodes\r
1354      *            set of choice case nodes for which is checked if are/aren't\r
1355      *            added to choice through augmentation\r
1356      * @return list of generated types which represents augmented cases of\r
1357      *         choice <code>refChoiceType</code>\r
1358      * @throws IllegalArgumentException\r
1359      *             <ul>\r
1360      *             <li>if <code>basePackageName</code> equals null</li>\r
1361      *             <li>if <code>refChoiceType</code> equals null</li>\r
1362      *             <li>if <code>caseNodes</code> equals null</li>\r
1363      *             </ul>\r
1364      */\r
1365     private def List<GeneratedType> generateTypesFromAugmentedChoiceCases(String basePackageName, Type refChoiceType,\r
1366         Set<DataSchemaNode> caseNodes, ChoiceNode targetNode) {\r
1367         checkArgument(basePackageName !== null, "Base Package Name cannot be NULL.");\r
1368         checkArgument(refChoiceType !== null, "Referenced Choice Type cannot be NULL.");\r
1369         checkArgument(caseNodes !== null, "Set of Choice Case Nodes cannot be NULL.");\r
1370 \r
1371         val List<GeneratedType> generatedTypes = new ArrayList();\r
1372         for (caseNode : caseNodes) {\r
1373                 if(caseNode !== null) {\r
1374                 val packageName = packageNameForGeneratedType(basePackageName, caseNode.path);\r
1375                 val caseTypeBuilder = addDefaultInterfaceDefinition(packageName, caseNode);\r
1376                 caseTypeBuilder.addImplementsType(refChoiceType);\r
1377 \r
1378                 if (caseNode instanceof DataNodeContainer) {\r
1379                         val DataNodeContainer dataNodeCase = caseNode as DataNodeContainer;\r
1380                         val Set<DataSchemaNode> childNodes = dataNodeCase.childNodes;\r
1381                     if(childNodes !== null) {\r
1382                                             resolveDataSchemaNodesAugmented(basePackageName, caseTypeBuilder, childNodes);\r
1383                     }\r
1384                 } else {\r
1385                         val ChoiceCaseNode node = targetNode.getCaseNodeByName(caseNode.getQName().getLocalName());\r
1386                         val Set<DataSchemaNode> childNodes = node.childNodes;\r
1387                     if(childNodes !== null) {\r
1388                                             resolveDataSchemaNodesAugmented(basePackageName, caseTypeBuilder, childNodes);\r
1389                     }\r
1390                 }\r
1391                 \r
1392                 generatedTypes.add(caseTypeBuilder.toInstance());\r
1393             }\r
1394         }\r
1395 \r
1396         return generatedTypes;\r
1397     }\r
1398 \r
1399     /**\r
1400      * Converts <code>leaf</code> to the getter method which is added to\r
1401      * <code>typeBuilder</code>.\r
1402      *\r
1403      * @param typeBuilder\r
1404      *            generated type builder to which is added getter method as\r
1405      *            <code>leaf</code> mapping\r
1406      * @param leaf\r
1407      *            leaf schema node which is mapped as getter method which is\r
1408      *            added to <code>typeBuilder</code>\r
1409      * @return boolean value\r
1410      *         <ul>\r
1411      *         <li>false - if <code>leaf</code> or <code>typeBuilder</code> are\r
1412      *         null</li>\r
1413      *         <li>true - in other cases</li>\r
1414      *         </ul>\r
1415      */\r
1416     private def boolean resolveLeafSchemaNodeAsMethod(GeneratedTypeBuilder typeBuilder, LeafSchemaNode leaf) {\r
1417         if((leaf !== null) && (typeBuilder !== null)) {\r
1418             val leafName = leaf.QName.localName;\r
1419             var String leafDesc = leaf.description;\r
1420             if(leafDesc === null) {\r
1421                 leafDesc = "";\r
1422             }\r
1423 \r
1424             val parentModule = findParentModule(schemaContext, leaf);\r
1425             if(leafName !== null && !leaf.isAddedByUses()) {\r
1426                 val TypeDefinition<?> typeDef = leaf.type;\r
1427 \r
1428                 var Type returnType = null;\r
1429                 if(typeDef instanceof EnumTypeDefinition) {\r
1430                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
1431                     val enumTypeDef = typeDef as EnumTypeDefinition;\r
1432                     val enumBuilder = resolveInnerEnumFromTypeDefinition(enumTypeDef, leafName, typeBuilder);\r
1433 \r
1434                     if(enumBuilder !== null) {\r
1435                         returnType = new ReferencedTypeImpl(enumBuilder.packageName, enumBuilder.name);\r
1436                     }\r
1437                     (typeProvider as TypeProviderImpl).putReferencedType(leaf.path, returnType);\r
1438                 } else if(typeDef instanceof UnionType) {\r
1439                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);\r
1440                     if(genTOBuilder !== null) {\r
1441                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1442                     }\r
1443                 } else if(typeDef instanceof BitsTypeDefinition) {\r
1444                     val genTOBuilder = addTOToTypeBuilder(typeDef, typeBuilder, leafName, leaf, parentModule);\r
1445                     if(genTOBuilder !== null) {\r
1446                         returnType = new ReferencedTypeImpl(genTOBuilder.packageName, genTOBuilder.name);\r
1447                     }\r
1448                 } else {\r
1449                     returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
1450                 }\r
1451                 if(returnType !== null) {\r
1452                     constructGetter(typeBuilder, leafName, leafDesc, returnType);\r
1453                     return true;\r
1454                 }\r
1455             }\r
1456         }\r
1457         return false;\r
1458     }\r
1459 \r
1460     /**\r
1461      * Converts <code>leaf</code> schema node to property of generated TO\r
1462      * builder.\r
1463      *\r
1464      * @param toBuilder\r
1465      *            generated TO builder to which is <code>leaf</code> added as\r
1466      *            property\r
1467      * @param leaf\r
1468      *            leaf schema node which is added to <code>toBuilder</code> as\r
1469      *            property\r
1470      * @param isReadOnly\r
1471      *            boolean value which says if leaf property is|isn't read only\r
1472      * @return boolean value\r
1473      *         <ul>\r
1474      *         <li>false - if <code>leaf</code>, <code>toBuilder</code> or leaf\r
1475      *         name equals null or if leaf is added by <i>uses</i>.</li>\r
1476      *         <li>true - other cases</li>\r
1477      *         </ul>\r
1478      */\r
1479     private def boolean resolveLeafSchemaNodeAsProperty(GeneratedTOBuilder toBuilder, LeafSchemaNode leaf,\r
1480         boolean isReadOnly) {\r
1481         if((leaf !== null) && (toBuilder !== null)) {\r
1482             val leafName = leaf.QName.localName;\r
1483             var String leafDesc = leaf.description;\r
1484             if(leafDesc === null) {\r
1485                 leafDesc = "";\r
1486             }\r
1487 \r
1488             if(leafName !== null) {\r
1489                 val TypeDefinition<?> typeDef = leaf.type;\r
1490 \r
1491                 // TODO: properly resolve enum types\r
1492                 val returnType = typeProvider.javaTypeForSchemaDefinitionType(typeDef, leaf);\r
1493 \r
1494                 if(returnType !== null) {\r
1495                     val propBuilder = toBuilder.addProperty(parseToClassName(leafName));\r
1496 \r
1497                     propBuilder.setReadOnly(isReadOnly);\r
1498                     propBuilder.setReturnType(returnType);\r
1499                     propBuilder.setComment(leafDesc);\r
1500 \r
1501                     toBuilder.addEqualsIdentity(propBuilder);\r
1502                     toBuilder.addHashIdentity(propBuilder);\r
1503                     toBuilder.addToStringProperty(propBuilder);\r
1504 \r
1505                     return true;\r
1506                 }\r
1507             }\r
1508         }\r
1509         return false;\r
1510     }\r
1511 \r
1512     /**\r
1513      * Converts <code>node</code> leaf list schema node to getter method of\r
1514      * <code>typeBuilder</code>.\r
1515      *\r
1516      * @param typeBuilder\r
1517      *            generated type builder to which is <code>node</code> added as\r
1518      *            getter method\r
1519      * @param node\r
1520      *            leaf list schema node which is added to\r
1521      *            <code>typeBuilder</code> as getter method\r
1522      * @return boolean value\r
1523      *         <ul>\r
1524      *         <li>true - if <code>node</code>, <code>typeBuilder</code>,\r
1525      *         nodeName equal null or <code>node</code> is added by <i>uses</i></li>\r
1526      *         <li>false - other cases</li>\r
1527      *         </ul>\r
1528      */\r
1529     private def boolean resolveLeafListSchemaNode(GeneratedTypeBuilder typeBuilder, LeafListSchemaNode node) {\r
1530         if((node !== null) && (typeBuilder !== null)) {\r
1531             val nodeName = node.QName.localName;\r
1532             var String nodeDesc = node.description;\r
1533             if(nodeDesc === null) {\r
1534                 nodeDesc = "";\r
1535             }\r
1536 \r
1537             if(nodeName !== null && !node.isAddedByUses()) {\r
1538                 val TypeDefinition<?> type = node.type;\r
1539                 val listType = Types.listTypeFor(typeProvider.javaTypeForSchemaDefinitionType(type, node));\r
1540 \r
1541                 constructGetter(typeBuilder, nodeName, nodeDesc, listType);\r
1542                 return true;\r
1543             }\r
1544         }\r
1545         return false;\r
1546     }\r
1547 \r
1548     /**\r
1549      * Creates a getter method for a container node.\r
1550      *\r
1551      * Firstly generated type builder for container is created or found in\r
1552      * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name\r
1553      * in the builder is created as concatenation of module package name and\r
1554      * names of all parent nodes. In the end the getter method for container is\r
1555      * added to <code>typeBuilder</code> and return type is set to container\r
1556      * type builder.\r
1557      *\r
1558      * @param basePackageName\r
1559      *            string with the module package name\r
1560      * @param typeBuilder\r
1561      *            generated type builder to which is <code>containerNode</code>\r
1562      *            added as getter method\r
1563      * @param containerNode\r
1564      *            container schema node which is mapped as getter method to\r
1565      *            <code>typeBuilder</code>\r
1566      * @return boolean value\r
1567      *         <ul>\r
1568      *         <li>false - if <code>containerNode</code>,\r
1569      *         <code>typeBuilder</code>, container node name equal null or\r
1570      *         <code>containerNode</code> is added by uses</li>\r
1571      *         <li>true - other cases</li>\r
1572      *         </ul>\r
1573      */\r
1574     private def boolean resolveContainerSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1575         ContainerSchemaNode containerNode) {\r
1576         if((containerNode !== null) && (typeBuilder !== null)) {\r
1577             val nodeName = containerNode.QName.localName;\r
1578 \r
1579             if(nodeName !== null && !containerNode.isAddedByUses()) {\r
1580                 val packageName = packageNameForGeneratedType(basePackageName, containerNode.path);\r
1581 \r
1582                 val rawGenType = addDefaultInterfaceDefinition(packageName, containerNode);\r
1583                 constructGetter(typeBuilder, nodeName, containerNode.description, rawGenType);\r
1584 \r
1585                 return true;\r
1586             }\r
1587         }\r
1588         return false;\r
1589     }\r
1590 \r
1591     /**\r
1592      * Creates a getter method for a list node.\r
1593      *\r
1594      * Firstly generated type builder for list is created or found in\r
1595      * {@link BindingGeneratorImpl#allGroupings allGroupings}. The package name\r
1596      * in the builder is created as concatenation of module package name and\r
1597      * names of all parent nodes. In the end the getter method for list is added\r
1598      * to <code>typeBuilder</code> and return type is set to list type builder.\r
1599      *\r
1600      * @param basePackageName\r
1601      *            string with the module package name\r
1602      * @param typeBuilder\r
1603      *            generated type builder to which is <code></code> added as\r
1604      *            getter method\r
1605      * @param listNode\r
1606      *            list schema node which is mapped as getter method to\r
1607      *            <code>typeBuilder</code>\r
1608      * @return boolean value\r
1609      *         <ul>\r
1610      *         <li>false - if <code>listNode</code>, <code>typeBuilder</code>,\r
1611      *         list node name equal null or <code>listNode</code> is added by\r
1612      *         uses</li>\r
1613      *         <li>true - other cases</li>\r
1614      *         </ul>\r
1615      */\r
1616     private def boolean resolveListSchemaNode(String basePackageName, GeneratedTypeBuilder typeBuilder,\r
1617         ListSchemaNode listNode) {\r
1618         if((listNode !== null) && (typeBuilder !== null)) {\r
1619             val listName = listNode.QName.localName;\r
1620 \r
1621             if(listName !== null && !listNode.isAddedByUses()) {\r
1622                 val packageName = packageNameForGeneratedType(basePackageName, listNode.path);\r
1623                 val rawGenType = addDefaultInterfaceDefinition(packageName, listNode);\r
1624                 constructGetter(typeBuilder, listName, listNode.description, Types.listTypeFor(rawGenType));\r
1625                 return true;\r
1626             }\r
1627         }\r
1628         return false;\r
1629     }\r
1630 \r
1631     /**\r
1632      * Instantiates generated type builder with <code>packageName</code> and\r
1633      * <code>schemaNode</code>.\r
1634      *\r
1635      * The new builder always implements\r
1636      * {@link org.opendaylight.yangtools.yang.binding.DataObject DataObject}.<br />\r
1637      * If <code>schemaNode</code> is instance of GroupingDefinition it also\r
1638      * implements {@link org.opendaylight.yangtools.yang.binding.Augmentable\r
1639      * Augmentable}.<br />\r
1640      * If <code>schemaNode</code> is instance of\r
1641      * {@link org.opendaylight.yangtools.yang.model.api.DataNodeContainer\r
1642      * DataNodeContainer} it can also implement nodes which are specified in\r
1643      * <i>uses</i>.\r
1644      *\r
1645      * @param packageName\r
1646      *            string with the name of the package to which\r
1647      *            <code>schemaNode</code> belongs.\r
1648      * @param schemaNode\r
1649      *            schema node for which is created generated type builder\r
1650      * @return generated type builder <code>schemaNode</code>\r
1651      */\r
1652     private def GeneratedTypeBuilder addDefaultInterfaceDefinition(String packageName, SchemaNode schemaNode) {\r
1653         val builder = addRawInterfaceDefinition(packageName, schemaNode, "");\r
1654         builder.addImplementsType(DATA_OBJECT);\r
1655         if(!(schemaNode instanceof GroupingDefinition)) {\r
1656             builder.addImplementsType(augmentable(builder));\r
1657         }\r
1658 \r
1659         if(schemaNode instanceof DataNodeContainer) {\r
1660             addImplementedInterfaceFromUses(schemaNode as DataNodeContainer, builder);\r
1661         }\r
1662 \r
1663         return builder;\r
1664     }\r
1665 \r
1666     /**\r
1667      * Wraps the calling of the same overloaded method.\r
1668      *\r
1669      * @param packageName\r
1670      *            string with the package name to which returning generated type\r
1671      *            builder belongs\r
1672      * @param schemaNode\r
1673      *            schema node which provide data about the schema node name\r
1674      * @return generated type builder for <code>schemaNode</code>\r
1675      */\r
1676     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode) {\r
1677         return addRawInterfaceDefinition(packageName, schemaNode, "");\r
1678     }\r
1679 \r
1680     /**\r
1681      * Returns reference to generated type builder for specified\r
1682      * <code>schemaNode</code> with <code>packageName</code>.\r
1683      *\r
1684      * Firstly the generated type builder is searched in\r
1685      * {@link BindingGeneratorImpl#genTypeBuilders genTypeBuilders}. If it isn't\r
1686      * found it is created and added to <code>genTypeBuilders</code>.\r
1687      *\r
1688      * @param packageName\r
1689      *            string with the package name to which returning generated type\r
1690      *            builder belongs\r
1691      * @param schemaNode\r
1692      *            schema node which provide data about the schema node name\r
1693      * @return generated type builder for <code>schemaNode</code>\r
1694      * @throws IllegalArgumentException\r
1695      *             <ul>\r
1696      *             <li>if <code>schemaNode</code> equals null</li>\r
1697      *             <li>if <code>packageName</code> equals null</li>\r
1698      *             <li>if Q name of schema node is null</li>\r
1699      *             <li>if schema node name is nul</li>\r
1700      *             </ul>\r
1701      *\r
1702      */\r
1703     private def GeneratedTypeBuilder addRawInterfaceDefinition(String packageName, SchemaNode schemaNode,\r
1704         String prefix) {\r
1705         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");\r
1706         checkArgument(packageName !== null, "Package Name for Generated Type cannot be NULL.");\r
1707         checkArgument(schemaNode.QName !== null, "QName for Data Schema Node cannot be NULL.");\r
1708         val schemaNodeName = schemaNode.QName.localName;\r
1709         checkArgument(schemaNodeName !== null, "Local Name of QName for Data Schema Node cannot be NULL.");\r
1710 \r
1711         var String genTypeName;\r
1712         if(prefix === null) {\r
1713             genTypeName = parseToClassName(schemaNodeName);\r
1714         } else {\r
1715             genTypeName = prefix + parseToClassName(schemaNodeName);\r
1716         }\r
1717 \r
1718         //FIXME: Validation of name conflict\r
1719         val newType = new GeneratedTypeBuilderImpl(packageName, genTypeName);\r
1720         yangToJavaMapping.put(schemaNode.path, newType);\r
1721         if(!genTypeBuilders.containsKey(packageName)) {\r
1722             val Map<String, GeneratedTypeBuilder> builders = new HashMap();\r
1723             builders.put(genTypeName, newType);\r
1724             genTypeBuilders.put(packageName, builders);\r
1725         } else {\r
1726             val Map<String, GeneratedTypeBuilder> builders = genTypeBuilders.get(packageName);\r
1727             if(!builders.containsKey(genTypeName)) {\r
1728                 builders.put(genTypeName, newType);\r
1729             }\r
1730         }\r
1731         return newType;\r
1732     }\r
1733 \r
1734     /**\r
1735      * Creates the name of the getter method from <code>methodName</code>.\r
1736      *\r
1737      * @param methodName\r
1738      *            string with the name of the getter method\r
1739      * @return string with the name of the getter method for\r
1740      *         <code>methodName</code> in JAVA method format\r
1741      */\r
1742     private def String getterMethodName(String methodName, Type returnType) {\r
1743         val method = new StringBuilder();\r
1744         if(BOOLEAN.equals(returnType)) {\r
1745             method.append("is");\r
1746         } else {\r
1747             method.append("get");\r
1748         }\r
1749         method.append(parseToClassName(methodName));\r
1750         return method.toString();\r
1751     }\r
1752 \r
1753     /**\r
1754      * Created a method signature builder as part of\r
1755      * <code>interfaceBuilder</code>.\r
1756      *\r
1757      * The method signature builder is created for the getter method of\r
1758      * <code>schemaNodeName</code>. Also <code>comment</code> and\r
1759      * <code>returnType</code> information are added to the builder.\r
1760      *\r
1761      * @param interfaceBuilder\r
1762      *            generated type builder for which the getter method should be\r
1763      *            created\r
1764      * @param schemaNodeName\r
1765      *            string with schema node name. The name will be the part of the\r
1766      *            getter method name.\r
1767      * @param comment\r
1768      *            string with comment for the getter method\r
1769      * @param returnType\r
1770      *            type which represents the return type of the getter method\r
1771      * @return method signature builder which represents the getter method of\r
1772      *         <code>interfaceBuilder</code>\r
1773      */\r
1774     private def MethodSignatureBuilder constructGetter(GeneratedTypeBuilder interfaceBuilder, String schemaNodeName,\r
1775         String comment, Type returnType) {\r
1776 \r
1777         val getMethod = interfaceBuilder.addMethod(getterMethodName(schemaNodeName, returnType));\r
1778 \r
1779         getMethod.setComment(comment);\r
1780         getMethod.setReturnType(returnType);\r
1781 \r
1782         return getMethod;\r
1783     }\r
1784 \r
1785     private def listToGenType(String basePackageName, ListSchemaNode list) {\r
1786         checkArgument(basePackageName !== null, "Package Name for Generated Type cannot be NULL.");\r
1787         checkArgument(list !== null, "List Schema Node cannot be NULL.");\r
1788 \r
1789         val packageName = packageNameForGeneratedType(basePackageName, list.path);\r
1790 \r
1791         // val typeBuilder =\r
1792         // resolveListTypeBuilder(packageName, list);\r
1793         val typeBuilder = addDefaultInterfaceDefinition(packageName, list);\r
1794 \r
1795         val List<String> listKeys = listKeys(list);\r
1796         val genTOBuilder = resolveListKeyTOBuilder(packageName, list);\r
1797 \r
1798         if(genTOBuilder !== null) {\r
1799             val identifierMarker = IDENTIFIER.parameterizedTypeFor(typeBuilder);\r
1800             val identifiableMarker = IDENTIFIABLE.parameterizedTypeFor(genTOBuilder);\r
1801             genTOBuilder.addImplementsType(identifierMarker);\r
1802             typeBuilder.addImplementsType(identifiableMarker);\r
1803         }\r
1804         val schemaNodes = list.childNodes;\r
1805 \r
1806         for (schemaNode : schemaNodes) {\r
1807             if(!schemaNode.isAugmenting()) {\r
1808                 addSchemaNodeToListBuilders(basePackageName, schemaNode, typeBuilder, genTOBuilder, listKeys);\r
1809             }\r
1810         }\r
1811         return typeBuildersToGenTypes(typeBuilder, genTOBuilder);\r
1812     }\r
1813 \r
1814     /**\r
1815      * Adds <code>schemaNode</code> to <code>typeBuilder</code> as getter method\r
1816      * or to <code>genTOBuilder</code> as property.\r
1817      *\r
1818      * @param basePackageName\r
1819      *            string contains the module package name\r
1820      * @param schemaNode\r
1821      *            data schema node which should be added as getter method to\r
1822      *            <code>typeBuilder</code> or as a property to\r
1823      *            <code>genTOBuilder</code> if is part of the list key\r
1824      * @param typeBuilder\r
1825      *            generated type builder for the list schema node\r
1826      * @param genTOBuilder\r
1827      *            generated TO builder for the list keys\r
1828      * @param listKeys\r
1829      *            list of string which contains names of the list keys\r
1830      * @throws IllegalArgumentException\r
1831      *             <ul>\r
1832      *             <li>if <code>schemaNode</code> equals null</li>\r
1833      *             <li>if <code>typeBuilder</code> equals null</li>\r
1834      *             </ul>\r
1835      */\r
1836     private def void addSchemaNodeToListBuilders(String basePackageName, DataSchemaNode schemaNode,\r
1837         GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder, List<String> listKeys) {\r
1838         checkArgument(schemaNode !== null, "Data Schema Node cannot be NULL.");\r
1839 \r
1840         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");\r
1841 \r
1842         if(schemaNode instanceof LeafSchemaNode) {\r
1843             val leaf = schemaNode as LeafSchemaNode;\r
1844             val leafName = leaf.QName.localName;\r
1845             if(!listKeys.contains(leafName)) {\r
1846                 resolveLeafSchemaNodeAsMethod(typeBuilder, leaf);\r
1847             } else {\r
1848                 resolveLeafSchemaNodeAsProperty(genTOBuilder, leaf, true);\r
1849             }\r
1850         } else if(schemaNode instanceof LeafListSchemaNode) {\r
1851             resolveLeafListSchemaNode(typeBuilder, schemaNode as LeafListSchemaNode);\r
1852         } else if(schemaNode instanceof ContainerSchemaNode) {\r
1853             resolveContainerSchemaNode(basePackageName, typeBuilder, schemaNode as ContainerSchemaNode);\r
1854         } else if(schemaNode instanceof ChoiceNode) {\r
1855             resolveChoiceSchemaNode(basePackageName,typeBuilder,schemaNode as ChoiceNode);\r
1856         } else if(schemaNode instanceof ListSchemaNode) {\r
1857             resolveListSchemaNode(basePackageName, typeBuilder, schemaNode as ListSchemaNode);\r
1858         }\r
1859     }\r
1860 \r
1861     private def typeBuildersToGenTypes(GeneratedTypeBuilder typeBuilder, GeneratedTOBuilder genTOBuilder) {\r
1862         val List<Type> genTypes = new ArrayList();\r
1863         checkArgument(typeBuilder !== null, "Generated Type Builder cannot be NULL.");\r
1864 \r
1865         if(genTOBuilder !== null) {\r
1866             val genTO = genTOBuilder.toInstance();\r
1867             constructGetter(typeBuilder, "key", "Returns Primary Key of Yang List Type", genTO);\r
1868             genTypes.add(genTO);\r
1869         }\r
1870         genTypes.add(typeBuilder.toInstance());\r
1871         return genTypes;\r
1872     }\r
1873 \r
1874     /**\r
1875      * Selects the names of the list keys from <code>list</code> and returns\r
1876      * them as the list of the strings\r
1877      *\r
1878      * @param list\r
1879      *            of string with names of the list keys\r
1880      * @return list of string which represents names of the list keys. If the\r
1881      *         <code>list</code> contains no keys then the empty list is\r
1882      *         returned.\r
1883      */\r
1884     private def listKeys(ListSchemaNode list) {\r
1885         val List<String> listKeys = new ArrayList();\r
1886 \r
1887         if(list.keyDefinition !== null) {\r
1888             val keyDefinitions = list.keyDefinition;\r
1889             for (keyDefinition : keyDefinitions) {\r
1890                 listKeys.add(keyDefinition.localName);\r
1891             }\r
1892         }\r
1893         return listKeys;\r
1894     }\r
1895 \r
1896     /**\r
1897      * Generates for the <code>list</code> which contains any list keys special\r
1898      * generated TO builder.\r
1899      *\r
1900      * @param packageName\r
1901      *            string with package name to which the list belongs\r
1902      * @param list\r
1903      *            list schema node which is source of data about the list name\r
1904      * @return generated TO builder which represents the keys of the\r
1905      *         <code>list</code> or null if <code>list</code> is null or list of\r
1906      *         key definitions is null or empty.\r
1907      */\r
1908     private def GeneratedTOBuilder resolveListKeyTOBuilder(String packageName, ListSchemaNode list) {\r
1909         var GeneratedTOBuilder genTOBuilder = null;\r
1910         if((list.keyDefinition !== null) && (!list.keyDefinition.isEmpty())) {\r
1911             if(list !== null) {\r
1912                 val listName = list.QName.localName + "Key";\r
1913                 val String genTOName = parseToClassName(listName);\r
1914                 genTOBuilder = new GeneratedTOBuilderImpl(packageName, genTOName);\r
1915             }\r
1916         }\r
1917         return genTOBuilder;\r
1918 \r
1919     }\r
1920 \r
1921     /**\r
1922      * Builds generated TO builders for <code>typeDef</code> of type\r
1923      * {@link org.opendaylight.yangtools.yang.model.util.UnionType UnionType} or\r
1924      * {@link org.opendaylight.yangtools.yang.model.api.type.BitsTypeDefinition\r
1925      * BitsTypeDefinition} which are also added to <code>typeBuilder</code> as\r
1926      * enclosing transfer object.\r
1927      *\r
1928      * If more then one generated TO builder is created for enclosing then all\r
1929      * of the generated TO builders are added to <code>typeBuilder</code> as\r
1930      * enclosing transfer objects.\r
1931      *\r
1932      * @param typeDef\r
1933      *            type definition which can be of type <code>UnionType</code> or\r
1934      *            <code>BitsTypeDefinition</code>\r
1935      * @param typeBuilder\r
1936      *            generated type builder to which is added generated TO created\r
1937      *            from <code>typeDef</code>\r
1938      * @param leafName\r
1939      *            string with name for generated TO builder\r
1940      * @return generated TO builder for <code>typeDef</code>\r
1941      */\r
1942     private def GeneratedTOBuilder addTOToTypeBuilder(TypeDefinition<?> typeDef, GeneratedTypeBuilder typeBuilder,\r
1943         String leafName, LeafSchemaNode leaf, Module parentModule) {\r
1944         val classNameFromLeaf = parseToClassName(leafName);\r
1945         val List<GeneratedTOBuilder> genTOBuilders = new ArrayList();\r
1946         val packageName = typeBuilder.fullyQualifiedName;\r
1947         if(typeDef instanceof UnionTypeDefinition) {\r
1948             genTOBuilders.addAll(\r
1949                 (typeProvider as TypeProviderImpl).\r
1950                     provideGeneratedTOBuildersForUnionTypeDef(packageName, (typeDef as UnionTypeDefinition),\r
1951                         classNameFromLeaf, leaf));\r
1952         } else if(typeDef instanceof BitsTypeDefinition) {\r
1953             genTOBuilders.add(\r
1954                 ((typeProvider as TypeProviderImpl) ).\r
1955                     provideGeneratedTOBuilderForBitsTypeDefinition(packageName, typeDef, classNameFromLeaf));\r
1956         }\r
1957         if(genTOBuilders !== null && !genTOBuilders.isEmpty()) {\r
1958             for (genTOBuilder : genTOBuilders) {\r
1959                 typeBuilder.addEnclosingTransferObject(genTOBuilder);\r
1960             }\r
1961             return genTOBuilders.get(0);\r
1962         }\r
1963         return null;\r
1964 \r
1965     }\r
1966 \r
1967     /**\r
1968      * Adds the implemented types to type builder.\r
1969      *\r
1970      * The method passes through the list of <i>uses</i> in\r
1971      * {@code dataNodeContainer}. For every <i>use</i> is obtained coresponding\r
1972      * generated type from {@link BindingGeneratorImpl#allGroupings\r
1973      * allGroupings} which is added as <i>implements type</i> to\r
1974      * <code>builder</code>\r
1975      *\r
1976      * @param dataNodeContainer\r
1977      *            element which contains the list of used YANG groupings\r
1978      * @param builder\r
1979      *            builder to which are added implemented types according to\r
1980      *            <code>dataNodeContainer</code>\r
1981      * @return generated type builder with all implemented types\r
1982      */\r
1983     private def addImplementedInterfaceFromUses(DataNodeContainer dataNodeContainer, GeneratedTypeBuilder builder) {\r
1984         for (usesNode : dataNodeContainer.uses) {\r
1985             if(usesNode.groupingPath !== null) {\r
1986                 val genType = allGroupings.get(usesNode.groupingPath);\r
1987                 if(genType === null) {\r
1988                     throw new IllegalStateException(\r
1989                         "Grouping " + usesNode.groupingPath + "is not resolved for " + builder.name);\r
1990                 }\r
1991                 builder.addImplementsType(genType);\r
1992             }\r
1993         }\r
1994         return builder;\r
1995     }\r
1996 }\r