Changeset 2507

Timestamp:

06/17/08 15:37:52 (6 months ago)

Author:

jmoore

Message:

OmeroSearch : Added omero.search.excludes property

omero.search.excludes contains a list of comma-separated strings
which are passed to the EventLogLoader to be filtered out of the
EventLog.entityType field in the nextEventLog(long) method.

Location:

trunk

Files:

• components/server/resources/ome/services/service-ome.api.Search.xml (modified) (1 diff)
• components/server/src/ome/services/fulltext/EventLogLoader.java (modified) (4 diffs)
• components/server/src/ome/tools/hibernate/QueryBuilder.java (modified) (1 diff)
• components/server/test/ome/server/itests/search/PersistentEventLogLoaderTest.java (modified) (2 diffs)
• etc/omero.properties (modified) (1 diff)

trunk/components/server/resources/ome/services/service-ome.api.Search.xml

@@ -81 +81 @@
     <property name="types" ref="internal:ome.api.ITypes"/>
     <property name="batchSize" value="${omero.search.batch}"/>
+    <property name="excludes" value="${omero.search.excludes}"/>
   </bean>
 

trunk/components/server/src/ome/services/fulltext/EventLogLoader.java

@@ -9 +9 @@
 
 import java.util.ArrayList;
+import java.util.Arrays;
 import java.util.Collections;
 import java.util.Iterator;
@@ -18 +19 @@
 import ome.parameters.Filter;
 import ome.parameters.Parameters;
+import ome.tools.hibernate.QueryBuilder;
 
 /**
@@ -67 +69 @@
     private EventLog log;
 
+    /**
+     * Array of class types which will get excluded from indexing.
+     */
+    protected List<String> excludes = Collections.emptyList();
+
+    /**
+     * Spring injector
+     */
+    public void setExcludes(String[] excludes) {
+        this.excludes = Collections.unmodifiableList(Arrays.asList(excludes));
+    }
+
     protected IQuery queryService;
 
+    /**
+     * Spring injector
+     */
     public void setQueryService(IQuery queryService) {
         this.queryService = queryService;
@@ -150 +167 @@
      * Returns the {@link EventLog} with the next id after the given argument or
      * null if none exists. This method will only return "true" {@link EventLog}
-     * instances, with a valid id.
+     * instances, with a valid id. The {@link #excludes} list is used to filter
+     * out unwanted {@link EventLog} isntances.
      */
     public final EventLog nextEventLog(long id) {
-        return queryService.findByQuery("select el from EventLog el "
-                + "where el.id > :id order by id", new Parameters(new Filter()
-                .page(0, 1)).addId(id));
+        List<String> copy = excludes; // Instead of synchronizing
+        QueryBuilder qb = new QueryBuilder();
+        qb.select("el");
+        qb.from("EventLog", "el");
+        qb.where();
+        qb.and("el.id > " + id);
+        if (copy != null) {
+            for (String exclude : copy) {
+                qb.and("el.entityType != '" + exclude + "'");
+            }
+        }
+        qb.order("id", true);
+        String query = qb.queryString();
+
+        return queryService.findByQuery(query, new Parameters(new Filter()
+                .page(0, 1)));
     }
 

trunk/components/server/src/ome/tools/hibernate/QueryBuilder.java

@@ -257 +257 @@
     }
 
+    /**
+     * Returns the current query as a String. As opposed to {@link #toString()},
+     * this method should return parseable HQL.
+     */
+    public String queryString() {
+        return sb.toString();
+    }
+
     @Override
     public String toString() {

trunk/components/server/test/ome/server/itests/search/PersistentEventLogLoaderTest.java

@@ -38 +38 @@
         ome.model.meta.Session s = sm.create(new Principal("root", "system",
                 "FullText"));
+        final boolean[] result = new boolean[1];
         ex.execute(new Principal(s.getUuid(), "system", "FullText"),
                 new Executor.Work() {
@@ -51 +52 @@
                             }
                         }
-                        assertTrue(ll.getCurrentId() > 0);
+                        result[0] = ll.getCurrentId() > 0;
+                        return null;
+                    }
+                });
+        assertTrue(result[0]);
+    }
+
+    public void testTestExcludes() throws Exception {
+        ome.model.meta.Session s = sm.create(new Principal("root", "system",
+                "FullText"));
+        ex.execute(new Principal(s.getUuid(), "system", "FullText"),
+                new Executor.Work() {
+                    public Object doWork(TransactionStatus status,
+                            Session session, ServiceFactory sf) {
+                        ll.nextEventLog(0);
                         return null;
                     }

trunk/etc/omero.properties

@@ -62 +62 @@
 # Maximum number of OR-clauses to which a single search can expand
 omero.search.maxclause=4096
+
+# Indexing takes place on all EventLogs as the occur in the database.
+# The types listed here will be skipped if they appear in the "entityType"
+# field of the EventLog table.
+omero.search.excludes=ome.model.core.PlaneInfo,ome.model.meta.Session
 
 # Extra bridge classes, comma-separated, to be invoked on each indexing.