Added support for result set meta data

Added size limits for result sets
Updated/improved comments

git-svn-id: https://svn.alfresco.com/repos/alfresco-enterprise/alfresco/HEAD/root@2573 c4b6b30b-aa2e-2d43-bbcb-ca4b014f7261

source/java/org/alfresco/repo/search/EmptyResultSet.java

@@ -24,8 +24,12 @@ import java.util.List;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.Path;
+import org.alfresco.service.cmr.search.LimitBy;
+import org.alfresco.service.cmr.search.PermissionEvaluationMode;
 import org.alfresco.service.cmr.search.ResultSet;
+import org.alfresco.service.cmr.search.ResultSetMetaData;
 import org.alfresco.service.cmr.search.ResultSetRow;
+import org.alfresco.service.cmr.search.SearchParameters;
 
 public class EmptyResultSet implements ResultSet
 {
@@ -87,4 +91,9 @@ public class EmptyResultSet implements ResultSet
         // TODO Auto-generated method stub
         throw new UnsupportedOperationException();
     }
+
+    public ResultSetMetaData getResultSetMetaData()
+    {
+        return new SimpleResultSetMetaData(LimitBy.UNLIMITED, PermissionEvaluationMode.EAGER, new SearchParameters());
+    }
 }

source/java/org/alfresco/repo/search/SearchServiceTest.java

@@ -0,0 +1,259 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.repo.search;
+
+import javax.transaction.UserTransaction;
+
+import junit.framework.TestCase;
+
+import org.alfresco.model.ContentModel;
+import org.alfresco.repo.security.authentication.AuthenticationComponent;
+import org.alfresco.repo.security.authentication.MutableAuthenticationDao;
+import org.alfresco.service.ServiceRegistry;
+import org.alfresco.service.cmr.repository.NodeRef;
+import org.alfresco.service.cmr.repository.NodeService;
+import org.alfresco.service.cmr.repository.StoreRef;
+import org.alfresco.service.cmr.search.LimitBy;
+import org.alfresco.service.cmr.search.PermissionEvaluationMode;
+import org.alfresco.service.cmr.search.ResultSet;
+import org.alfresco.service.cmr.search.SearchParameters;
+import org.alfresco.service.cmr.search.SearchService;
+import org.alfresco.service.cmr.security.AuthenticationService;
+import org.alfresco.service.cmr.security.PermissionService;
+import org.alfresco.service.namespace.QName;
+import org.alfresco.service.transaction.TransactionService;
+import org.alfresco.util.ApplicationContextHelper;
+import org.springframework.context.ApplicationContext;
+
+public class SearchServiceTest extends TestCase
+{
+
+    private static ApplicationContext ctx = ApplicationContextHelper.getApplicationContext();
+
+    private AuthenticationComponent authenticationComponent;
+
+    private AuthenticationService authenticationService;
+
+    private MutableAuthenticationDao authenticationDAO;
+
+    private UserTransaction tx;
+
+    private SearchService pubSearchService;
+
+    private NodeRef rootNodeRef;
+
+    private NodeRef n1;
+
+    private NodeRef n2;
+
+    private NodeRef n3;
+
+    private NodeRef n4;
+
+    private NodeRef n6;
+
+    private NodeRef n5;
+
+    private NodeRef n7;
+
+    private NodeRef n8;
+
+    private NodeRef n9;
+
+    private NodeRef n10;
+
+    private NodeService nodeService;
+
+    private PermissionService pubPermissionService;
+
+    public SearchServiceTest()
+    {
+        super();
+    }
+
+    public void setUp() throws Exception
+    {
+        nodeService = (NodeService) ctx.getBean("dbNodeService");
+        authenticationComponent = (AuthenticationComponent) ctx.getBean("authenticationComponentImpl");
+        authenticationService = (AuthenticationService) ctx.getBean("authenticationService");
+        authenticationDAO = (MutableAuthenticationDao) ctx.getBean("alfDaoImpl");
+        pubSearchService = (SearchService) ctx.getBean("SearchService");
+        pubPermissionService = (PermissionService) ctx.getBean("PermissionService");
+
+        this.authenticationComponent.setSystemUserAsCurrentUser();
+
+        TransactionService transactionService = (TransactionService) ctx.getBean(ServiceRegistry.TRANSACTION_SERVICE
+                .getLocalName());
+        tx = transactionService.getUserTransaction();
+        tx.begin();
+
+        if (!authenticationDAO.userExists("andy"))
+        {
+            authenticationService.createAuthentication("andy", "andy".toCharArray());
+        }
+
+        if (!authenticationDAO.userExists("admin"))
+        {
+            authenticationService.createAuthentication("admin", "admin".toCharArray());
+        }
+
+        if (!authenticationDAO.userExists("administrator"))
+        {
+            authenticationService.createAuthentication("administrator", "administrator".toCharArray());
+        }
+
+        StoreRef storeRef = nodeService.createStore(StoreRef.PROTOCOL_WORKSPACE, "Test_" + System.currentTimeMillis());
+        rootNodeRef = nodeService.getRootNode(storeRef);
+
+        n1 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}01"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+        pubPermissionService.setPermission(n1, "andy", "Read", true);
+        n2 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}02"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+        pubPermissionService.setPermission(n2, "andy", "Read", true);
+        n3 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}03"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+        pubPermissionService.setPermission(n3, "andy", "Read", true);
+        n4 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}04"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+        pubPermissionService.setPermission(n4, "andy", "Read", true);
+        n5 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}05"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+        pubPermissionService.setPermission(n5, "andy", "Read", true);
+        n6 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}06"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+        n7 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}07"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+        n8 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}08"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+        n9 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}09"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+        n10 = nodeService.createNode(rootNodeRef, ContentModel.ASSOC_CHILDREN, QName.createQName("{test}10"),
+                ContentModel.TYPE_CONTAINER).getChildRef();
+
+    }
+
+    @Override
+    protected void tearDown() throws Exception
+    {
+        authenticationComponent.clearCurrentSecurityContext();
+        tx.rollback();
+        super.tearDown();
+    }
+
+    public void testAdmim()
+    {
+        authenticationComponent.setCurrentUser("admin");
+        SearchParameters sp = new SearchParameters();
+        sp.setLanguage(SearchService.LANGUAGE_LUCENE);
+        sp.setQuery("PATH:\"//*\"");
+        sp.addStore(rootNodeRef.getStoreRef());
+        ResultSet results = pubSearchService.query(sp);
+        assertEquals(results.length(), 10);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.UNLIMITED);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+
+        sp.setLimitBy(LimitBy.FINAL_SIZE);
+        sp.setLimit(20);
+        results = pubSearchService.query(sp);
+        assertEquals(results.length(), 10);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.UNLIMITED);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+
+        sp.setLimitBy(LimitBy.FINAL_SIZE);
+        sp.setLimit(10);
+        results = pubSearchService.query(sp);
+        assertEquals(results.length(), 10);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.UNLIMITED);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+
+        sp.setLimitBy(LimitBy.FINAL_SIZE);
+        sp.setLimit(9);
+        results = pubSearchService.query(sp);
+        assertEquals(results.length(), 9);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.FINAL_SIZE);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+        
+        sp.setLimitBy(LimitBy.FINAL_SIZE);
+        sp.setLimit(5);
+        results = pubSearchService.query(sp);
+        assertEquals(results.length(), 5);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.FINAL_SIZE);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+    }
+
+    public void testAndy()
+    {
+        authenticationComponent.setCurrentUser("andy");
+        SearchParameters sp = new SearchParameters();
+        sp.setLanguage(SearchService.LANGUAGE_LUCENE);
+        sp.setQuery("PATH:\"//*\"");
+        sp.addStore(rootNodeRef.getStoreRef());
+        ResultSet results = pubSearchService.query(sp);
+        assertEquals(results.length(), 5);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.UNLIMITED);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+
+        sp.setLimitBy(LimitBy.FINAL_SIZE);
+        sp.setLimit(20);
+        results = pubSearchService.query(sp);
+        assertEquals(results.length(), 5);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.UNLIMITED);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+
+        sp.setLimitBy(LimitBy.FINAL_SIZE);
+        sp.setLimit(5);
+        results = pubSearchService.query(sp);
+        assertEquals(results.length(), 5);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.UNLIMITED);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+
+        sp.setLimitBy(LimitBy.FINAL_SIZE);
+        sp.setLimit(4);
+        results = pubSearchService.query(sp);
+        assertEquals(results.length(), 4);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.FINAL_SIZE);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+        
+        sp.setLimitBy(LimitBy.FINAL_SIZE);
+        sp.setLimit(2);
+        results = pubSearchService.query(sp);
+        assertEquals(results.length(), 2);
+        assertNotNull(results.getResultSetMetaData());
+        assertEquals(results.getResultSetMetaData().getLimitedBy(), LimitBy.FINAL_SIZE);
+        assertEquals(results.getResultSetMetaData().getPermissionEvaluationMode(), PermissionEvaluationMode.EAGER);
+        results.close();
+    }
+}

source/java/org/alfresco/repo/search/SimpleResultSetMetaData.java

@@ -0,0 +1,61 @@
+/*
+ * Copyright (C) 2005 Alfresco, Inc.
+ *
+ * Licensed under the Mozilla Public License version 1.1 
+ * with a permitted attribution clause. You may obtain a
+ * copy of the License at
+ *
+ *   http://www.alfresco.org/legal/license.txt
+ *
+ * Unless required by applicable law or agreed to in writing,
+ * software distributed under the License is distributed on an
+ * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND,
+ * either express or implied. See the License for the specific
+ * language governing permissions and limitations under the
+ * License.
+ */
+package org.alfresco.repo.search;
+
+import org.alfresco.service.cmr.search.LimitBy;
+import org.alfresco.service.cmr.search.PermissionEvaluationMode;
+import org.alfresco.service.cmr.search.ResultSetMetaData;
+import org.alfresco.service.cmr.search.SearchParameters;
+
+/**
+ * Simple implementatio of result set meta data.
+ * 
+ * @author Andy Hind
+ */
+public class SimpleResultSetMetaData implements ResultSetMetaData
+{
+    private LimitBy limitedBy; 
+    
+    private PermissionEvaluationMode permissoinEvaluationMode;
+    
+    private SearchParameters searchParameters;
+    
+    
+    public SimpleResultSetMetaData(LimitBy limitedBy, PermissionEvaluationMode permissoinEvaluationMode, SearchParameters searchParameters)
+    {
+        super();
+        this.limitedBy = limitedBy;
+        this.permissoinEvaluationMode = permissoinEvaluationMode;
+        this.searchParameters = searchParameters;
+    }
+
+    public LimitBy getLimitedBy()
+    {
+        return limitedBy;
+    }
+
+    public PermissionEvaluationMode getPermissionEvaluationMode()
+    {
+        return permissoinEvaluationMode;
+    }
+
+    public SearchParameters getSearchParameters()
+    {
+        return searchParameters;
+    }
+
+}

source/java/org/alfresco/repo/search/impl/lucene/LuceneIndexerImpl.java

@@ -60,6 +60,7 @@ import org.alfresco.service.cmr.repository.Path;
 import org.alfresco.service.cmr.repository.StoreRef;
 import org.alfresco.service.cmr.repository.datatype.DefaultTypeConverter;
 import org.alfresco.service.cmr.search.ResultSetRow;
+import org.alfresco.service.cmr.search.SearchParameters;
 import org.alfresco.service.namespace.QName;
 import org.alfresco.util.EqualsHelper;
 import org.alfresco.util.ISO9075;
@@ -1689,7 +1690,7 @@ public class LuceneIndexerImpl extends LuceneBase implements LuceneIndexer
                     throw new LuceneIndexException(
                             "Failed to execute query to find content which needs updating in the index", e);
                 }
-                results = new LuceneResultSet(hits, searcher, nodeService, null);
+                results = new LuceneResultSet(hits, searcher, nodeService, null, new SearchParameters());
 
                 for (ResultSetRow row : results)
                 {

source/java/org/alfresco/repo/search/impl/lucene/LuceneResultSet.java

@@ -21,11 +21,16 @@ import java.io.IOException;
 import org.alfresco.repo.search.AbstractResultSet;
 import org.alfresco.repo.search.ResultSetRowIterator;
 import org.alfresco.repo.search.SearcherException;
+import org.alfresco.repo.search.SimpleResultSetMetaData;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.NodeService;
 import org.alfresco.service.cmr.repository.Path;
+import org.alfresco.service.cmr.search.LimitBy;
+import org.alfresco.service.cmr.search.PermissionEvaluationMode;
+import org.alfresco.service.cmr.search.ResultSetMetaData;
 import org.alfresco.service.cmr.search.ResultSetRow;
+import org.alfresco.service.cmr.search.SearchParameters;
 import org.apache.lucene.document.Document;
 import org.apache.lucene.search.Hits;
 import org.apache.lucene.search.Searcher;
@@ -47,18 +52,21 @@ public class LuceneResultSet extends AbstractResultSet
     
     private NodeService nodeService;
 
+    SearchParameters searchParameters;
+    
     /**
      * Wrap a lucene seach result with node support
      * 
      * @param storeRef
      * @param hits
      */
-    public LuceneResultSet(Hits hits, Searcher searcher, NodeService nodeService, Path[]propertyPaths)
+    public LuceneResultSet(Hits hits, Searcher searcher, NodeService nodeService, Path[]propertyPaths, SearchParameters searchParameters)
     {
         super(propertyPaths);
         this.hits = hits;
         this.searcher = searcher;
         this.nodeService = nodeService;
+        this.searchParameters = searchParameters;
     }
 
     /*
@@ -149,4 +157,10 @@ public class LuceneResultSet extends AbstractResultSet
     {
        return getRow(n).getChildAssocRef();
     }
+
+    
+    public ResultSetMetaData getResultSetMetaData()
+    {
+        return new SimpleResultSetMetaData(LimitBy.UNLIMITED, PermissionEvaluationMode.EAGER, searchParameters);
+    }
 }

source/java/org/alfresco/repo/search/impl/lucene/LuceneSearcherImpl.java

@@ -255,7 +255,7 @@ public class LuceneSearcherImpl extends LuceneBase implements LuceneSearcher
                 }
 
                 return new LuceneResultSet(hits, searcher, nodeService, searchParameters.getAttributePaths().toArray(
-                        new Path[0]));
+                        new Path[0]), searchParameters);
 
             }
             catch (ParseException e)
@@ -290,7 +290,7 @@ public class LuceneSearcherImpl extends LuceneBase implements LuceneSearcher
                 }
                 Hits hits = searcher.search(query);
                 return new LuceneResultSet(hits, searcher, nodeService, searchParameters.getAttributePaths().toArray(
-                        new Path[0]));
+                        new Path[0]), searchParameters);
             }
             catch (SAXPathException e)
             {

source/java/org/alfresco/repo/search/results/ChildAssocRefResultSet.java

@@ -28,11 +28,16 @@ import java.util.Iterator;
 import java.util.List;
 
 import org.alfresco.repo.search.AbstractResultSet;
+import org.alfresco.repo.search.SimpleResultSetMetaData;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.NodeService;
 import org.alfresco.service.cmr.repository.Path;
+import org.alfresco.service.cmr.search.LimitBy;
+import org.alfresco.service.cmr.search.PermissionEvaluationMode;
+import org.alfresco.service.cmr.search.ResultSetMetaData;
 import org.alfresco.service.cmr.search.ResultSetRow;
+import org.alfresco.service.cmr.search.SearchParameters;
 
 public class ChildAssocRefResultSet extends AbstractResultSet
 {
@@ -95,4 +100,8 @@ public class ChildAssocRefResultSet extends AbstractResultSet
         return nodeService;
     }
 
+    public ResultSetMetaData getResultSetMetaData()
+    {
+        return new SimpleResultSetMetaData(LimitBy.UNLIMITED, PermissionEvaluationMode.EAGER, new SearchParameters());
+    }
 }

source/java/org/alfresco/repo/search/results/DetachedResultSet.java

@@ -21,19 +21,26 @@ import java.util.Iterator;
 import java.util.List;
 
 import org.alfresco.repo.search.AbstractResultSet;
+import org.alfresco.repo.search.SimpleResultSetMetaData;
 import org.alfresco.service.cmr.repository.ChildAssociationRef;
 import org.alfresco.service.cmr.repository.NodeRef;
 import org.alfresco.service.cmr.repository.Path;
+import org.alfresco.service.cmr.search.LimitBy;
+import org.alfresco.service.cmr.search.PermissionEvaluationMode;
 import org.alfresco.service.cmr.search.ResultSet;
+import org.alfresco.service.cmr.search.ResultSetMetaData;
 import org.alfresco.service.cmr.search.ResultSetRow;
 
 public class DetachedResultSet extends AbstractResultSet
 {
     List<ResultSetRow> rows = null;
     
+    ResultSetMetaData rsmd;
+    
     public DetachedResultSet(ResultSet resultSet, Path[] propertyPaths)
     {
         super(propertyPaths);
+        rsmd = resultSet.getResultSetMetaData();
         rows = new ArrayList<ResultSetRow>(resultSet.length());
         for (ResultSetRow row : resultSet)
         {
@@ -66,4 +73,9 @@ public class DetachedResultSet extends AbstractResultSet
         return rows.get(n).getChildAssocRef();
     }
 
+    public ResultSetMetaData getResultSetMetaData()
+    {
+        return new SimpleResultSetMetaData(rsmd.getLimitedBy(), PermissionEvaluationMode.EAGER, rsmd.getSearchParameters());
+    }
+
 }