Add annotations to describe properly data model: issue #777

OrienteerBAP · Mar 28, 2020 · 53c6fab · 53c6fab
1 parent 2e8abf6
commit 53c6fab
Show file tree

Hide file tree

Showing 7 changed files with 54 additions and 3 deletions.
diff --git a/orienteer-core/src/main/java/org/orienteer/core/dao/DAO.java b/orienteer-core/src/main/java/org/orienteer/core/dao/DAO.java
@@ -2,6 +2,8 @@
 
 import java.lang.reflect.Proxy;
 
+import org.apache.wicket.util.string.Strings;
+
 import com.orientechnologies.orient.core.id.ORID;
 import com.orientechnologies.orient.core.record.impl.ODocument;
 import com.orientechnologies.orient.core.type.ODocumentWrapper;
@@ -18,7 +20,11 @@ private DAO() {
 	}
 
 	public static <T> T create(Class<T> interfaceClass, Class<?>... additionalInterfaces) {
-		return provide(interfaceClass, new ODocumentWrapper(), additionalInterfaces);
+		DAOOClass daoOClass = interfaceClass.getAnnotation(DAOOClass.class);
+		ODocumentWrapper docWrapper = daoOClass!=null && !Strings.isEmpty(daoOClass.value())
+											? new ODocumentWrapper(daoOClass.value())
+											: new ODocumentWrapper();
+		return provide(interfaceClass, docWrapper, additionalInterfaces);
 	}
 
 	public static <T> T create(Class<T> interfaceClass, String className, Class<?>... additionalInterfaces) {

diff --git a/orienteer-core/src/main/java/org/orienteer/core/dao/DAOField.java b/orienteer-core/src/main/java/org/orienteer/core/dao/DAOField.java
@@ -0,0 +1,16 @@
+package org.orienteer.core.dao;
+
+import static java.lang.annotation.ElementType.METHOD;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Optional annotation to mark getter/setter methods for ODocumentWrappers
+ */
+@Retention(RUNTIME)
+@Target(METHOD)
+public @interface DAOField {
+	String value() default "";
+}
diff --git a/orienteer-core/src/main/java/org/orienteer/core/dao/DAOOClass.java b/orienteer-core/src/main/java/org/orienteer/core/dao/DAOOClass.java
@@ -0,0 +1,17 @@
+package org.orienteer.core.dao;
+
+import static java.lang.annotation.ElementType.TYPE;
+import static java.lang.annotation.RetentionPolicy.RUNTIME;
+
+import java.lang.annotation.Retention;
+import java.lang.annotation.Target;
+
+/**
+ * Optional annotation to mark interfaces which can be wrapped for DAO
+ */
+@Retention(RUNTIME)
+@Target(TYPE)
+public @interface DAOOClass {
+	String value();
+	String[] superClasses() default {};
+}
diff --git a/orienteer-core/src/main/java/org/orienteer/core/dao/handler/ODocumentGetHandler.java b/orienteer-core/src/main/java/org/orienteer/core/dao/handler/ODocumentGetHandler.java
@@ -2,6 +2,8 @@
 
 import java.lang.reflect.Method;
 
+import org.apache.wicket.util.string.Strings;
+import org.orienteer.core.dao.DAOField;
 import org.orienteer.core.dao.IMethodHandler;
 import org.orienteer.core.util.CommonUtils;
 
@@ -19,6 +21,8 @@ public ResultHolder handle(ODocumentWrapper target, Object proxy, Method method,
 			String methodName = method.getName();
 			if(methodName.startsWith("get")) name = CommonUtils.decapitalize(methodName.substring(3));
 			if(methodName.startsWith("is")) name = CommonUtils.decapitalize(methodName.substring(2));
+			DAOField fieldAnnotation = method.getAnnotation(DAOField.class);
+			if(fieldAnnotation!=null && !Strings.isEmpty(fieldAnnotation.value())) name = fieldAnnotation.value();
 			if(name!=null) {
 				Object value = target.getDocument().field(name, method.getReturnType());
 				return new ResultHolder(prepareForJava(value, method));

diff --git a/orienteer-core/src/main/java/org/orienteer/core/dao/handler/ODocumentSetHandler.java b/orienteer-core/src/main/java/org/orienteer/core/dao/handler/ODocumentSetHandler.java
@@ -2,8 +2,9 @@
 
 import java.lang.reflect.Method;
 
+import org.apache.wicket.util.string.Strings;
+import org.orienteer.core.dao.DAOField;
 import org.orienteer.core.dao.IMethodHandler;
-import org.orienteer.core.dao.IMethodHandler.ResultHolder;
 import org.orienteer.core.util.CommonUtils;
 
 import com.orientechnologies.orient.core.type.ODocumentWrapper;
@@ -16,7 +17,10 @@ public class ODocumentSetHandler extends AbstractMethodHandler<ODocumentWrapper>
 	@Override
 	public ResultHolder handle(ODocumentWrapper target, Object proxy, Method method, Object[] args) throws Throwable {
 		if (method.getName().startsWith("set") && args.length==1) {
-			target.getDocument().field(CommonUtils.decapitalize(method.getName().substring(3)), args[0]);
+			String name=CommonUtils.decapitalize(method.getName().substring(3));
+			DAOField fieldAnnotation = method.getAnnotation(DAOField.class);
+			if(fieldAnnotation!=null && !Strings.isEmpty(fieldAnnotation.value())) name = fieldAnnotation.value();
+			target.getDocument().field(name, args[0]);
 			return returnChained(proxy, method);
 		}
 		return null;

diff --git a/orienteer-core/src/test/java/org/orienteer/core/dao/GuiceTest.java b/orienteer-core/src/test/java/org/orienteer/core/dao/GuiceTest.java
@@ -27,6 +27,7 @@ public void testInjection() {
 		for (ODocument oDocument : perspectives) {
 			iOPerspective.fromStream(oDocument);
 			assertEquals(oDocument.field("alias"), iOPerspective.getAlias());
+			assertEquals(oDocument.field("alias"), iOPerspective.getAliasSynonymMethod());
 			assertEquals("test"+oDocument.field("alias"), iOPerspective.getTestAlias());
 			assertEquals("test2"+oDocument.field("alias"), iOPerspective.getTest2Alias());
 			assertEquals("test3test"+oDocument.field("alias"), iOPerspective.getTest3Alias());

diff --git a/orienteer-core/src/test/java/org/orienteer/core/dao/IOPerspective.java b/orienteer-core/src/test/java/org/orienteer/core/dao/IOPerspective.java
@@ -11,6 +11,9 @@ public interface IOPerspective extends IODocumentWrapper {
 	public String getAlias();
 	public Map<String, Object> getName();
 
+	@DAOField("alias")
+	public String getAliasSynonymMethod();
+
 	default public String getTestAlias() {
 		return "test"+getAlias();
 	}