svn commit: r1296298 - /jackrabbit/sandbox/microkernel/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java

[st...@apache.org]

Author: stefan
Date: Fri Mar  2 16:41:07 2012
New Revision: 1296298

URL: http://svn.apache.org/viewvc?rev=1296298&view=rev
Log:
javadoc cleanup

Modified:
    jackrabbit/sandbox/microkernel/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java

Modified: jackrabbit/sandbox/microkernel/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java
URL: http://svn.apache.org/viewvc/jackrabbit/sandbox/microkernel/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java?rev=1296298&r1=1296297&r2=1296298&view=diff
==============================================================================
--- jackrabbit/sandbox/microkernel/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java (original)
+++ jackrabbit/sandbox/microkernel/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java Fri Mar  2 16:41:07 2012
@@ -26,7 +26,6 @@ import java.io.InputStream;
  * <li>GIT/SVN-inspired DAG-based data model</li>
  * <li>highly scalable concurrent read & write operations</li>
  * <li>stateless API</li>
- * <li>predefined timeout (e.g. 50ms) for reading methods</li>
  * <li>portable to C</li>
  * <li>efficient support for large number of child nodes</li>
  * <li>integrated API for storing/retrieving large binaries (similar to existing DataStore API)</li>
@@ -37,9 +36,8 @@ import java.io.InputStream;
  * <ul>
  * <li>simple JSON-inspired data model: just nodes and properties</li>
  * <li>a node is represented as an object, consisting of an unordered collection
- * of properties and an array of (child) node objects</li>
+ * of properties and an ordered mapping of names/child nodes</li>
  * <li>properties are represented as name/value pairs</li>
- * <li>MVPs are represented as name/array-of-values pairs</li>
  * <li>supported property types: string, number</li>
  * <li>other property types (weak/hard reference, date, etc) would need to be
  * encoded/mangled in name or value</li>
@@ -55,40 +53,14 @@ import java.io.InputStream;
  * <li><i>MicroKernel</i></li>
  * </ol>
  * <p/>
- * <b>TBD</b>:
- * <ul>
- * <li>The concept of JCR workspaces is decorated by the SPI layer as top-level nodes
- * in the MicroKernel (e.g. /default. /system); there's no need for
- * inter-workspace operations, allows simplified versioning implementation</li>
- * <li>should the MicroKernel support (polling) observation?
- * => <code>getRevisions/getJournal</code> should be sufficient</li>
- * <li>nodes are primarily accessed by path. node identifiers (nodeId) are
- * optional. if a new node is committed with a special marker property
- * (e.g. <code>":id" : null</code>), a system-generated unique identifier will be
- * assigned and exposed through the same <code>:id</code> property;
- * the MicroKernel maintains an id<->path index</li>
- * <li>should the API provide methods for looking up id/path mappings
- * (<code>getId/getPath</code>) or should every node with an assigned
- * id expose a <code>:path</code> property (in addition to <code>:id</code>)?</li>
- * <li><code>jcr:uuid</code> is decorated by the SPI on top of MicroKernel;
- * <code>jcr:uuid</code> is equivalent to the MicroKernel node identifier (<code>:id</code>)</li>
- * <li>should the MicroKernel provide built-in support for shareable nodes?
- * => no (tentative)</li>
- * </ul>
  * <p/>
  * <b>JSON/JSOP</b>:
  * <ul>
  * <li>do we need to specify a 'reorder' op in jsop? perhaps based on 'move'?
  * => check full JSOP spec and davex</li>
- * <li>do we need to specify a 'copy' op in jsop?
- * => check full JSOP spec and davex</li>
- * <li>how should an incomplete list of child nodes be represented in json?
- * => length(array) != :childNodeCount</li>
  * <li>consider YAML as an alternative to the JSON representation =>
  * supports ordered sequence of name:value pairs, richer set of data/collection types</li>
  * </ul>
- *
- * @todo check DavEx protocol for potential overlap/input (e.g. JSON format)
  */
 public interface MicroKernel {