Changeset 90 for java/main/src/main/java/com/framsticks/params/ParamCandidate.java

Timestamp:

07/02/13 16:20:07 (11 years ago)

Author:

psniegowski

Message:

HIGHLIGHTS:

• add ObjectInstance? for holding local object trees
• fix params ordering issue in automically created FramsClasses?
• support for automated Builders in XmlLoader?
• fix bug preventing multiple GUI tests in single test run
• implement Groups in FramsClass?
• improve ProcedureParam?:
  • calling in ObjectInstance?
  • support in GUI

CHANGELOG:
Make ProcedureParam? hold only ValueParams?.

Use id instead of names when naming gui components internally.

Basic procedure calling in GUI.

The actual procedure call is currently only backed
by the ObjectInstance?.

Add UnimplementedException?.

Improve naming of various gui elements.

Allow easy navigating in FEST Swing testing.

Add optional explicit order attribute to FramsClassAnnotation?.

That's because java reflection does return declared members
in any specific order. That ordering is needed only for
classes that have no representation in framsticks and need
a deterministic ordering of params.

Add ControlOwner? interface.

Add test for procedure calling in Browser.

First version of ParamAnnotation? for procedures.

Development of ProcedureParam?.

Add draft version of ProcedureParam? implementation in ReflectionAccess?.

Allow viewing FramsClasses? in gui Browser.

Extract ResourceBuilder? from ModelBuilder?.

Remove internalId from Param.

It was currently completely not utilised. Whether it is still needed
after introduction of ParamAnnotation? is arguable.

Add remaining param attributes to ParamAnnotation?.

Change AutoBuilder? semantics.

AutoBuilder? returns list of objects that are to be appended
with methods @AutoAppendAnnotation?.

This allows to omit explicit addition of ModelPackage? to instance
if the instance uses ModelBuilder? (registration of ModelPackage? comes
from schema).

Fix params ordering problem in auto created FramsClasses?.

Improve ObjectInstance?.

Several fixes to ModelBuilder?.

Improve test for ObjectInstance? in Browser.

Make initialization of robot static.

With robot recreated for second browser test, the test hanged
deep in AWT.

Add base convenience base test for Browser tests.

More tests to ObjectInstance?.

Rename Dispatcher.invokeLater() to dispatch().

Add assertDispatch.

It allows assertions in other threads, than TestNGInvoker.
Assertions are gathered after each method invocation and rethrown.

Use timeOut annotation attribute for tests involving some waiting.

Remove firstTask method (merge with joinableStart).

Clean up leftovers.

Remove unused FavouritesXMLFactory (the reading part is already
completely done with generic XmlLoader?, and writing part will be done
based on the same approach if needed).
Move UserFavourite? to the com.framsticks.gui.configuration package.

Remove GenotypeBrowser? as to specific.

This functionality will be available in ObjectInstance?.

Add interface ParamsPackage?.

Package containing registration of Java classes meant to use with
ReflectionAccess? may be in Instance using configuration.

Minor changes.

Make Group immutable.

Add AutoBuilder? interface extending Builder - only those would
be used to automatically build from XML.

Fix groups in FramsClass?.

Minor naming cleanup in Registry.

Add ModelComponent? interface.

All class creating the Model are implementing that interface.

Extract Model.build into ModelBuilder?.

ModelBuilder? will be compatible with other builders
and allow using it from configuration.

Fix NeuroConnection?.

Add synchronous get operation for dispatchers.

Rename JoinableMonitor? to Monitor.

Add ObjectInstance?.

This class is mainly for demonstration
and testing purposes.

Improve FramsServer? runner.

• improve ExternalProcess? runner,
• runner can kill the server but also react properly, when the server exists on it's own,
• set default path to search for framsticks server installation,
• add LoggingOutputListener?.

File:

• java/main/src/main/java/com/framsticks/params/ParamCandidate.java (modified) (9 diffs)

java/main/src/main/java/com/framsticks/params/ParamCandidate.java

@@ -10 +10 @@
 import java.lang.reflect.ParameterizedType;
 import java.lang.reflect.Type;
+import java.util.Arrays;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.Comparator;
 import java.util.HashMap;
+import java.util.LinkedList;
+import java.util.List;
 import java.util.Map;
 
+import com.framsticks.params.annotations.FramsClassAnnotation;
 import com.framsticks.params.annotations.ParamAnnotation;
+import com.framsticks.params.types.ProcedureParam;
 
 public class ParamCandidate {
@@ -65 +72 @@
         protected final OneTime<Method> setter = new OneTime<>("setter");
         protected final OneTime<Method> getter = new OneTime<>("getter");
+        protected final OneTime<Method> caller = new OneTime<>("caller");
+
+        protected final List<ParamAnnotation> annotations = new LinkedList<>();
 
         /**
@@ -124 +134 @@
         }
 
+        /**
+         * @return the getter
+         */
+        public Method getCaller() {
+                return caller.get();
+        }
+
+        /**
+         * @return the annotations
+         */
+        public List<ParamAnnotation> getAnnotations() {
+                return Collections.unmodifiableList(annotations);
+        }
+
         void validate() throws ConstructionException {
                 try {
+                        if (caller.has()) {
+                                if (!isPublic(caller)) {
+                                        throw new ConstructionException().msg("method is not public");
+                                }
+                                if (getter.has() || setter.has()) {
+                                        throw new ConstructionException().msg("getter or setter coexist with caller");
+                                }
+                                return;
+                        }
                         if (isPublic(field)) {
                                 if (getter.has()) {
@@ -147 +180 @@
 
         boolean isFinal() {
+                if (caller.has()) {
+                        return false;
+                }
                 if (Collection.class.isAssignableFrom(getRawType())) {
                         return false;
@@ -160 +196 @@
 
         boolean isReadOnly() {
+                if (caller.has()) {
+                        return false;
+                }
                 if (Collection.class.isAssignableFrom(getRawType())) {
                         return false;
@@ -172 +211 @@
         }
 
-        void add(Member member, String name) {
+        void add(ParamAnnotation paramAnnotation, Member member, String name) {
                 this.name.set(name);
+                annotations.add(paramAnnotation);
                 if (member instanceof Field) {
-                        this.field.set((Field) member);
+                        field.set((Field) member);
                         setType(field.get().getGenericType());
                         return;
@@ -181 +221 @@
                 if (member instanceof Method) {
                         Method m = (Method) member;
+                        if (!paramAnnotation.paramType().equals(Param.class)) {
+                                if (paramAnnotation.paramType().equals(ProcedureParam.class)) {
+                                        caller.set(m);
+                                        return;
+                                }
+                                throw new ConstructionException().msg("explicit set of paramType different than ProcedureParam is not yet supported").arg("name", name).arg("method", m).arg("in", this);
+                        }
                         Type[] ps = m.getGenericParameterTypes();
                         if (ps.length == 0) {
@@ -222 +269 @@
         }
 
-        public static <M extends Member & AnnotatedElement> void filterParamsCandidates(Map<String, ParamCandidate> params, M[] members) {
+        public static <M extends Member & AnnotatedElement> void filterParamsCandidates(Set set, M[] members) {
                 for (M m : members) {
                         ParamAnnotation pa = m.getAnnotation(ParamAnnotation.class);
@@ -228 +275 @@
                                 continue;
                         }
-                        // if (!isPublic(m)) {
-                        //      throw new ConstructionException().msg("field is not public").arg("field", m);
-                        // }
                         String id = FramsClassBuilder.getId(pa, m);
                         ParamCandidate pc = null;
-                        if (params.containsKey(id)) {
-                                pc = params.get(id);
+                        if (set.getCandidates().containsKey(id)) {
+                                pc = set.getCandidates().get(id);
                         } else {
                                 pc = new ParamCandidate(id);
-                                params.put(id, pc);
-                        }
-                        pc.add(m, FramsClassBuilder.getName(pa, m));
-
-                }
-        }
-
-        public static Map<String, ParamCandidate> getAllCandidates(Class<?> javaClass) throws ConstructionException {
-                Map<String, ParamCandidate> candidates = new HashMap<>();
-
+                                set.getCandidates().put(id, pc);
+                                set.getOrder().add(pc);
+                        }
+                        pc.add(pa, m, FramsClassBuilder.getName(pa, m));
+                }
+        }
+
+        public static class Set {
+                protected final Map<String, ParamCandidate> candidates;
+                protected final List<ParamCandidate> order;
+
+                /**
+                 * @param candidates
+                 * @param order
+                 */
+                public Set(Map<String, ParamCandidate> candidates, List<ParamCandidate> order) {
+                        this.candidates = candidates;
+                        this.order = order;
+                }
+
+                /**
+                 * @return the candidates
+                 */
+                public Map<String, ParamCandidate> getCandidates() {
+                        return candidates;
+                }
+
+                /**
+                 * @return the order
+                 */
+                public List<ParamCandidate> getOrder() {
+                        return order;
+                }
+        }
+
+        public static Set getAllCandidates(Class<?> javaClass) throws ConstructionException {
+
+                List<Class<?>> javaClasses = new LinkedList<>();
                 while (javaClass != null) {
-                        filterParamsCandidates(candidates, javaClass.getDeclaredFields());
-                        filterParamsCandidates(candidates, javaClass.getDeclaredMethods());
-
+                        javaClasses.add(0, javaClass);
                         javaClass = javaClass.getSuperclass();
                 }
 
-                for (ParamCandidate pc : candidates.values()) {
+                Set resultSet = new Set(new HashMap<String, ParamCandidate>(), new LinkedList<ParamCandidate>());
+
+                for (Class<?> j : javaClasses) {
+                        Set set = new Set(resultSet.getCandidates(), new LinkedList<ParamCandidate>());
+                        filterParamsCandidates(set, j.getDeclaredFields());
+                        filterParamsCandidates(set, j.getDeclaredMethods());
+
+                        FramsClassAnnotation fa = j.getAnnotation(FramsClassAnnotation.class);
+                        if (fa != null) {
+                                final List<String> order = Arrays.asList(fa.order());
+                                Collections.sort(set.getOrder(), new Comparator<ParamCandidate>() {
+                                        @Override
+                                        public int compare(ParamCandidate pc0, ParamCandidate pc1) {
+                                                int u0 = order.indexOf(pc0.getId());
+                                                int u1 = order.indexOf(pc1.getId());
+                                                if (u0 == -1 || u1 == -1) {
+                                                        return 0;
+                                                }
+                                                return u0 - u1;
+                                        }
+                                });
+                        }
+                        resultSet.getOrder().addAll(0, set.getOrder());
+                }
+
+                for (ParamCandidate pc : resultSet.getOrder()) {
                         pc.validate();
                 }
 
-                return candidates;
+                return resultSet;
         }
 
         public static Class<?> getRawClass(final Type type) {
+                if (type == null) {
+                        throw new IllegalArgumentException();
+                }
                 if (Class.class.isInstance(type)) {
                         return Class.class.cast(type);