5.6.3. foreach=”reference1”

Context	code instructions/foreach reference
Signature	foreach=”reference1”
Description	foreach=”reference1” instructs CodeComposer to generate code for each model reference of the current model object that has multiplicity 0..1 or 1..1. Warning foreach=”reference1” only works when a current model object is present in the context: either specify foreach=”object” or refer directly to an object with object=”<object name>” in your code instruction. Note CodeComposer will place the current model reference in the context with name modelReference for use in build-in functions, custom functions and snippets during generation.
Exceptions	Error InvalidPatternException: invalid pattern: trying to create a <patternType> foreach reference but currentModelObject is null. Either specify a foreach=”object” in pattern or refer directly to a object of the model with the package=”<package name>” and object=”<object name>” statement. Failed to produce code due to invalid pattern.
Example	CodeComposer input Listing 5.52 src/codeinstruction/examples/example-code-instruction.xml <java_package > <class name="${object.name}" visibility="public" foreach="object" > <field name="${reference.name}" access="rw" foreach="reference1" > <datatype>${reference.type}</datatype> <devcommentline>${fmsnippet.examples.exampleReferenceComment}</devcommentline> </field> </class> </java_package> Listing 5.53 src/snippet/examples/exampleReference1Comment.ftl <#if !(modelReference)??> <#stop "modelReference not found in context" ></#if> This is an example comment for a reference with multiplicity 0..1 or 1..1: ${modelReference.type} ${modelReference.name}. Listing 5.54 src/model/model.xml <model> <package> <object name="ExampleEmployee"> <metadata></metadata> <attribute name="name" type="String" length="255" notnull="false"> <metadata></metadata> </attribute> <reference name="manager" type="ExampleEmployee" multiplicity="0..1" notnull="false"> <metadata></metadata> </reference> <reference name="colleagues" type="ExampleEmployee" multiplicity="0..n" notnull="false"> <metadata></metadata> </reference> </object> </package> </model> CodeComposer output Listing 5.55 src/main/java/io/metafactory/codecomposer_reference/ExampleEmployee.java public class ExampleEmployee { private ExampleEmployee manager; // This is an example comment for ExampleEmployee manager }