From 15e8b0b5554925e28661dac145e471f50febd080 Mon Sep 17 00:00:00 2001
From: Vikas Saurabh <vsaurabh@adobe.com>
Date: Fri, 14 Aug 2015 10:29:09 +0530
Subject: [PATCH 1/2] OAK-3230 query engine should support virtual rows

---
 .../plugins/index/aggregate/AggregationCursor.java   | 20 ++++++++++++++------
 .../jackrabbit/oak/query/ast/SelectorImpl.java       |  9 ++++++++-
 .../jackrabbit/oak/query/index/IndexRowImpl.java     |  5 +++++
 .../apache/jackrabbit/oak/spi/query/IndexRow.java    |  7 +++++++
 .../apache/jackrabbit/oak/spi/query/CursorsTest.java |  4 ++++
 .../oak/plugins/index/lucene/LuceneIndex.java        |  4 ++++
 .../plugins/index/lucene/LucenePropertyIndex.java    |  4 ++++
 .../oak/plugins/index/solr/query/SolrQueryIndex.java |  4 ++++
 8 files changed, 50 insertions(+), 7 deletions(-)

diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/aggregate/AggregationCursor.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/aggregate/AggregationCursor.java
index 09611c9..efb4f79 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/aggregate/AggregationCursor.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/aggregate/AggregationCursor.java
@@ -87,12 +87,15 @@ class AggregationCursor extends AbstractCursor {
         }
         aggregates = null;
         if (cursor.hasNext()) {
-            currentRow = cursor.next();
-            String path = currentRow.getPath();
-            aggregates = Iterators.filter(Iterators.concat(
-                    Iterators.singletonIterator(path),
-                    aggregator.getParents(rootState, path)), Predicates
-                    .not(Predicates.in(seenPaths)));
+            IndexRow nextRow = cursor.next();
+            if (!currentRow.isVirtualRow()) {
+                currentRow = nextRow;
+                String path = currentRow.getPath();
+                aggregates = Iterators.filter(Iterators.concat(
+                        Iterators.singletonIterator(path),
+                        aggregator.getParents(rootState, path)), Predicates
+                        .not(Predicates.in(seenPaths)));
+            }
             fetchNext();
             return;
         }
@@ -115,6 +118,11 @@ class AggregationCursor extends AbstractCursor {
         return new IndexRow() {
 
             @Override
+            public boolean isVirtualRow() {
+                return false;
+            }
+
+            @Override
             public String getPath() {
                 return currentPath;
             }
diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/SelectorImpl.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/SelectorImpl.java
index 027a85d..65179e8 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/SelectorImpl.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/query/ast/SelectorImpl.java
@@ -412,6 +412,9 @@ public class SelectorImpl extends SourceImpl {
                 // where [b].[jcr:path] = $path"
                 // because if we did, we would filter out
                 // correct results
+            } else if (currentRow.isVirtualRow()) {
+                // this is a virtual row and should be selected as is
+                return true;
             } else {
                 // we must check whether the _child_ is readable
                 // (even if no properties are read) for joins of type
@@ -437,6 +440,10 @@ public class SelectorImpl extends SourceImpl {
     }
 
     private boolean evaluateCurrentRow() {
+        if (currentRow.isVirtualRow()) {
+            //null path implies that all checks are already done -- we just need to pass it through
+            return true;
+        }
         if (!matchesAllTypes && !evaluateTypeMatch()) {
             return false;
         }
@@ -620,7 +627,7 @@ public class SelectorImpl extends SourceImpl {
     
     private PropertyValue currentOakProperty(Tree t, String oakPropertyName, Integer propertyType) {
         PropertyValue result;
-        if (t == null || !t.exists()) {
+        if ((t == null || !t.exists()) && (currentRow == null || !currentRow.isVirtualRow())) {
             return null;
         }
         if (oakPropertyName.equals(QueryImpl.JCR_PATH)) {
diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/query/index/IndexRowImpl.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/query/index/IndexRowImpl.java
index e16f918..5576828 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/query/index/IndexRowImpl.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/query/index/IndexRowImpl.java
@@ -33,6 +33,11 @@ public class IndexRowImpl implements IndexRow {
     }
 
     @Override
+    public boolean isVirtualRow() {
+        return false;
+    }
+
+    @Override
     public String getPath() {
         return path;
     }
diff --git a/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/IndexRow.java b/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/IndexRow.java
index b28f876..527a421 100644
--- a/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/IndexRow.java
+++ b/oak-core/src/main/java/org/apache/jackrabbit/oak/spi/query/IndexRow.java
@@ -24,6 +24,13 @@ import org.apache.jackrabbit.oak.api.PropertyValue;
  * A row returned by the index.
  */
 public interface IndexRow {
+    /**
+     * Marks if the row is virtual and behavior of {@code getPath} is undefined. The implementation may
+     * choose to return {@code null} or empty string. User of a virtual row should now rely of value of
+     * {@code getPath} returned from virtual rows.
+     * @return if path is available for the current row
+     */
+    boolean isVirtualRow();
 
     /**
      * The path of the node, if available.
diff --git a/oak-core/src/test/java/org/apache/jackrabbit/oak/spi/query/CursorsTest.java b/oak-core/src/test/java/org/apache/jackrabbit/oak/spi/query/CursorsTest.java
index 6ccd2f8..f506ffd 100644
--- a/oak-core/src/test/java/org/apache/jackrabbit/oak/spi/query/CursorsTest.java
+++ b/oak-core/src/test/java/org/apache/jackrabbit/oak/spi/query/CursorsTest.java
@@ -117,6 +117,10 @@ public class CursorsTest {
             this.path = path;
             this.id = id;
         }
+        @Override
+        public boolean isVirtualRow() {
+            return false;
+        }
 
         @Override
         public String getPath() {
diff --git a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndex.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndex.java
index fabec74..6db690b 100644
--- a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndex.java
+++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LuceneIndex.java
@@ -1104,6 +1104,10 @@ public class LuceneIndex implements AdvanceFulltextQueryIndex {
         public IndexRow next() {
             final IndexRow pathRow = pathCursor.next();
             return new IndexRow() {
+                @Override
+                public boolean isVirtualRow() {
+                    return getPath() == null;
+                }
 
                 @Override
                 public String getPath() {
diff --git a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndex.java b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndex.java
index 7bb2759..de83be0 100644
--- a/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndex.java
+++ b/oak-lucene/src/main/java/org/apache/jackrabbit/oak/plugins/index/lucene/LucenePropertyIndex.java
@@ -1239,6 +1239,10 @@ public class LucenePropertyIndex implements AdvancedQueryIndex, QueryIndex, Nati
         public IndexRow next() {
             final IndexRow pathRow = pathCursor.next();
             return new IndexRow() {
+                @Override
+                public boolean isVirtualRow() {
+                    return getPath() == null;
+                }
 
                 @Override
                 public String getPath() {
diff --git a/oak-solr-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/solr/query/SolrQueryIndex.java b/oak-solr-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/solr/query/SolrQueryIndex.java
index ff6e1f7..929796c 100644
--- a/oak-solr-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/solr/query/SolrQueryIndex.java
+++ b/oak-solr-core/src/main/java/org/apache/jackrabbit/oak/plugins/index/solr/query/SolrQueryIndex.java
@@ -539,6 +539,10 @@ public class SolrQueryIndex implements FulltextQueryIndex, QueryIndex.AdvanceFul
         public IndexRow next() {
             final IndexRow pathRow = pathCursor.next();
             return new IndexRow() {
+                @Override
+                public boolean isVirtualRow() {
+                    return false;
+                }
 
                 @Override
                 public String getPath() {
-- 
2.1.4

