doc.entities.entity.ftl Maven / Gradle / Ivy
<#import "/doc/common.ftl" as common>
Hibernate Mappings - Entity Info
<@common.header/>
<#if class.packageName?length gt 0>
${class.packageName}
<#else>
Default package
Entity ${class.getShortName()}
-
<#assign superClasses=dochelper.getInheritanceHierarchy(class)>
<#list superClasses?reverse as superClass>
<#-- whitespace is significant here -->
<#if superClass_index gt 0>
)})
${superClass.qualifiedDeclarationName}
class="first">
-
<#-- whitespace is significant here -->
<#if class.subclass>${class.qualifiedDeclarationName}
<#list superClasses as superClass>
<#if class.getMetaAsString("class-description")?has_content>
${class.getMetaAsString("class-description")}
<#if class.hasIdentifierProperty()>
<#assign propertyIdentifier = class.getIdentifierProperty()>
Identifier Summary
Name
Column
Type
Description
<#if dochelper.getComponentPOJO(propertyIdentifier)?exists>
<#assign compoclass = dochelper.getComponentPOJO(propertyIdentifier)>
<#foreach property in compoclass.allPropertiesIterator>
<#assign columnIterator = property.getValue().columnIterator>
<#assign rowspan = property.getValue().getColumnSpan()>
0)>rowspan="${rowspan}">
${property.name}
<#if (rowspan > 0)>
<#assign column = columnIterator.next()>
<#if column.isFormula()>
<#else>
${column.getName()}
<#else>
0)>rowspan="${rowspan}">
<#if dochelper.getComponentPOJO(property)?exists>
${compoclass.getJavaTypeName(property, jdk5)?html?default(" ")}
<#else>
${compoclass.getJavaTypeName(property, jdk5)?html?default(" ")}
0)>rowspan="${rowspan}">
<#if compoclass.hasFieldJavaDoc(property)?exists>
${compoclass.getFieldDescription(property)?default(" ")}
<#else>
<#if (rowspan > 1)>
<#foreach column in columnIterator>
${column.name}
<#else>
${propertyIdentifier.name}
Column
${class.getJavaTypeName(propertyIdentifier, jdk5)?html?default(" ")}
<#if class.hasFieldJavaDoc(propertyIdentifier)>
${class.getFieldDescription(propertyIdentifier)?default(" ")}
<#else>
<#else>
<#list superClasses as superClass>
<#if superClass.hasIdentifierProperty()>
<#assign identifier = superClass.identifierProperty>
<#assign superClassRef = docFileManager.getRef(docFile, docFileManager.getEntityDocFileByDeclarationName(superClass))>
Identifier Summary
Identifier inherited from entity ${superClass.shortName}
${identifier.name}
<#if class.hasVersionProperty()>
<#assign version = class.versionProperty>
Version Summary
Name
Column
Type
Description
${version.name}
Column
${class.getJavaTypeName(version, jdk5)?html?default(" ")}
<#if class.hasFieldJavaDoc(version)>
${class.getFieldDescription(version)?default(" ")}
<#else>
<#else>
<#list superClasses as superClass>
<#if superClass.hasVersionProperty()>
<#assign version = superClass.versionProperty>
<#assign superClassRef = docFileManager.getRef(docFile, docFileManager.getEntityDocFileByDeclarationName(superClass))>
Version Summary
Version inherited from entity ${superClass.shortName}
${version.name}
<#assign properties = dochelper.getOrderedSimpleProperties(class)>
<#if !properties.empty>
Property Summary
Name
Column
Access
Type
Description
<#foreach property in properties>
<#assign columnIterator = property.getValue().columnIterator>
<#assign rowspan = property.getValue().getColumnSpan()>
0)>rowspan="${rowspan}">
${property.name}
<#if (rowspan > 0)>
<#assign column = columnIterator.next()>
<#if column.isFormula()>
<#else>
${column.getName()}
<#else>
0)>rowspan="${rowspan}">
${property.getPropertyAccessorName()} (get / set)
0)>rowspan="${rowspan}">
<#if dochelper.getComponentPOJO(property)?exists>
${class.getJavaTypeName(property, jdk5)?html?default(" ")}
<#else>
${class.getJavaTypeName(property, jdk5)?html?default(" ")}
0)>rowspan="${rowspan}">
<#if class.hasFieldJavaDoc(property)>
${class.getFieldDescription(property)?default(" ")}
<#else>
<#if (rowspan > 1)>
<#foreach column in columnIterator>
${column.name}
<#assign propertyHeader = properties.empty>
<#list superClasses as superClass>
<#assign superProperties = dochelper.getOrderedSimpleProperties(superClass)>
<#if !superProperties.empty>
<#assign superClassRef = docFileManager.getRef(docFile, docFileManager.getEntityDocFileByDeclarationName(superClass))>
<#if propertyHeader>
<#assign propertyHeader = false>
Property Summary
Properties inherited from entity ${superClass.shortName}
<#list superProperties as property>
${property.name}<#if property_has_next>,
<#if class.hasIdentifierProperty()>
<#assign identifier = class.identifierProperty>
Identifier Detail
<#if dochelper.getComponentPOJO(identifier)?exists>
<#assign identifierClass = dochelper.getComponentPOJO(identifier)>
<#foreach property in identifierClass.allPropertiesIterator>
${property.name}
<#else>
${identifier.name}
<#if class.hasVersionProperty()>
<#assign version = class.versionProperty>
Version Detail
<#assign version = class.versionProperty>
${version.name}
<#assign properties = dochelper.getSimpleProperties(class)>
<#if !properties.empty>
Property Detail
<#list properties as property>
${property.name}