Ticket #2383: templatespersistence.patch

modules/org.sophie2.base.model.resources.r4/src/main/java/org/sophie2/base/model/resources/r4/keys/Key.java

@@ -1 +1 @@
 package org.sophie2.base.model.resources.r4.keys;
 
 import java.io.IOException;
+import java.util.Collections;
+import java.util.List;
 import java.util.regex.Pattern;
 
 import org.sophie2.base.commons.util.ImmList;
@@ -257 +259 @@
          */
         public abstract void persistR3(ValueRef<T> ref, Storage destination, PersistenceOptions options, String format) throws IOException;
         
+        /**
+         * Gets a list of sub-keys that should be persisted along with this one.
+         * @return
+         *              A list of sub-keys.
+         */
+        public List<Key<?>> getSubkeys () {
+                return Collections.<Key<?>>emptyList();
+        }
+        
 }

modules/org.sophie2.base.model.resources.r4/src/main/java/org/sophie2/base/model/resources/r4/keys/SimpleSubKey.java

@@ +1 @@
+package org.sophie2.base.model.resources.r4.keys;
+
+import java.io.IOException;
+
+import org.sophie2.base.commons.util.ImmList;
+import org.sophie2.base.persistence.commons.PersistenceOptions;
+import org.sophie2.base.persistence.ref.ValueRef;
+import org.sophie2.base.persistence.storage.Storage;
+
+/**
+ * A key type which is a sub-key of another key
+ * 
+ * @author boyanl
+ *
+ * @param <T>
+ */
+class SimpleSubKey<T> extends SimpleKey<T> {
+        
+        /**
+         * Default constructor.
+         * 
+         * @param id
+         *            The string representation of the key.
+         * @param valueClass
+         *            The type of the value this key holds.
+         * @param defValue
+         *            Default value for the new key.
+         */
+        public SimpleSubKey(String id, Class<T> valueClass, T defValue) {
+                super(id, valueClass, defValue);
+        }
+
+        /**
+         * Constructor with given parts as {@link ImmList}.
+         * 
+         * @param parts
+         *            The parts to construct the Id from.
+         * @param valueClass
+         *            The type of the value this key holds.
+         * @param defValue
+         *            Default value for the new key.
+         */
+        SimpleSubKey(ImmList<String> parts, Class<T> valueClass, T defValue) {
+                super(parts, valueClass, defValue);
+        }
+        
+        /**
+         * Persist the key in a way so that we'll avoid collisions with same keys but in
+         * different parents.
+         */
+        @Override
+        public void persistR3(ValueRef<T> ref, Storage destination,
+                        PersistenceOptions options, String format) throws IOException {
+                ImmList<String> parts = this.getParts ();
+                
+                parts = parts.remove(parts.size() - 1);
+                
+                Storage finalDest = destination;
+                for (String str : parts) {
+                        Storage child = (options.isLoadMode() ? finalDest.getChild(str) : finalDest.child(str));
+                        if (options.isLoadMode() && child == null) {
+                                ref.set(null);
+                                return;
+                        }
+                        finalDest = child;
+                }
+                
+                super.persistR3(ref, finalDest, options, format);
+        }
+}
+ No newline at end of file

modules/org.sophie2.base.model.resources.r4/src/main/java/org/sophie2/base/model/resources/r4/keys/TemplatedKey.java

@@ -1 +1 @@
 package org.sophie2.base.model.resources.r4.keys;
 
+import java.util.LinkedList;
+import java.util.List;
+
 import org.sophie2.base.commons.util.ImmList;
 import org.sophie2.base.model.resources.r4.ResourceRefR4;
 import org.sophie2.base.model.resources.r4.access.ResourceAccess;
@@ -29 +32 @@
         
         // This initialization is done after super initialization.
         private final SimpleKey<Boolean> KEY_LOCKED = 
-                new SimpleKey<Boolean>(getId() + LOCKED_SUFFIX,
+                new SimpleSubKey<Boolean>(getId() + LOCKED_SUFFIX,
                         Boolean.class, false);
+        
         private final SimpleKey<Boolean> KEY_APPLY = 
-                new SimpleKey<Boolean>(getId() + APPLY_SUFFIX,
+                new SimpleSubKey<Boolean>(getId() + APPLY_SUFFIX,
                         Boolean.class, true);
         /**
          * Default constructor.
@@ -127 +131 @@
                                 .getValueClass(), this.getDefault());
         }
         
+        @Override
+        public List<Key<?>> getSubkeys () {
+                List<Key<?>> result = new LinkedList<Key<?>>(); 
+                result.add(this.KEY_APPLY);
+                result.add(this.KEY_LOCKED);
+                
+                return result;
+        }
+                
         /**
          * The possible modes for a {@link TemplatedKey}.
          */

modules/org.sophie2.base.model.resources.r4/src/main/java/org/sophie2/base/model/resources/r4/ResourceInfoProvider.java

@@ -197 +197 @@
                         try {
                                 if (field.getName().startsWith("KEY_")) {
                                         res.put(field.getName(), new KeyEntry(field));
+                                        
+                                        Key<?> key = (Key<?>) field.get(null);
+                                        for (Key<?> subKey :  key.getSubkeys()) {
+                                                res.put(subKey.getId(), new KeyEntry(subKey, field));
+                                        }
                                 }
                         } catch (IllegalAccessException e) {
                                 throw new RuntimeException("Cannot access a KEY field ("