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

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