ea2ddl-gen/dbflute/templates/om/java/allcommon/EntityDefinedCommonColumn.vm

   1 ${database.allClassCopyright}package ${glPackageBaseCommon};\r
   2 \r
   3 /**\r
   4  * The interface of entity defined common column.\r
   5  * @author ${database.ClassAuthor}\r
   6  */\r
   7 public interface ${glEntityDefinedCommonColumnInterfaceName} extends ${glEntityInterfaceName} {\r
   8 #foreach ($columnName in ${database.commonColumnNameList})\r
   9   #set ($filteredColumnName = ${database.filterCommonColumn(${columnName})})\r
  10   #set ($commonColumnMap = ${database.CommonColumnMap})\r
  11   #set ($columnType = ${commonColumnMap.get(${columnName})})\r
  12   #set ($javaNative = ${database.convertJavaNativeByJdbcType(${columnType})})\r
  13   #set ($javaName = ${database.convertJavaNameByJdbcNameAsColumn(${filteredColumnName})})\r
  14   #set ($uncapitalisedJavaName = ${database.convertUncapitalisedJavaNameByJdbcNameAsColumn(${filteredColumnName})})\r
  15 \r
  16     /**\r
  17      * Get the value of ${uncapitalisedJavaName}.\r
  18      * @return The value of ${uncapitalisedJavaName}. (Nullable)\r
  19      */\r
  20     public ${javaNative} get${javaName}();\r
  21 \r
  22     /**\r
  23      * Set the value of ${uncapitalisedJavaName}.\r
  24      * @param ${uncapitalisedJavaName} The value of ${uncapitalisedJavaName}. (Nullable)\r
  25      */\r
  26     public void set${javaName}(${javaNative} ${uncapitalisedJavaName});\r
  27   #if (${database.isAllClassificationColumn($filteredColumnName)})\r
  28     #set ($classificationName = $database.getAllClassificationName($filteredColumnName))\r
  29     #set ($classificationList = $database.getClassificationMapList($classificationName))\r
  30     #foreach ($classificationMap in $classificationList)\r
  31 \r
  32     /**\r
  33      * Classify the value of ${uncapitalisedJavaName} as ${classificationMap.get('name')}.\r
  34      */\r
  35     public void classify${javaName}${classificationMap.get('name')}();\r
  36 \r
  37     /**\r
  38      * Is the value of ${uncapitalisedJavaName} '${classificationMap.get('name')}'?\r
  39          * <p>\r
  40      * The difference of capital letters and small letters is NOT distinguished.\r
  41      * If the value is null, this method returns false!\r
  42          * </p>\r
  43      * @return Determanation.\r
  44      */\r
  45     public boolean is${javaName}${classificationMap.get('name')}();\r
  46     #end\r
  47   #end\r
  48 #end\r
  49 \r
  50     /**\r
  51          * Disable common column auto set up.\r
  52          */\r
  53     public void disableCommonColumnAutoSetup();\r
  54         \r
  55     /**\r
  56          * Can the entity set up common column by auto?\r
  57          * @return Determination.\r
  58          */\r
  59         public boolean canCommonColumnAutoSetup();\r
  60 }\r