Changeset 2630

Timestamp:

02/08/10 14:05:59 (2 years ago)

Author:

mswertz

Message:

enhancement: documentation now shows inherited fields

Location:

molgenis/3.3/src/org/molgenis

Files:

• generators/doc/DotDocGen.java.ftl (modified) (2 diffs)
• generators/doc/ObjectModelDocGen.java.ftl (modified) (2 diffs)
• model/elements/Entity.java (modified) (2 diffs)

molgenis/3.3/src/org/molgenis/generators/doc/DotDocGen.java.ftl

@@ -62 +62 @@
                                         </#if>
                 
-                        label = "{<#if entity.abstract>Interface:</#if>${name(entity)}<#if entity.hasImplements()>\n implements ${csv(entity.getImplements())}</#if><#if entity.hasAncestor()>\n extends ${name(entity.getAncestor())}</#if>|<#list entity.implementedFields as f><#if !f.system>${name(f)} : ${f.type}<#if f.type=="xref" || f.type="mref">-&gt;${name(f.getXRefEntity())}</#if><#if !f.nillable>*</#if>\l</#if></#list>}"
+                        label = "{<#if entity.abstract>Interface:</#if>${JavaName(entity)}<#if entity.hasImplements()>\n implements ${csv(entity.getImplements())}</#if><#if entity.hasAncestor()>\n extends ${name(entity.getAncestor())}</#if>|<#list entity.implementedFields as f><#if !f.system>${name(f)} : ${f.type}<#if f.type=="xref" || f.type="mref">-&gt;${name(f.getXRefEntity())}</#if><#if !f.nillable>*</#if>\l</#if></#list>}"
                 ]
 
@@ -93 +93 @@
                                         </#if>
                 
-                        label = "{<#if entity.abstract>Interface:</#if>${name(entity)}<#if entity.hasImplements()>\n implements ${csv(entity.getImplements())}</#if><#if entity.hasAncestor()>\n extends ${name(entity.getAncestor())}</#if>|<#list entity.implementedFields as f><#if !f.system>${name(f)} : ${f.type}<#if f.type=="xref" || f.type="mref">-&gt;${name(f.getXRefEntity())}</#if><#if !f.nillable>*</#if>\l</#if></#list>}"
+                        label = "{<#if entity.abstract>Interface:</#if>${JavaName(entity)}<#if entity.hasImplements()>\n implements ${csv(entity.getImplements())}</#if><#if entity.hasAncestor()>\n extends ${name(entity.getAncestor())}</#if>|<#list entity.implementedFields as f><#if !f.system>${name(f)} : ${f.type}<#if f.type=="xref" || f.type="mref">-&gt;${name(f.getXRefEntity())}</#if><#if !f.nillable>*</#if>\l</#if></#list>}"
                 ]
 </#if></#list>

molgenis/3.3/src/org/molgenis/generators/doc/ObjectModelDocGen.java.ftl

@@ -25 +25 @@
 <#assign associations = false>
 <#assign attributes = false>
+<#assign inherited_attributes = false>
 <#list entity.fields as field>
 <#if field.type == "xref" || field.type=="mref">
@@ -32 +33 @@
 </#if>
 </#list>
+<#list entity.inheritedFields as field>
+<#if !field.system><#assign inherited_attributes = true></#if>
+</#list>
+<#if inherited_attributes>
+<p>
+<u>Inherited atttributes:</u><br/>
+<#list entity.inheritedFields as field><#if !field.system> 
+${field.name}, 
+</#if></#list>
+</p>
+</#if>
 <#if attributes == true>
 <p>

molgenis/3.3/src/org/molgenis/model/elements/Entity.java

@@ -387 +387 @@
                 {
                         Entity iface_entity = (Entity) getParent().get(iface);
-                        if (iface_entity == null) throw new MolgenisModelException("interface " + iface
-                                        + " is undefined in entity " + this.getName());
+                        if (iface_entity == null) throw new MolgenisModelException("interface '" + iface
+                                        + "' is undefined for entity " + this.getName());
                         implements_entities.add(iface_entity);
                 }
@@ -538 +538 @@
         }
 
+        public Vector<Field> getInheritedFields() throws MolgenisModelException
+        {
+                Map <String,Field> all_fields = new LinkedHashMap<String,Field>();
+
+                // second fields of the interfaces
+                for (Entity iface : this.getImplements())
+                {
+                        Vector<Field> ifaceFields = (Vector<Field>) iface.getAllFields().clone();
+                        for (Field ifaceField : ifaceFields)
+                        {
+                                //ifaceField.setEntity(this);
+                                        all_fields.put(ifaceField.getName(), ifaceField);
+                        }
+                }
+
+                // third the fields of the superclass
+                if (getAncestor() != null)
+                {
+                        for (Field f : getAncestor().getAllFields())
+                        {
+                                all_fields.put(f.getName(), f);
+                        }
+                }
+
+                // skip self...
+                return new Vector(all_fields.values());
+                
+        }
+        
         /**
          * @throws MolgenisModelException