Changeset 1234 for MDService2/trunk/MDService2/src/eu/clarin/cmdi/mdservice/action/Cache.java

Timestamp:

04/22/11 20:11:04 (13 years ago)

Author:

vronk

Message:

changes in recordset display, query_detail; adding documenting

File:

• MDService2/trunk/MDService2/src/eu/clarin/cmdi/mdservice/action/Cache.java (modified) (2 diffs)

MDService2/trunk/MDService2/src/eu/clarin/cmdi/mdservice/action/Cache.java

@@ -39 +39 @@
  * This is a rudimentary caching mechanism.
  * serializes the inputstream to a file (identifier => filename)
- * and returns the inpustream based on the identifier
+ * and returns the inpustream based on the identifier.
+ * 
+ * It maintains the cache_index (persisted as xml-file in the cache-folder)
+ * mapping the request parameters to the indexed files.
+ * 
+ * This is an internal object, direct user access to cache-data via interface is only possible via <code>AdminAction</code>
  * @author master
  *
@@ -95 +100 @@
         
         /**
-         * here the external key for the data gets cache-internal counter-id assigned
-         * which is also returned back
-         * can be used (as shorthand instead of the (long) external key) from outside to retrieve the data.
-         * This is primarily meant to be able to reuse the recordset-data, when reading one record.  
-         * @param id
-         * @param instream
+         * Here the external key for the data gets cache-internal counter-id assigned
+         * which is also returned back.
+         * 
+         * The external key gets parsed and put as individual attributes in the <f>-element:
+         * 
+         * <code>
+         * <f collection="" date="2011-04-20 01:06:50" duration="0.227" id="3" lang="en"
+     *   maxDepth="1"
+     *   maximumItems=""
+     *   query=""
+     *   repository="localhost-mirror"
+     *   squery=""
+     *   startItem=""
+     *   type="collections"/>
+      </code>
+         *  
+         * 
+         * @param key_info a complex string carrying all relevant parameters
+         * @param instream data to be stored
          * @return
          */