Changeset 6335

Timestamp:

Oct 21, 2013, 3:46:22 PM (9 years ago)

Author:

olle

Message:

Refs #1773. Support for annotatable Tag items added.

Location:

trunk

Files:

• src/core/net/sf/basedb/core/Extract.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/Tag.java (modified) (2 diffs)
• src/core/net/sf/basedb/core/data/TagData.java (modified) (1 diff)
• src/core/net/sf/basedb/util/overview/loader/TagLoader.java (modified) (1 diff)
• www/biomaterials/extracts/extracts.js (modified) (1 diff)
• www/biomaterials/tags/edit_tag.jsp (modified) (3 diffs)
• www/biomaterials/tags/index.jsp (modified) (3 diffs)
• www/biomaterials/tags/list_tags.jsp (modified) (5 diffs)
• www/biomaterials/tags/tags.js (modified) (3 diffs)
• www/biomaterials/tags/view_tag.jsp (modified) (1 diff)
• www/include/scripts/main.js (modified) (1 diff)

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

@@ -27 +27 @@
 import net.sf.basedb.core.data.ExtractData;
 
+import java.util.HashSet;
 import java.util.Set;
 
@@ -355 +356 @@
   }
 
+  /**
+    Get all parent extracts.
+    @return A query returning all parent extracts
+    @since 3.3
+   */
+  public ItemQuery<Extract> getParents()
+  {
+    ItemQuery<Extract> query = Extract.getQuery();
+    query.joinPermanent(Hql.innerJoin("children", "c"));
+    query.restrictPermanent(
+      Restrictions.eq(
+        Hql.alias("c"),
+        Hql.entity(this)
+      )
+    );
+    return query;
+  }
+
+
+  // -------------------------------------------
+  /*
+    From the Annotatable interface
+    -------------------------------------------
+  */
+  /**
+    Get the tag and parent extracts.
+  */
+  @Override
+  public Set<Annotatable> getAnnotatableParents()
+    throws BaseException
+  {
+    Set<Annotatable> annotatable = new HashSet<Annotatable>();
+    try
+    {
+      ItemQuery<Extract> query = getParents();
+      query.include(Include.ALL);
+      annotatable.addAll(query.list(getDbControl()));
+      if (getData().getTag() != null) annotatable.add(getTag());
+    }
+    catch (PermissionDeniedException ex)
+    {}
+    return annotatable;
+  }
 }
 

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

@@ -36 +36 @@
 */
 public class Tag
-  extends CommonItem<TagData>
+  extends AnnotatedItem<TagData>
   implements Registered, Subtypable
 {
@@ -127 +127 @@
   {
     return DateUtil.copy(getData().getEntryDate());
+  }
+  // -------------------------------------------
+  /*
+    From the Annotatable interface
+    -------------------------------------------
+  */
+  /**
+    @return Always null
+    @since 3.3
+  */
+  @Override
+  public Set<Annotatable> getAnnotatableParents()
+  {
+    return null;
   }
   // -------------------------------------------

trunk/src/core/net/sf/basedb/core/data/TagData.java

@@ -35 +35 @@
 */
 public class TagData
-  extends CommonData
+  extends AnnotatedData
   implements RegisteredData, SubtypableData
 {

trunk/src/core/net/sf/basedb/util/overview/loader/TagLoader.java

@@ -84 +84 @@
     
     NodeFactory<Tag> nf = getNodeFactory(dc, context);
-    Node hardwareNode = createItemNode(nf, tag, tag, denied, 
-        parentNode, ChildNodeDirection.NONE);
-    return hardwareNode;
+    Node tagNode = createItemNode(nf, tag, tag, denied, 
+        parentNode, ChildNodeDirection.PROPERTY);
+    return tagNode;
   }
   // -----------------------------------
-  
+  /*
+    From the AbstractNodeLoader class
+    ----------------------------------
+  */
+  /**
+    Loads annotations and tag parameters for the given tag node.
+    @see RawBioAssayLoader#createForwardNode(DbControl, OverviewContext, Node)
+  */
+  @Override
+  protected void loadPropertyChildNodes(DbControl dc, OverviewContext context, Node tagNode)
+  {
+    getNodeLoader(context, Item.ANNOTATION).createPropertyNode(dc, context, tagNode);
+  }
+  // -------------------------------------    
 }

trunk/www/biomaterials/extracts/extracts.js

@@ -272 +272 @@
       }
     }
+    var tagId = Math.abs(parseInt(frm.tag_id.value));
+    if (tagId > 0) parents[parents.length] = 'TAG:'+tagId;
     return parents;
   }

trunk/www/biomaterials/tags/edit_tag.jsp

@@ -26 +26 @@
 --%>
 <%@ page pageEncoding="UTF-8" session="false"
+  import="net.sf.basedb.core.AnnotationType"
   import="net.sf.basedb.core.SessionControl"
   import="net.sf.basedb.core.DbControl"
@@ -93 +94 @@
   }
   
-  // Query to retrieve protocol types
+  // Query to retrieve tag types
   final ItemQuery<ItemSubtype> tagTypeQuery = ItemSubtype.getQuery(itemType);
   tagTypeQuery.include(Include.ALL);
@@ -167 +168 @@
       </table>
     </t:tab>
+    <t:tab id="annotations" title="Annotations" helpid="annotations.edit">
+      <jsp:include page="../../common/annotations/annotate_frameset.jsp">
+        <jsp:param name="item_type" value="<%=itemType.name()%>" />
+        <jsp:param name="item_id" value="<%=itemId%>" />
+        <jsp:param name="ID" value="<%=ID%>" />
+      </jsp:include>
+    </t:tab>
     </t:tabcontrol>
     </form>

trunk/www/biomaterials/tags/index.jsp

@@ -163 +163 @@
       }
 
+      Base.updateAnnotations(dc, tag, tag, request);
       // OnSave extensions
       invoker.render(OnSaveRenderer.ON_SAVE);
@@ -199 +200 @@
       message = (numRemoved == 0 ? "No" : "Only "+numRemoved+" of "+numTotal) + " items could be deleted, because you have no DELETE permission";
     }
-    redirect = listPage;
+    redirect = listPage+(message != null ? "&popmessage="+HTML.urlEncode(message) : "");
   }
   else if ("RestoreItem".equals(cmd))
@@ -222 +223 @@
       message = (numRemoved == 0 ? "No" : "Only "+numRemoved+" of "+numTotal) + " items could be restored, because you have no WRITE permission";
     }
-    redirect = listPage;
+    redirect = listPage+(message != null ? "&popmessage="+HTML.urlEncode(message) : "");
   }
   else if ("ShareItem".equals(cmd))

trunk/www/biomaterials/tags/list_tags.jsp

@@ -30 +30 @@
   import="net.sf.basedb.core.Tag"
   import="net.sf.basedb.core.ItemSubtype"
+  import="net.sf.basedb.core.Annotation"
+  import="net.sf.basedb.core.AnnotationType"
+  import="net.sf.basedb.core.AnnotationSet"
   import="net.sf.basedb.core.ItemQuery"
   import="net.sf.basedb.core.ItemResultIterator"
+  import="net.sf.basedb.core.ItemResultList"
   import="net.sf.basedb.core.ItemContext"
   import="net.sf.basedb.core.Nameable"
@@ -78 +82 @@
 final DbControl dc = sc.newDbControl();
 ItemResultIterator<Tag> tags = null;
+ItemResultList<AnnotationType> annotationTypes = null;
 try
 {
@@ -85 +90 @@
   typeQuery.order(Orders.asc(Hql.property("name")));
   typeQuery.setCacheResult(true);
+  final ItemQuery<AnnotationType> annotationTypeQuery = Base.getAnnotationTypesQuery(itemType);
+  annotationTypes = annotationTypeQuery.list(dc);
 
   Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
@@ -196 +203 @@
         exportable="true"
       />
+      <%
+      for (AnnotationType at : annotationTypes)
+      {
+        Enumeration<String, String> annotationEnum = null;
+        Formatter formatter = FormatterFactory.getTypeFormatter(sc, at.getValueType());
+        if (at.isEnumeration())
+        {
+          annotationEnum = new Enumeration<String, String>();
+          List<?> values = at.getValues();
+          for (Object value : values)
+          {
+            String encoded = formatter.format(value);
+            annotationEnum.add(encoded, encoded);
+          }
+        }
+        %>
+        <tbl:columndef 
+          id="<%="at"+at.getId()%>"
+          title="<%=HTML.encodeTags(at.getName())+" [A]"%>" 
+          property="<%="#"+at.getId()%>"
+          annotation="true"
+          datatype="<%=at.getValueType().getStringValue()%>"
+          enumeration="<%=annotationEnum%>"
+          smartenum="<%=at.getDisplayAsList() %>"
+          sortable="<%=at.getMultiplicity() == 1%>" 
+          filterable="true" 
+          exportable="true"
+          formatter="<%=formatter%>"
+          unit="<%=at.getDefaultUnit()%>"
+        />
+        <%
+      }
+      %>  
       <tbl:columndef
         id="permission"
@@ -415 +455 @@
                   /></tbl:cell>
                 <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
+                <%
+                AnnotationSet as = item.isAnnotated() ? item.getAnnotationSet() : null;
+                if (as != null)
+                {
+                  for (AnnotationType at : annotationTypes)
+                  {
+                    if (as.hasAnnotation(at))
+                    {
+                      Annotation a = as.getAnnotation(at);
+                      String suffix = a.getUnitSymbol(null);
+                      if (suffix != null) suffix = "&nbsp;" + suffix;
+                      %>
+                      <tbl:cell 
+                        column="<%="at"+at.getId()%>"
+                        ><tbl:cellvalue 
+                          list="<%=a.getValues(null)%>"
+                          suffix="<%=suffix%>"
+                      /></tbl:cell>
+                      <%
+                    }
+                  }
+                }
+                %>
                 <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
                 <tbl:cell column="sharedTo">

trunk/www/biomaterials/tags/tags.js

@@ -40 +40 @@
 
       // Tab validation
+      TabControl.addTabActivateListener('settings.annotations', Annotations.autoLoadEditFrame);
       TabControl.addTabValidator('settings.info', tags.validateTag);
     }
@@ -56 +57 @@
       Buttons.addClickHandler('btnImport', Buttons.runPlugin, attributes);
       Buttons.addClickHandler('btnRunPlugin', Buttons.runPlugin, attributes);
+
+      TabControl.addTabActivateListener('main.annotations', AnnotationsList.loadOnce);
     }
     else if (pageId == 'list-page')
@@ -94 +97 @@
     if (TabControl.validateActiveTab('settings'))
     {
+      Annotations.saveModifiedAnnotationsToForm(frm);
       frm.submit();
     }

trunk/www/biomaterials/tags/view_tag.jsp

@@ -251 +251 @@
       </jsp:include>
     </t:tab>
+    <t:tab id="annotations" title="Annotations" 
+      tooltip="View annotation values" clazz="white">
+      <jsp:include page="../../common/annotations/list_frameset.jsp">
+        <jsp:param name="item_type" value="<%=itemType.name()%>" />
+        <jsp:param name="item_id" value="<%=itemId%>" />
+        <jsp:param name="ID" value="<%=ID%>" />
+      </jsp:include>
+    </t:tab>
     </t:tabcontrol>
 

trunk/www/include/scripts/main.js

@@ -549 +549 @@
     this.controllers['SESSION'] = { url:'views/sessions/index.jsp', width:450, height:300, popup:true, edit:false, noAnyToAny:true };
     this.controllers['SOFTWARE'] = { url:'admin/software/index.jsp', width:800, height:500 };
-    this.controllers['TAG'] = { url:'biomaterials/tags/index.jsp', width:450, height:300 };
+    this.controllers['TAG'] = { url:'biomaterials/tags/index.jsp', width:800, height:500 };
     this.controllers['TRANSFORMATION'] = { url:'views/experiments/transformations/index.jsp', width:450, height:300, noAnyToAny:true };
     this.controllers['UNIT'] = { url:'admin/quantities/units/index.jsp', width:600, height:400, noAnyToAny:true };