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