bundles/org.simantics.objmap2/src/org/simantics/objmap/graph/schema/MappingSchemas.java

   1 /*******************************************************************************\r
   2  * Copyright (c) 2012, 2013 Association for Decentralized Information Management in\r
   3  * Industry THTH ry.\r
   4  * All rights reserved. This program and the accompanying materials\r
   5  * are made available under the terms of the Eclipse Public License v1.0\r
   6  * which accompanies this distribution, and is available at\r
   7  * http://www.eclipse.org/legal/epl-v10.html\r
   8  *\r
   9  * Contributors:\r
  10  *     VTT Technical Research Centre of Finland - initial API and implementation\r
  11  *******************************************************************************/\r
  12 package org.simantics.objmap.graph.schema;\r
  13 \r
  14 import java.lang.annotation.Annotation;\r
  15 import java.lang.reflect.Field;\r
  16 import java.lang.reflect.Method;\r
  17 import java.util.ArrayList;\r
  18 import java.util.Collection;\r
  19 \r
  20 import org.simantics.db.ReadGraph;\r
  21 import org.simantics.db.Resource;\r
  22 import org.simantics.db.exception.DatabaseException;\r
  23 import org.simantics.objmap.bidirectional.IBidirectionalMappingRule;\r
  24 import org.simantics.objmap.graph.annotations.CompoundRelatedGetValue;\r
  25 import org.simantics.objmap.graph.annotations.DynamicGraphType;\r
  26 import org.simantics.objmap.graph.annotations.GraphType;\r
  27 import org.simantics.objmap.graph.annotations.HasCollectionAdder;\r
  28 import org.simantics.objmap.graph.annotations.HasCollectionRemover;\r
  29 import org.simantics.objmap.graph.annotations.HasSetter;\r
  30 import org.simantics.objmap.graph.annotations.OptionalRelatedElements;\r
  31 import org.simantics.objmap.graph.annotations.OrderedElementsGet;\r
  32 import org.simantics.objmap.graph.annotations.OrderedSetType;\r
  33 import org.simantics.objmap.graph.annotations.RelatedElements;\r
  34 import org.simantics.objmap.graph.annotations.RelatedElementsGet;\r
  35 import org.simantics.objmap.graph.annotations.RelatedGetObj;\r
  36 import org.simantics.objmap.graph.annotations.RelatedGetValue;\r
  37 import org.simantics.objmap.graph.annotations.RelatedOrderedSetElements;\r
  38 import org.simantics.objmap.graph.annotations.RelatedValue;\r
  39 import org.simantics.objmap.graph.annotations.UpdateMethod;\r
  40 import org.simantics.objmap.graph.annotations.factories.CompoundRelatedGetSetValueRuleFactory;\r
  41 import org.simantics.objmap.graph.annotations.factories.OptionalRelatedElementsRuleFactory;\r
  42 import org.simantics.objmap.graph.annotations.factories.OrderedElementsRuleFactory;\r
  43 import org.simantics.objmap.graph.annotations.factories.RelatedElementsRuleFactory;\r
  44 import org.simantics.objmap.graph.annotations.factories.RelatedElementsRuleFactory2;\r
  45 import org.simantics.objmap.graph.annotations.factories.RelatedGetSetObjRuleFactory;\r
  46 import org.simantics.objmap.graph.annotations.factories.RelatedGetSetValueRuleFactory;\r
  47 import org.simantics.objmap.graph.annotations.factories.RelatedOrderedSetElementsRuleFactory;\r
  48 import org.simantics.objmap.graph.annotations.factories.RelatedValueRuleFactory;\r
  49 import org.simantics.objmap.graph.annotations.factories.UpdateMethodFactory;\r
  50 import org.simantics.objmap.graph.annotations.meta.IsClassRule;\r
  51 import org.simantics.objmap.graph.annotations.meta.IsCollectionRule;\r
  52 import org.simantics.objmap.graph.annotations.meta.IsFieldRule;\r
  53 import org.simantics.objmap.graph.annotations.meta.IsGetSetRule;\r
  54 import org.simantics.objmap.graph.annotations.meta.IsMethodRule;\r
  55 import org.simantics.objmap.graph.rules.factory.IClassRuleFactory;\r
  56 import org.simantics.objmap.graph.rules.factory.ICollectionRuleFactory;\r
  57 import org.simantics.objmap.graph.rules.factory.IFieldRuleFactory;\r
  58 import org.simantics.objmap.graph.rules.factory.IGetSetRuleFactory;\r
  59 import org.simantics.objmap.graph.rules.factory.IMethodRuleFactory;\r
  60 \r
  61 \r
  62 public class MappingSchemas {\r
  63         /**\r
  64      * Creates a new SimpleLinkType based on the annotations in the given class.\r
  65      * @throws IllegalAccessException \r
  66      * @throws InstantiationException \r
  67      * @see GraphType\r
  68      * @see RelatedValue\r
  69      */\r
  70         public static SimpleLinkType<Object> fromAnnotations(ReadGraph g, Class<?> clazz) throws DatabaseException, InstantiationException, IllegalAccessException {\r
  71             GraphType graphType = clazz.getAnnotation(GraphType.class);\r
  72             \r
  73             if (graphType != null) {\r
  74                     ArrayList<IBidirectionalMappingRule<Resource, Object>> rules = new ArrayList<IBidirectionalMappingRule<Resource, Object>>();\r
  75                     collectRulesFromAnnotations(g, clazz, rules);\r
  76                     \r
  77                     return new SimpleLinkType<Object>(g.getResource(graphType.value()), clazz, rules);  \r
  78             }\r
  79             DynamicGraphType dynamicType = clazz.getAnnotation(DynamicGraphType.class);\r
  80             if (dynamicType != null) {\r
  81                 ArrayList<IBidirectionalMappingRule<Resource, Object>> rules = new ArrayList<IBidirectionalMappingRule<Resource, Object>>();\r
  82                     collectRulesFromAnnotations(g, clazz, rules);\r
  83                     \r
  84                     return new DynamicSimpleLinkType<Object>(g.getResource(dynamicType.value()), clazz, rules);\r
  85             }\r
  86             OrderedSetType orderedSetType = clazz.getAnnotation(OrderedSetType.class);\r
  87             if (orderedSetType != null) {\r
  88                 ArrayList<IBidirectionalMappingRule<Resource, Object>> rules = new ArrayList<IBidirectionalMappingRule<Resource, Object>>();\r
  89                     collectRulesFromAnnotations(g, clazz, rules);\r
  90                     \r
  91                     return new OrderedSetSimpleLinkType<Object>(g.getResource(orderedSetType.value()), clazz, rules);\r
  92             }\r
  93             throw new IllegalArgumentException("Class " + clazz.toString() + " does not contain annotations.");\r
  94         }\r
  95         \r
  96         public static void collectRulesFromAnnotations(ReadGraph g, Class<?> clazz, Collection<IBidirectionalMappingRule<Resource, Object>> rules) throws DatabaseException, InstantiationException, IllegalAccessException {\r
  97             Class<?> superclass = clazz.getSuperclass();\r
  98             if(superclass != null)\r
  99                 collectRulesFromAnnotations(g, superclass, rules);\r
 100                 \r
 101         for(Annotation annotation : clazz.getAnnotations()) {\r
 102 \r
 103                 IsClassRule tag = annotation.annotationType().getAnnotation(IsClassRule.class);\r
 104             if(tag!= null) {\r
 105                 rules.add(createClassRule(g, annotation, clazz).create(g, annotation, clazz));\r
 106             }\r
 107         }\r
 108 \r
 109         for(Field f : clazz.getDeclaredFields()) {\r
 110             f.setAccessible(true);\r
 111 \r
 112             for(Annotation annotation : f.getAnnotations()) {\r
 113 \r
 114                 IsFieldRule tag = annotation.annotationType().getAnnotation(IsFieldRule.class);\r
 115                 if(tag != null) {\r
 116                     rules.add(createFieldRule(g, annotation, f).create(g, annotation, f));\r
 117                 }\r
 118             }\r
 119         }\r
 120 \r
 121         for(Method m : clazz.getDeclaredMethods()) {\r
 122             m.setAccessible(true);\r
 123 \r
 124             for(Annotation annotation : m.getAnnotations()) {\r
 125                 IsMethodRule tag = \r
 126                         annotation.annotationType().getAnnotation(IsMethodRule.class);\r
 127                 if(tag != null) {\r
 128                         rules.add(createMethodRule(g, annotation, m).create(g, annotation, m));\r
 129                 }\r
 130             }\r
 131         }\r
 132         \r
 133         for (Method m : clazz.getDeclaredMethods()) {\r
 134                 m.setAccessible(true);\r
 135                 for (Annotation annotation : m.getAnnotations()) {\r
 136                         Class<? extends Annotation> annotationType = annotation.annotationType();\r
 137 \r
 138                          IsGetSetRule tag = \r
 139                          annotationType.getAnnotation(IsGetSetRule.class);\r
 140                          if (tag != null) {\r
 141                                  \r
 142                                  HasSetter setterAnnType = annotationType.getAnnotation(HasSetter.class);\r
 143                                  \r
 144                                  Class<? extends Annotation> setterAnn = setterAnnType.value();\r
 145                                  \r
 146                                  Method getter = m;\r
 147                                  \r
 148                                  IGetSetRuleFactory<Resource,Object> ruleFactory = createGetSetRuleFactory(g, annotation, getter);\r
 149                                  \r
 150                                  \r
 151                                  Method setter = null;\r
 152                                  \r
 153                                  for (Method m2 : clazz.getDeclaredMethods()) {\r
 154                                          Annotation set = m2.getAnnotation(setterAnn);\r
 155                                          if (set != null && ruleFactory.isSetter(annotation, set))\r
 156                                                  setter = m2;\r
 157                                  }\r
 158 \r
 159                                  rules.add(ruleFactory.create(g, annotation, getter, setter));\r
 160                          }\r
 161                 \r
 162                 }\r
 163         }\r
 164         \r
 165         for (Method m : clazz.getDeclaredMethods()) {\r
 166                 m.setAccessible(true);\r
 167                 for (Annotation annotation : m.getAnnotations()) {\r
 168                         Class<? extends Annotation> annotationType = annotation.annotationType();\r
 169 \r
 170                          IsCollectionRule tag = \r
 171                          annotationType.getAnnotation(IsCollectionRule.class);\r
 172                          if (tag != null) {\r
 173                                  \r
 174                                  HasCollectionAdder adderAnnType = annotationType.getAnnotation(HasCollectionAdder.class);\r
 175                                  HasCollectionRemover removerAnnType = annotationType.getAnnotation(HasCollectionRemover.class);\r
 176                 \r
 177                                  Class<? extends Annotation> adderAnn = adderAnnType.value();\r
 178                                  Class<? extends Annotation> removerAnn = removerAnnType.value();\r
 179                                  \r
 180                                  Method getter = m;\r
 181                                  \r
 182                                  ICollectionRuleFactory<Resource,Object> ruleFactory = createCollectionRuleFactory(g, annotation, getter);\r
 183                                  \r
 184                                  \r
 185                                  Method adder = null;\r
 186                                  Method remover = null;\r
 187                                  \r
 188                                  for (Method m2 : clazz.getDeclaredMethods()) {\r
 189                                          Annotation add = m2.getAnnotation(adderAnn);\r
 190                                          Annotation rem = m2.getAnnotation(removerAnn);\r
 191                                          if (add != null && ruleFactory.isAdder(annotation, add))\r
 192                                                  adder = m2;\r
 193                                          if (rem != null && ruleFactory.isRemover(annotation, rem))\r
 194                                                  remover = m2;\r
 195                                  }\r
 196                                  \r
 197                                  \r
 198                                  \r
 199                                  rules.add(ruleFactory.create(g, annotation, getter,adder,remover));\r
 200                          }\r
 201                 \r
 202                 }\r
 203         }\r
 204     }\r
 205         \r
 206         public static IClassRuleFactory<Resource, Object> createClassRule(ReadGraph g, Annotation annotation, Class<?> clazz) {\r
 207                 return null;\r
 208         }\r
 209         \r
 210         public static IFieldRuleFactory<Resource,Object> createFieldRule(ReadGraph g, Annotation annotation, Field field) {\r
 211                 if (annotation.annotationType().equals(RelatedElements.class))\r
 212                         return new RelatedElementsRuleFactory<Object>();\r
 213                 if (annotation.annotationType().equals(RelatedValue.class))\r
 214                         return new RelatedValueRuleFactory<Object>();\r
 215                 if (annotation.annotationType().equals(OptionalRelatedElements.class))\r
 216                         return new OptionalRelatedElementsRuleFactory<Object>();\r
 217                 if (annotation.annotationType().equals(RelatedOrderedSetElements.class))\r
 218                         return new RelatedOrderedSetElementsRuleFactory<Object>();\r
 219                 return null;\r
 220         }\r
 221         \r
 222         public static IMethodRuleFactory<Resource, Object> createMethodRule(ReadGraph g, Annotation annotation, Method m) {\r
 223                 if (annotation.annotationType().equals(UpdateMethod.class))\r
 224                         return new UpdateMethodFactory<Resource,Object>();\r
 225                 return null;\r
 226         }\r
 227         \r
 228         public static IGetSetRuleFactory<Resource,Object> createGetSetRuleFactory(ReadGraph g, Annotation annotation, Method getter) {\r
 229                 if (annotation.annotationType().equals(RelatedGetValue.class))\r
 230                         return new RelatedGetSetValueRuleFactory<Object>();\r
 231                 if (annotation.annotationType().equals(RelatedGetObj.class))\r
 232                         return new RelatedGetSetObjRuleFactory<Object>();\r
 233                 if (annotation.annotationType().equals(CompoundRelatedGetValue.class))\r
 234                         return new CompoundRelatedGetSetValueRuleFactory<Object>();\r
 235                 return null;\r
 236         }\r
 237         \r
 238         public static ICollectionRuleFactory<Resource,Object> createCollectionRuleFactory(ReadGraph g, Annotation annotation, Method getter) {\r
 239                 if (annotation.annotationType().equals(RelatedElementsGet.class))\r
 240                         return new RelatedElementsRuleFactory2<Object>();\r
 241                 if (annotation.annotationType().equals(OrderedElementsGet.class))\r
 242                         return new OrderedElementsRuleFactory<Object>();\r
 243                 return null;\r
 244         }\r
 245         \r
 246         /**\r
 247      * Creates a new SimpleLinkType based on the annotations in the given class.\r
 248      * @throws IllegalAccessException \r
 249      * @throws InstantiationException \r
 250      * @see GraphType\r
 251      * @see RelatedValue\r
 252      */\r
 253         \r
 254         public static AdaptedLinkType<Object> fromAdaptable(ReadGraph g, String type, Class<?> clazz) throws DatabaseException, InstantiationException, IllegalAccessException {\r
 255             \r
 256             \r
 257             return new AdaptedLinkType<Object>(g.getResource(type), clazz);    \r
 258         }\r
 259         \r
 260         \r
 261 }\r