From 8c2082a97b65daf57377548ac5c328f347977d1f Mon Sep 17 00:00:00 2001
From: Jukka Zitting <jukka@apache.org>
Date: Mon, 4 Nov 2013 13:40:01 -0500
Subject: [PATCH] OAK-1126: Same node and property name support

Adjust the MicroKernel contract to allow property and child node names to overlap
---
 .../org/apache/jackrabbit/mk/api/MicroKernel.java  | 44 ++++++++++++++--------
 1 file changed, 28 insertions(+), 16 deletions(-)

diff --git a/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java b/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java
index 306b1e3..3832a74 100644
--- a/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java
+++ b/oak-mk-api/src/main/java/org/apache/jackrabbit/mk/api/MicroKernel.java
@@ -40,9 +40,10 @@ import javax.annotation.Nonnull;
  * </p>
  * <ul>
  * <li>simple JSON-inspired data model: just nodes and properties</li>
- * <li>a node consists of an unordered set of name -&gt; item mappings. each
- * property and child node is uniquely named and a single name can only
- * refer to a property or a child node, not both at the same time.
+ * <li>A node consists of an unordered set of named properties. Nodes are
+ * organized in a tree hierarchy where each node is uniquely identified by
+ * its path. The names of properties can overlap with the names of child
+ * nodes (direct descendants in the tree hierarchy).
  * <li>properties are represented as name/value pairs</li>
  * <li>supported property types: string, number, boolean, array</li>
  * <li>a property value is stored and used as an opaque, unparsed character sequence</li>
@@ -280,8 +281,13 @@ public interface MicroKernel {
 
     /**
      * Returns the node tree rooted at the specified parent node with the
-     * specified depth, maximum child node maxChildNodes and offset. The depth of the
-     * returned tree is governed by the {@code depth} parameter:
+     * specified depth, maximum child node maxChildNodes and offset. Child
+     * nodes information is included within a ":children" object to avoid
+     * name conflicts with properties. If a node has no children, then the
+     * ":children" object can be omitted.
+     * <p>
+     * The depth of the returned tree is governed by the {@code depth}
+     * parameter:
      * <table>
      * <tr>
      * <td>depth = 0</td>
@@ -305,8 +311,10 @@ public interface MicroKernel {
      * {
      *   "someprop" : "someval",
      *   ":childNodeCount" : 2,
-     *   "child1" : {},
-     *   "child2" : {}
+     *   ":children": {
+     *     "child1" : {},
+     *     "child2" : {}
+     *   }
      * }
      * </pre>
      * Example (depth=1):
@@ -314,15 +322,19 @@ public interface MicroKernel {
      * {
      *   "someprop" : "someval",
      *   ":childNodeCount" : 2,
-     *   "child1" : {
-     *     "prop1" : 123,
-     *     ":childNodeCount" : 2,
-     *     "grandchild1" : {},
-     *     "grandchild2" : {}
-     *   },
-     *   "child2" : {
-     *     "prop1" : "bar",
-     *     ":childNodeCount" : 0
+     *   ":children": {
+     *     "child1" : {
+     *       "prop1" : 123,
+     *       ":childNodeCount" : 2,
+     *       ":children": {
+     *         "grandchild1" : {},
+     *         "grandchild2" : {}
+     *       }
+     *     },
+     *     "child2" : {
+     *       "prop1" : "bar",
+     *       ":childNodeCount" : 0
+     *     }
      *   }
      * }
      * </pre>
-- 
1.8.3.msysgit.0