added field based annotations; some refactoring

Mario David · Mario David · commit d7cabd3a1d27 · 2017-09-20T11:52:18.000+02:00
diff --git a/README.md b/README.md
@@ -18,8 +18,8 @@ Select a version of the add-on which is compatible with the platform version use
 
 | Platform Version | Add-on Version |
 | ---------------- | -------------- |
-| 6.6.x            | 0.2.0          |
-| 6.5.x            | 0.1.0          |
+| 6.6.x            | 0.2.x - 0.3.x  |
+| 6.5.x            | 0.1.x          |
 
 Add custom application component to your project:
 
@@ -86,9 +86,14 @@ is the only superclass you need to extend from. Not for every feature another su
 
 ## Defining Annotations 
 
+
 Generally, there is another example repository, which shows the usage of this application component: [balvi/cuba-example-declarative-comments](https://github.com/balvi/cuba-example-declarative-comments) 
 with the exact example of the `@Commentable`.
 
+The application component allows two kinds of Annotations. A class-based Annotation and a field-based Annotation.
+
+### Class-based Annotation: @Commentable
+
 To create custom feature like `@Commentable` you have to do the following:
 
 1. Create a Annotation in your web module like this:
@@ -151,6 +156,13 @@ you can take a look at the corresponding CUBA docs for
 [AbstractLookup](https://doc.cuba-platform.com/manual-6.6/abstractLookup.html) and [AbstractEditor](https://doc.cuba-platform.com/manual-6.6/abstractEditor.html).
 
 
+### Field-based Annotations
+
+Field based annotations are useful if you want to enhance a particular Component on the page.
+
+You can find the example for this in the example-project: [@IconCommentedEntities](https://github.com/balvi/cuba-example-declarative-comments/blob/master/modules/web/src/de/balvi/cuba/example/declarativecomments/web/iconcommented/IconCommentedEntities.groovy)
+
+
 That's it. 
 
 With this you have a single place where you can put your UI logic that is accessible for different screens.
diff --git a/build.gradle b/build.gradle
@@ -35,7 +35,7 @@ cuba {
     artifact {
         group = 'de.balvi.cuba.declarativecontrollers'
         version = '0.3'
-        isSnapshot = true
+        isSnapshot = false
     }
     tomcat {
         dir = "$project.rootDir/deploy/tomcat"
diff --git a/gradle/wrapper/gradle-wrapper.jar b/gradle/wrapper/gradle-wrapper.jar
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wrapper.properties
@@ -1,6 +1,6 @@
-#Mon Sep 18 16:17:01 CEST 2017
+#Wed Sep 20 11:35:13 CEST 2017
 distributionBase=GRADLE_USER_HOME
 distributionPath=wrapper/dists
 zipStoreBase=GRADLE_USER_HOME
 zipStorePath=wrapper/dists
-distributionUrl=https\://services.gradle.org/distributions/gradle-3.5-bin.zip
+distributionUrl=https\://services.gradle.org/distributions/gradle-3.4-bin.zip
diff --git a/modules/core/db/init/hsql/10.create-db.sql b/modules/core/db/init/hsql/10.create-db.sql
@@ -1 +1,16 @@
-
+-- begin DBCDC_CUSTOMER
+create table DBCDC_CUSTOMER (
+    ID varchar(36) not null,
+    VERSION integer not null,
+    CREATE_TS timestamp,
+    CREATED_BY varchar(50),
+    UPDATE_TS timestamp,
+    UPDATED_BY varchar(50),
+    DELETE_TS timestamp,
+    DELETED_BY varchar(50),
+    --
+    NAME varchar(255),
+    --
+    primary key (ID)
+)^
+-- end DBCDC_CUSTOMER
diff --git a/modules/core/db/update/hsql/17/170919-1-createCustomer.sql b/modules/core/db/update/hsql/17/170919-1-createCustomer.sql
@@ -0,0 +1,14 @@
+create table DBCDC_CUSTOMER (
+    ID varchar(36) not null,
+    VERSION integer not null,
+    CREATE_TS timestamp,
+    CREATED_BY varchar(50),
+    UPDATE_TS timestamp,
+    UPDATED_BY varchar(50),
+    DELETE_TS timestamp,
+    DELETED_BY varchar(50),
+    --
+    NAME varchar(255),
+    --
+    primary key (ID)
+);
diff --git a/modules/global/src/de/balvi/cuba/declarativecontrollers/app-component.xml b/modules/global/src/de/balvi/cuba/declarativecontrollers/app-component.xml
@@ -21,6 +21,10 @@
                   value="+de/balvi/cuba/declarativecontrollers/spring.xml"/>
         <property name="cuba.mainMessagePack"
                   value="+de.balvi.cuba.declarativecontrollers.core"/>
+        <artifact classifier="db"
+                  configuration="dbscripts"
+                  ext="zip"
+                  name="declarativecontrollers-core"/>
     </module>
     <module blocks="web,desktop"
             dependsOn="global"
diff --git a/modules/global/src/de/balvi/cuba/declarativecontrollers/entity/messages.properties b/modules/global/src/de/balvi/cuba/declarativecontrollers/entity/messages.properties
diff --git a/modules/global/src/de/balvi/cuba/declarativecontrollers/persistence.xml b/modules/global/src/de/balvi/cuba/declarativecontrollers/persistence.xml
@@ -1,6 +1,7 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
-<persistence xmlns="http://java.sun.com/xml/ns/persistence" version="2.0">
-    <persistence-unit name="cuba-component-declarative-controllers" transaction-type="RESOURCE_LOCAL">
-
+<persistence xmlns="http://java.sun.com/xml/ns/persistence"
+             version="2.0">
+    <persistence-unit name="cuba-component-declarative-controllers"
+                      transaction-type="RESOURCE_LOCAL">
     </persistence-unit>
 </persistence>
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web-menu.xml b/modules/web/src/de/balvi/cuba/declarativecontrollers/web-menu.xml
@@ -2,4 +2,4 @@
 <menu-config xmlns="http://schemas.haulmont.com/cuba/menu.xsd">
     <menu id="application-dbcdc" insertBefore="administration">
     </menu>
-</menu-config>
+</menu-config>
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web-screens.xml b/modules/web/src/de/balvi/cuba/declarativecontrollers/web-screens.xml
@@ -1,6 +1,4 @@
 <?xml version="1.0" encoding="UTF-8" standalone="no"?>
 <screen-config xmlns="http://schemas.haulmont.com/cuba/screens.xsd">
-
     <include file="de/balvi/cuba/declarativecontrollers/screens.xml"/>
-
-</screen-config>
+</screen-config>
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/AbstractAnnotationDispatcherBean.java b/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/AbstractAnnotationDispatcherBean.java
@@ -0,0 +1,41 @@
+package de.balvi.cuba.declarativecontrollers.web.annotationexecutor;
+
+import com.haulmont.cuba.gui.components.Frame;
+
+import java.lang.annotation.Annotation;
+import java.lang.reflect.Field;
+import java.util.ArrayList;
+import java.util.Collection;
+
+abstract public class AbstractAnnotationDispatcherBean<T extends AnnotationExecutor, K extends AnnotationExecutor> {
+
+    protected Field[] getDeclaredFields(Frame frame) {
+        return frame.getClass().getDeclaredFields();
+    }
+
+    protected com.haulmont.cuba.gui.components.Component getFieldValue(Frame frame, Field field) {
+        try {
+            field.setAccessible(true);
+            return (com.haulmont.cuba.gui.components.Component) field.get(frame);
+        } catch (IllegalAccessException e) {
+            e.printStackTrace();
+            return null;
+        }
+    }
+
+
+    protected Annotation[] getClassAnnotations(Frame frame) {
+        return frame.getClass().getAnnotations();
+    }
+
+    protected Collection<? extends AnnotationExecutor> getSupportedAnnotationExecutors(Collection<? extends AnnotationExecutor> potentialAnnotationExecutors, Annotation annotation) {
+        Collection<AnnotationExecutor> result = new ArrayList<AnnotationExecutor>();
+        for (AnnotationExecutor annotationExecutor : potentialAnnotationExecutors) {
+            if (annotationExecutor.supports(annotation)) {
+                result.add(annotationExecutor);
+            }
+        }
+        return result;
+
+    }
+}
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/AnnotationExecutor.java b/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/AnnotationExecutor.java
@@ -1,4 +1,4 @@
-package de.balvi.cuba.declarativecontrollers.web;
+package de.balvi.cuba.declarativecontrollers.web.annotationexecutor;
 
 import java.lang.annotation.Annotation;
 
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/browse/BrowseAnnotationExecutor.java b/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/browse/BrowseAnnotationExecutor.java
@@ -1,13 +1,14 @@
-package de.balvi.cuba.declarativecontrollers.web.browse;
-
-import com.haulmont.cuba.gui.components.Window;
-import de.balvi.cuba.declarativecontrollers.web.AnnotationExecutor;
-
-import java.lang.annotation.Annotation;
-import java.util.Map;
-
-public interface BrowseAnnotationExecutor<A extends Annotation> extends AnnotationExecutor {
-
-    void init(A annotation, Window.Lookup browse, Map<String, Object> params);
-    void ready(A annotation, Window.Lookup browse, Map<String, Object> params);
+package de.balvi.cuba.declarativecontrollers.web.annotationexecutor.browse;
+
+import com.haulmont.cuba.gui.components.Window;
+import de.balvi.cuba.declarativecontrollers.web.annotationexecutor.AnnotationExecutor;
+
+import java.lang.annotation.Annotation;
+import java.util.Map;
+
+public interface BrowseAnnotationExecutor<A extends Annotation> extends AnnotationExecutor {
+
+    void init(A annotation, Window.Lookup browse, Map<String, Object> params);
+
+    void ready(A annotation, Window.Lookup browse, Map<String, Object> params);
 }
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/browse/BrowseFieldAnnotationExecutor.java b/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/browse/BrowseFieldAnnotationExecutor.java
@@ -0,0 +1,16 @@
+package de.balvi.cuba.declarativecontrollers.web.annotationexecutor.browse;
+
+import com.haulmont.cuba.gui.components.Component;
+import com.haulmont.cuba.gui.components.Window;
+import de.balvi.cuba.declarativecontrollers.web.annotationexecutor.AnnotationExecutor;
+
+import java.lang.annotation.Annotation;
+import java.util.Map;
+
+public interface BrowseFieldAnnotationExecutor<A extends Annotation, T extends Component> extends AnnotationExecutor {
+
+    void init(A annotation, Window.Lookup browse, T target, Map<String, Object> params);
+
+    void ready(A annotation, Window.Lookup browse, T target, Map<String, Object> params);
+
+}
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/editor/EditorAnnotationExecutor.java b/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/editor/EditorAnnotationExecutor.java
@@ -1,15 +1,15 @@
-package de.balvi.cuba.declarativecontrollers.web.editor;
-
-import com.haulmont.cuba.gui.components.Window;
-import de.balvi.cuba.declarativecontrollers.web.AnnotationExecutor;
-
-import java.lang.annotation.Annotation;
-import java.util.Map;
-
-public interface EditorAnnotationExecutor<A extends Annotation> extends AnnotationExecutor {
-
-    void init(A annotation, Window.Editor editor, Map<String, Object> params);
-
-    void postInit(A annotation, Window.Editor editor);
-
+package de.balvi.cuba.declarativecontrollers.web.annotationexecutor.editor;
+
+import com.haulmont.cuba.gui.components.Window;
+import de.balvi.cuba.declarativecontrollers.web.annotationexecutor.AnnotationExecutor;
+
+import java.lang.annotation.Annotation;
+import java.util.Map;
+
+public interface EditorAnnotationExecutor<A extends Annotation> extends AnnotationExecutor {
+
+    void init(A annotation, Window.Editor editor, Map<String, Object> params);
+
+    void postInit(A annotation, Window.Editor editor);
+
 }
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/editor/EditorFieldAnnotationExecutor.java b/modules/web/src/de/balvi/cuba/declarativecontrollers/web/annotationexecutor/editor/EditorFieldAnnotationExecutor.java
@@ -0,0 +1,16 @@
+package de.balvi.cuba.declarativecontrollers.web.annotationexecutor.editor;
+
+import com.haulmont.cuba.gui.components.Component;
+import com.haulmont.cuba.gui.components.Window;
+import de.balvi.cuba.declarativecontrollers.web.annotationexecutor.AnnotationExecutor;
+
+import java.lang.annotation.Annotation;
+import java.util.Map;
+
+public interface EditorFieldAnnotationExecutor<A extends Annotation, T extends Component> extends AnnotationExecutor {
+
+    void init(A annotation, Window.Editor editor, T target, Map<String, Object> params);
+
+    void postInit(A annotation, Window.Editor editor, T target);
+
+}
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web/browse/BrowseAnnotationDispatcherBean.java b/modules/web/src/de/balvi/cuba/declarativecontrollers/web/browse/BrowseAnnotationDispatcherBean.java
@@ -1,24 +1,44 @@
 package de.balvi.cuba.declarativecontrollers.web.browse;
 
 import com.haulmont.cuba.core.global.AppBeans;
+import de.balvi.cuba.declarativecontrollers.web.annotationexecutor.AbstractAnnotationDispatcherBean;
+import de.balvi.cuba.declarativecontrollers.web.annotationexecutor.browse.BrowseAnnotationExecutor;
+import de.balvi.cuba.declarativecontrollers.web.annotationexecutor.browse.BrowseFieldAnnotationExecutor;
 import groovy.transform.CompileStatic;
 import org.springframework.stereotype.Component;
 
 import java.lang.annotation.Annotation;
-import java.util.ArrayList;
+import java.lang.reflect.Field;
 import java.util.Collection;
 import java.util.Map;
 
-@CompileStatic
 @Component(BrowseAnnotationDispatcher.NAME)
-class BrowseAnnotationDispatcherBean implements BrowseAnnotationDispatcher {
+class BrowseAnnotationDispatcherBean extends AbstractAnnotationDispatcherBean<BrowseAnnotationExecutor, BrowseFieldAnnotationExecutor> implements BrowseAnnotationDispatcher {
 
     @Override
     public void executeInit(AnnotatableAbstractLookup browse, Map<String, Object> params) {
-        Annotation[] annotations = browse.getClass().getAnnotations();
+        executeInitForClassAnnotations(browse, params);
+        executeInitForFieldAnnotations(browse, params);
+    }
+
+    private void executeInitForFieldAnnotations(AnnotatableAbstractLookup browse, Map<String, Object> params) {
+        for (Field field : getDeclaredFields(browse)) {
+            Annotation[] fieldAnnotations = field.getAnnotations();
+
+            for (Annotation annotation : fieldAnnotations) {
+                com.haulmont.cuba.gui.components.Component fieldValue = getFieldValue(browse, field);
+
+                Collection<BrowseFieldAnnotationExecutor> supportedAnnotations = getSupportedBrowseFieldAnnotationExecutors(annotation);
 
-        for (Annotation annotation : annotations) {
+                for (BrowseFieldAnnotationExecutor annotationExecutor : supportedAnnotations) {
+                    annotationExecutor.init(annotation, browse, fieldValue, params);
+                }
+            }
+        }
+    }
 
+    private void executeInitForClassAnnotations(AnnotatableAbstractLookup browse, Map<String, Object> params) {
+        for (Annotation annotation : getClassAnnotations(browse)) {
             Collection<BrowseAnnotationExecutor> supportedAnnotations = getSupportedBrowseAnnotationExecutors(annotation);
 
             for (BrowseAnnotationExecutor annotationExecutor : supportedAnnotations) {
@@ -28,11 +48,31 @@ public void executeInit(AnnotatableAbstractLookup browse, Map<String, Object> pa
     }
 
 
+
     @Override
     public void executeReady(AnnotatableAbstractLookup browse, Map<String, Object> params) {
-        Annotation[] annotations = browse.getClass().getAnnotations();
+        executeReadyForClassAnnotations(browse, params);
+        executeReadyForFieldAnnotations(browse, params);
+    }
+
+    private void executeReadyForFieldAnnotations(AnnotatableAbstractLookup browse, Map<String, Object> params) {
+        for (Field field : getDeclaredFields(browse)) {
 
-        for (Annotation annotation : annotations) {
+            Annotation[] fieldAnnotations = field.getAnnotations();
+            for (Annotation annotation : fieldAnnotations) {
+                com.haulmont.cuba.gui.components.Component fieldValue = getFieldValue(browse, field);
+
+                Collection<BrowseFieldAnnotationExecutor> supportedAnnotations = getSupportedBrowseFieldAnnotationExecutors(annotation);
+
+                for (BrowseFieldAnnotationExecutor annotationExecutor : supportedAnnotations) {
+                    annotationExecutor.ready(annotation, browse, fieldValue, params);
+                }
+            }
+        }
+    }
+
+    private void executeReadyForClassAnnotations(AnnotatableAbstractLookup browse, Map<String, Object> params) {
+        for (Annotation annotation : getClassAnnotations(browse)) {
 
             Collection<BrowseAnnotationExecutor> supportedAnnotations = getSupportedBrowseAnnotationExecutors(annotation);
 
@@ -44,19 +84,23 @@ public void executeReady(AnnotatableAbstractLookup browse, Map<String, Object> p
 
 
     protected Collection<BrowseAnnotationExecutor> getSupportedBrowseAnnotationExecutors(Annotation annotation) {
-        Collection<BrowseAnnotationExecutor> browseAnnotationExecutors = getBrowseAnnotationExecutors();
-
-        Collection<BrowseAnnotationExecutor> result = new ArrayList<>();
-        for (BrowseAnnotationExecutor annotationExecutor : browseAnnotationExecutors) {
-            if (annotationExecutor.supports(annotation)) {
-                result.add(annotationExecutor);
-            }
-        }
-        return result;
+        Collection<BrowseAnnotationExecutor> annotationExecutors = getBrowseAnnotationExecutors();
+        return (Collection<BrowseAnnotationExecutor>) getSupportedAnnotationExecutors(annotationExecutors, annotation);
+    }
 
+    protected Collection<BrowseFieldAnnotationExecutor> getSupportedBrowseFieldAnnotationExecutors(Annotation annotation) {
+        Collection<BrowseFieldAnnotationExecutor> annotationExecutors = getBrowseFieldAnnotationExecutors();
+        return (Collection<BrowseFieldAnnotationExecutor>) getSupportedAnnotationExecutors(annotationExecutors, annotation);
     }
 
     protected Collection<BrowseAnnotationExecutor> getBrowseAnnotationExecutors() {
         return AppBeans.getAll(BrowseAnnotationExecutor.class).values();
     }
+
+
+    protected Collection<BrowseFieldAnnotationExecutor> getBrowseFieldAnnotationExecutors() {
+        return AppBeans.getAll(BrowseFieldAnnotationExecutor.class).values();
+    }
+
+
 }
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web/editor/EditorAnnotationDispatcherBean.java b/modules/web/src/de/balvi/cuba/declarativecontrollers/web/editor/EditorAnnotationDispatcherBean.java
diff --git a/modules/web/src/de/balvi/cuba/declarativecontrollers/web/messages.properties b/modules/web/src/de/balvi/cuba/declarativecontrollers/web/messages.properties
diff --git a/modules/web/test/de/balvi/cuba/declarativecontrollers/web/browse/BrowseAnnotationDispatcherBeanSpec.groovy b/modules/web/test/de/balvi/cuba/declarativecontrollers/web/browse/BrowseAnnotationDispatcherBeanSpec.groovy
diff --git a/modules/web/test/de/balvi/cuba/declarativecontrollers/web/editor/EditorAnnotationDispatcherBeanSpec.groovy b/modules/web/test/de/balvi/cuba/declarativecontrollers/web/editor/EditorAnnotationDispatcherBeanSpec.groovy

Original file line number	Diff line number	Diff line change
`@@ -35,7 +35,7 @@ cuba {`
`35`	`35`	`artifact {`
`36`	`36`	`group = 'de.balvi.cuba.declarativecontrollers'`
`37`	`37`	`version = '0.3'`
`38`		`- isSnapshot = true`
	`38`	`+ isSnapshot = false`
`39`	`39`	`}`
`40`	`40`	`tomcat {`
`41`	`41`	`dir = "$project.rootDir/deploy/tomcat"`