5.6.2. foreach=”reference”

Context	code instructions/foreach loop
Signature	foreach=”reference”
Description	foreach=”reference” instructs CodeComposer to generate code for each model reference of the current model object regardless of its multiplicity. Warning foreach=”reference” 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	This foreach raises an InvalidPatternException when the context does not contain a model object: 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 an 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.48 codecomposer-reference-input/src/codeinstruction/examples/example-code-instruction-simple-entity-foreach-reference.xml <?xml version="1.0" encoding="UTF-8"?> <java_package xmlns="https://metafactory.io/xsd/v1/java-codeinstruction" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="https://metafactory.io/xsd/v1/java-codeinstruction https://metafactory.io/xsd/v1/java-codeinstruction.xsd" name="${pattern.property.java.package.base}.entities.simple" path="${pattern.property.java.main.directory}" package="domain_model"> <class name="${createSimpleEntityClassName(${object.name})}" foreach="object"> <field name="${reference.name}" access="rw" foreach="reference" > <datatype> ${createSimpleEntityClassName(${reference.type})} </datatype> <apicommentline>${fmsnippet.examples.exampleCommentForReference}</apicommentline> </field> </class> </java_package> Listing 5.49 codecomposer-reference-input/src/snippet/examples/exampleCommentForReference.ftl <#if !(modelReference)??> <#stop "modelReference not found in context" ></#if> This is an example comment for a reference with any multiplicity: ${modelReference.type} ${modelReference.name}. Listing 5.50 codecomposer-reference-input/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.51 codecomposer-reference-output/codecomposer-reference-output/src/main/java/io/metafactory/codecomposer_reference/ExampleEmployee.java public class ExampleEmployee { private ExampleEmployee manager; // This is an example comment for a reference with any multiplicity: ExampleEmployee manager private Set<ExampleEmployee> colleagues; // This is an example comment for a reference with any multiplicity: ExampleEmployee colleagues }