Changeset 7770

Timestamp:

Feb 10, 2020, 1:53:05 PM (3 years ago)

Author:

Nicklas Nordborg

Message:

References #2202: Include information from parent items in list pages

Implemented support for filtering on parent item columns. Basically this works by executing an extra query just to find the matching parent items for each of the columns and then using the "Item list" functionality to traverse down to find the child items.

This can take a long time if there are many steps between the parent and child levels. To improve performance a simple cache has been implemented.

The filtering feature is also limiting the parent items that are supported to those that can be used for items lists. There is also one remaining issue with subtypes that has the "Push annotations to parent" flag set. When displaying data, those items will be found since the annotation system in BASE knows that it should go back down in those branches, but the item list functionality doesn't. Thus, filtering on such items will never return any results.

Location:

trunk/src

Files:

• clients/web/net/sf/basedb/clients/web/extensions/list/ParentItemAnnotationColumn.java (modified) (2 diffs)
• clients/web/net/sf/basedb/clients/web/extensions/list/ParentItemColumn.java (modified) (3 diffs)
• core/net/sf/basedb/core/ItemContext.java (modified) (4 diffs)
• core/net/sf/basedb/core/PropertyFilter.java (modified) (3 diffs)
• core/net/sf/basedb/core/SyncFilter.java (modified) (1 diff)
• core/net/sf/basedb/util/listable/SourceItemTransformerWithCache.java (added)
• core/net/sf/basedb/util/listable/TransformCache.java (added)
• core/net/sf/basedb/util/listable/TransformContext.java (modified) (1 diff)

trunk/src/clients/web/net/sf/basedb/clients/web/extensions/list/ParentItemAnnotationColumn.java

@@ -1 +1 @@
 package net.sf.basedb.clients.web.extensions.list;
 
+import java.util.List;
 import java.util.Set;
 import java.util.TreeSet;
 
+import net.sf.basedb.clients.web.util.HTML;
 import net.sf.basedb.core.Annotatable;
 import net.sf.basedb.core.AnnotationType;
 import net.sf.basedb.core.snapshot.AnnotationSnapshot;
 import net.sf.basedb.core.snapshot.AnnotationTypeFilter;
+import net.sf.basedb.util.Enumeration;
 import net.sf.basedb.util.filter.Filter;
 
@@ -27 +30 @@
     this.at = at;
     this.atFilter = new AnnotationTypeFilter(at);
+    if (at.isEnumeration())
+    {
+      Enumeration<String, String> annotationEnum = new Enumeration<String, String>();
+      annotationEnum.add("", "-none-");
+      List<?> values = at.getValues();
+      for (Object value : values)
+      {
+        String encoded = HTML.encodeTags(value.toString());
+        annotationEnum.add(encoded, encoded);
+      }
+      setEnumeration(annotationEnum);
+    }
   }
   

trunk/src/clients/web/net/sf/basedb/clients/web/extensions/list/ParentItemColumn.java

@@ -11 +11 @@
 import net.sf.basedb.core.ItemSubtype;
 import net.sf.basedb.core.Metadata;
+import net.sf.basedb.core.Type;
 import net.sf.basedb.core.Metadata.PropertyPath;
 import net.sf.basedb.util.AnnotationUtil;
@@ -74 +75 @@
           col.setTitle(subtype.getName());
           col.setTooltip(subtype.getName());
+          col.setFilterProperty("/"+tmp[1]+"/"+tmp[2]+"/name");
         }
+        col.setValueType(Type.STRING);
         if (property == null || property.getHibernateType().isEntityType())
         {
@@ -105 +108 @@
     setProperty(id);
     setExportable(true);
+    setFilterable(true);
   }
 

trunk/src/core/net/sf/basedb/core/ItemContext.java

@@ -27 +27 @@
 import net.sf.basedb.core.query.Expressions;
 import net.sf.basedb.core.query.Hql;
+import net.sf.basedb.core.query.IdListRestriction;
 import net.sf.basedb.core.query.Orders;
 import net.sf.basedb.core.query.Order;
@@ -1516 +1517 @@
   // Do not auto-join queries containing filter properties with the following prefixes
   private static final Set<String> NO_AUTO_JOIN_PREFIXES = new HashSet<String>(
-    Arrays.asList("£", "&", "!", "¤", "|"));
+    Arrays.asList("£", "&", "!", "¤", "|", "/"));
   
   /**
@@ -1682 +1683 @@
     {
       Map<Integer, List<Restriction>> allRestrictions = new HashMap<Integer, List<Restriction>>();
+      Map<Integer, IdListRestriction> rowIdListRestriction = new HashMap<Integer, IdListRestriction>();
       for (PropertyFilterPair filterPair : propertyFilters.values())
       {
@@ -1690 +1692 @@
           {
             Restriction r = filter.getRestriction(dc, query);
+            int rowIndex = filter.getRowIndex();
+            if (r instanceof IdListRestriction)
+            {
+              // Filters that result in a "IdListRestriction" are merged to a single id-list
+              // since that typically will result in a shorter list in the final SQL
+              IdListRestriction rowIdR = rowIdListRestriction.get(rowIndex);
+              if (rowIdR == null)
+              {
+                rowIdListRestriction.put(rowIndex, (IdListRestriction)r);
+              }
+              else
+              {
+                rowIdR.intersect((IdListRestriction)r);
+                r = null;
+              }
+            }
             if (r != null)
             {
-              int rowIndex = filter.getRowIndex();
               List<Restriction> rowRestrictions = allRestrictions.get(rowIndex);
               if (rowRestrictions == null)

trunk/src/core/net/sf/basedb/core/PropertyFilter.java

@@ -28 +28 @@
 import java.util.Collections;
 import java.util.List;
+import java.util.Set;
+import java.util.SortedSet;
+import java.util.TreeSet;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
+import net.sf.basedb.core.SyncFilter.SourceItemTransform;
 import net.sf.basedb.core.data.PropertyFilterData;
 import net.sf.basedb.core.data.ReporterData;
@@ -45 +49 @@
 import net.sf.basedb.core.query.Dynamic;
 import net.sf.basedb.core.query.Hql;
+import net.sf.basedb.core.query.IdListRestriction;
+import net.sf.basedb.util.listable.ListableUtil;
+import net.sf.basedb.util.listable.SourceItemTransformerFactory;
+import net.sf.basedb.util.listable.SourceItemTransformerWithCache;
+import net.sf.basedb.util.listable.TransformContext;
 import net.sf.basedb.util.units.UnitUtil;
 
@@ -790 +799 @@
       }
     }
-    
+    else if (property != null && property.startsWith("/"))
+    {
+      // Property is Parent-item filter: /TYPE/subtype-id/(property|#annotation-id)
+      String[] parts = property.split("/", 4);
+      Item parentType = Item.valueOf(parts[1]);
+      ItemSubtype subtype = ItemSubtype.getById(dc, (Integer)Type.INT.parseString(parts[2]));
+      String parentProperty = parts[3];
+      
+      // We execute a query for the parent items...
+      EntityQuery subquery = new AbstractEntityQuery(parentType, parentType, null, "id", false, null)
+      {};
+      subquery.restrict(Restrictions.eq(Hql.property("itemSubtype"), Hql.entity(subtype)));
+      PropertyFilter pp = new PropertyFilter(parentProperty, operator, getValue(), getValueType());
+      subquery.restrict(pp.getRestriction(dc, subquery));
+
+      // We then transform the list if ID:s to a list of child item ID:s using ItemList functionality
+      SortedSet<Integer> parentIds = new TreeSet<>(subquery.idList(dc));
+      TransformContext tCtx = new TransformContext(dc);
+
+      SourceItemTransformerFactory factory = ListableUtil.getTransformerFactory(query.getItemType());
+      factory = new SourceItemTransformerWithCache(factory);
+      Set<Integer> myIds = factory.create(parentType, SourceItemTransform.PARENT_TO_CHILD).transform(tCtx, parentIds);
+      
+      // The final ID list is returned as a restriction
+      restriction = new IdListRestriction(myIds);
+    }
     else
     {

trunk/src/core/net/sf/basedb/core/SyncFilter.java

@@ -472 +472 @@
     should produce the same MD5.
   */
-  static String toMd5(SortedSet<Integer> listOfIds)
+  public static String toMd5(SortedSet<Integer> listOfIds)
   {
     MessageDigest md5 = MD5.newInstance();

trunk/src/core/net/sf/basedb/util/listable/TransformContext.java

@@ -72 +72 @@
   }
   
+  /**
+    Get a cache that can be used for storing transformation
+    results for some time. The cache is stored in the current
+    session and is lost if the user logs out.
+    @since 3.16
+  */
+  public TransformCache getCache()
+  {
+    TransformCache cache = dc.getSessionControl().getSessionSetting(TransformCache.class.getName());
+    if (cache == null)
+    {
+      cache = new TransformCache(20);
+      dc.getSessionControl().setSessionSetting(TransformCache.class.getName(), cache);
+    }
+    return cache;
+  }
+
 }