https://jira.opendaylight.org This file is an XML representation of an issue en-us 8.20.10 820010 22-06-2022 https://jira.opendaylight.org/browse/MDSAL-17 mdsal <p>Creating instance identifiers to identify particular nodes has proved cumbersome enough that most projects which have to create an instance identifier end up using helper classes.</p> <p>We should look at ways to simplify the instance ID creation, possibly by providing helper or utilities.</p> <p>Suggestion: Start by looking at the helper classes that have been created and consider consolidating them.</p> <p>Operating System: Mac OS<br/> Platform: PC</p> MDSAL-17

Simplify InstanceIdentifer creation

Improvement Resolved Done Jie Han Devin Avery Wed, 28 May 2014 14:16:25 +0000 Thu, 13 Sep 2018 02:44:57 +0000 Thu, 13 Sep 2018 02:44:57 +0000 Binding V2 codegen 0 5 <p>Instance IDentifier provides utilities<br/> such as<br/> create().</p> <p>Instance Identifier allows for fluent APIs and creating child identifiers from parent ones:<br/> NODE_ID = InstanceIdentifier.create(Nodes.class).child(Node.class,new NodeKey("foo"));<br/> AUG_ID = NODE_ID.augmentation(NodeAugmentation.class);</p> <p>I don't think Devin is referring to the InstanceIdentifier API but figuring out how to build correct a IID from a yang data model, i.e. what generated classes to use and how to stitch them together.</p> <p>One thing is to eliminate the need for explicitly specifying augmentation, Eg instead of:</p> <p> InstanceIdentifier.create(Nodes.class)<br/> .child(Node.class,new NodeKey("foo"))<br/> .augmentation(NodeAugmentation.class);</p> <p>possibly:</p> <p> InstanceIdentifier.create(Nodes.class)<br/> .child(NodeAugmentation.class,new NodeKey("foo"));</p> <p>The API could implicitly figure out that NodeAugmentation augments Node.</p> <p>It would be really cool if the generated code had a static getInstanceIdentifier() method. So one could simply call NodeAugmentation.getInstanceIdentifier(NodeKey nodeKey) and let that build it for you.</p> <p>At the very least, we could add helper classes for the common boilerplate stuff, eg NodeInstanceIdentifier.create(NodeKey nodeKey).</p> <p>Move to MD-SAL, as it requires support from the binding spec.</p> <p><a href="https://git.opendaylight.org/gerrit/67909" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/67909</a><br/> <a href="https://git.opendaylight.org/gerrit/67910" class="external-link" target="_blank" rel="nofollow noopener">https://git.opendaylight.org/gerrit/67910</a></p> <p>Problem here is that we really need that Node.class, which means we need to reflect/cache NodeAugmentation.class shape, so we know to derive the type from 'implements Augmentation&lt;Node&gt;. That is doable.</p> <p>Getting getInstanceIdentifier() ... I am not sure that's possible with the current state of affairs – I am afraid all we can do is getPathArgument(NodeKey) due to groupings and nested lists, but the problem is that:</p> <ul> <li>it bloats codegen classes</li> <li>it does not really save that much code</li> </ul> Blocks MDSAL-237 Relates MDSAL-308 Development External issue ID 1095 External issue URL Issue Type Priority Rank 0|i02vsv: