source: trunk/www/biomaterials/events/list_events.jsp @ 4882

Last change on this file since 4882 was 4882, checked in by Nicklas Nordborg, 13 years ago

References #1271: Add extension points to all toolbars

Added code for displaying extensions to all biomaterial pages.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 17.6 KB
Line 
1<%-- $Id: list_events.jsp 4882 2009-04-03 10:53:42Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Jari Hakkinen, Nicklas Nordborg, Martin Svensson
4  Copyright (C) 2007 Johan Enell
5
6  This file is part of BASE - BioArray Software Environment.
7  Available at http://base.thep.lu.se/
8
9  BASE is free software; you can redistribute it and/or
10  modify it under the terms of the GNU General Public License
11  as published by the Free Software Foundation; either version 3
12  of the License, or (at your option) any later version.
13
14  BASE is distributed in the hope that it will be useful,
15  but WITHOUT ANY WARRANTY; without even the implied warranty of
16  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  GNU General Public License for more details.
18
19  You should have received a copy of the GNU General Public License
20  along with BASE. If not, see <http://www.gnu.org/licenses/>.
21  ------------------------------------------------------------------
22
23  @author Nicklas
24  @version 2.0
25--%>
26<%@ page session="false"
27  import="net.sf.basedb.core.SessionControl"
28  import="net.sf.basedb.core.DbControl"
29  import="net.sf.basedb.core.Item"
30  import="net.sf.basedb.core.ItemContext"
31  import="net.sf.basedb.core.BioMaterialEvent"
32  import="net.sf.basedb.core.MeasuredBioMaterial"
33  import="net.sf.basedb.core.Quantity"
34  import="net.sf.basedb.core.Unit"
35  import="net.sf.basedb.core.ItemQuery"
36  import="net.sf.basedb.core.ItemResultIterator"
37  import="net.sf.basedb.core.Permission"
38  import="net.sf.basedb.core.PluginDefinition"
39  import="net.sf.basedb.core.PermissionDeniedException"
40  import="net.sf.basedb.core.query.Restrictions"
41  import="net.sf.basedb.core.query.Expressions"
42  import="net.sf.basedb.core.query.Orders"
43  import="net.sf.basedb.core.query.Hql"
44  import="net.sf.basedb.core.plugin.GuiContext"
45  import="net.sf.basedb.core.plugin.Plugin"
46  import="net.sf.basedb.util.Enumeration"
47  import="net.sf.basedb.util.units.UnitUtil"
48  import="net.sf.basedb.clients.web.Base"
49  import="net.sf.basedb.clients.web.ModeInfo"
50  import="net.sf.basedb.clients.web.PermissionUtil"
51  import="net.sf.basedb.clients.web.util.HTML"
52  import="net.sf.basedb.util.Values"
53  import="net.sf.basedb.util.formatter.Formatter"
54  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
55  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
56  import="net.sf.basedb.clients.web.extensions.JspContext"
57  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
58  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
59  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
60  import="java.util.List"
61  import="java.util.Map"
62  import="java.util.Date"
63%>
64<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
65<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
66<%@ taglib prefix="t" uri="/WEB-INF/tab.tld" %>
67<%@ taglib prefix="p" uri="/WEB-INF/path.tld" %>
68<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
69<%!
70  private static final Item itemType = Item.BIOMATERIALEVENT;
71  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
72%>
73<%
74final Item bioMaterialType = Item.valueOf(request.getParameter("biomaterial_type"));
75final int bioMaterialId = Values.getInt(request.getParameter("biomaterial_id"));
76final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
77final String ID = sc.getId();
78final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
79
80final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
81final String callback = request.getParameter("callback");
82final String title = mode.generateTitle("event", "events");
83final DbControl dc = sc.newDbControl();
84ItemResultIterator<BioMaterialEvent> events = null;
85try
86{
87  MeasuredBioMaterial bioMaterial = (MeasuredBioMaterial)bioMaterialType.getById(dc, bioMaterialId);
88  final boolean createPermission = bioMaterial.hasPermission(Permission.WRITE);
89  final boolean deletePermission = createPermission;
90
91  String viewPage = null;
92  String listName = null;
93  if (bioMaterialType == Item.SAMPLE)
94  {
95    listName = "Samples";
96    viewPage = "../samples/index.jsp";
97  }
98  else if (bioMaterialType == Item.EXTRACT)
99  {
100    listName = "Extracts";
101    viewPage = "../extracts/index.jsp";
102  }
103  else if (bioMaterialType == Item.LABELEDEXTRACT)
104  {
105    listName = "Labeled extracts";
106    viewPage = "../labeledextracts/index.jsp";
107  }
108 
109  Unit microGram = UnitUtil.getUnit(dc, Quantity.MASS, "µg");
110  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
111  try
112  {
113    final ItemQuery<BioMaterialEvent> query = Base.getConfiguredQuery(dc, cc, true, bioMaterial.getEvents(), mode);
114    // Skip the creation event
115    query.restrict(
116      Restrictions.not(
117        Restrictions.and(
118          Restrictions.eq(
119            Hql.property("eventType"),
120            Expressions.integer(BioMaterialEvent.Type.CREATION.getValue())
121          ),
122          Restrictions.eq(
123            Hql.property("bioMaterial"),
124            Hql.entity(bioMaterial)
125          )
126        )
127      )
128    );
129    events = query.iterate(dc);
130  }
131  catch (Throwable t)
132  {
133    cc.setMessage(t.getMessage());
134    t.printStackTrace();
135  }
136  int numListed = 0;
137  Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
138  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext, guiContext, bioMaterial);
139  ExtensionsInvoker invoker = ToolbarUtil.useExtensions(jspContext);
140  %>
141  <base:page title="<%=title%>" type="<%=mode.getPageType()%>">
142  <base:head scripts="table.js,tabcontrol.js" styles="table.css,headertabcontrol.css,path.css">
143    <ext:scripts context="<%=jspContext%>" />
144    <ext:stylesheets context="<%=jspContext%>" />
145    <script language="JavaScript">
146    var submitPage = 'index.jsp';
147    var formId = 'events';
148    function newItem()
149    {
150      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', 0, true, '&biomaterial_type=<%=bioMaterialType.name()%>&biomaterial_id=<%=bioMaterial.getId()%>');
151    }
152    function editItem(itemId)
153    {
154      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, true, '&biomaterial_type=<%=bioMaterialType.name()%>&biomaterial_id=<%=bioMaterial.getId()%>');
155    }
156    function viewItem(itemId)
157    {
158      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, false, '&biomaterial_type=<%=bioMaterialType.name()%>&biomaterial_id=<%=bioMaterial.getId()%>');
159    }
160    function itemOnClick(evt, itemId)
161    {
162      Table.itemOnClick(formId, evt, itemId, '<%=mode.getName()%>', viewItem, editItem, returnSelected);
163    }
164    function deleteItems()
165    {
166      var frm = document.forms[formId];
167      var numChecked = Forms.numChecked(frm);
168      if (numChecked == 0)
169      {
170        alert('Please select at least one item in the list');
171        return;
172      }
173      else
174      {
175        var rep = numChecked == 1 ? 'event' : 'events';
176        if (!confirm('You are about to delete '+numChecked+' '+rep+'. This can\'t be undone. Continue?'))
177        {
178          return;
179        }
180      }
181      frm.action = submitPage;
182      frm.cmd.value = 'DeleteItems';
183      frm.submit();
184    }
185    function configureColumns()
186    {
187      Table.configureColumns('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
188    }
189    function runPlugin(cmd)
190    {
191      Table.submitToPopup(formId, cmd, 540, 460);
192    }
193    function returnSelected()
194    {
195      Table.returnSelected(formId, <%=callback != null ? "window.opener."+callback : "null" %>);
196      window.close();
197    }
198    function presetOnChange()
199    {
200      Table.presetOnChange('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
201    }
202    function switchTab(tabControlId, tabId)
203    {
204      if (tabId == 'properties' || tabId == 'annotations' || tabId == 'overview')
205      {
206        location.href = '<%=viewPage%>?ID=<%=ID%>&cmd=ViewItem&item_id=<%=bioMaterialId%>&tab='+tabId;
207      }
208      else
209      {
210        TabControl.setActiveTab(tabControlId, tabId);
211      }
212    }
213    </script>
214  </base:head>
215 
216  <base:body>
217    <p>
218    <p:path>
219      <p:pathelement title="<%=listName%>" href="<%=viewPage+"?ID="+ID%>" />
220      <p:pathelement title="<%=HTML.encodeTags(bioMaterial.getName())%>" />
221    </p:path>
222
223    <t:tabcontrol id="main" active="events" switch="switchTab">
224    <t:tab id="properties" title="Properties" />
225    <t:tab id="annotations" title="Annotations &amp; parameters"
226      tooltip="View annotation values and protocol parameters" />
227   
228    <t:tab id="events" title="Events">
229   
230    <%
231    if (cc.getMessage() != null)
232    {
233      %>
234      <div class="error"><%=cc.getMessage()%></div>
235      <%
236      cc.setMessage(null);
237    }
238    %>
239    <tbl:table 
240      id="events" 
241      clazz="itemlist" 
242      columns="<%=cc.getSetting("columns")%>"
243      sortby="<%=cc.getSortProperty()%>" 
244      direction="<%=cc.getSortDirection()%>"
245      title="<%=title%>"
246      action="index.jsp"
247      sc="<%=sc%>"
248      item="<%=itemType%>"
249      >
250      <tbl:hidden 
251        name="mode" 
252        value="<%=mode.getName()%>" 
253      />
254      <tbl:hidden 
255        name="biomaterial_id"
256        value="<%=String.valueOf(bioMaterialId)%>" 
257      />
258      <tbl:hidden 
259        name="biomaterial_type" 
260        value="<%=bioMaterialType.name()%>" 
261      />
262      <tbl:hidden 
263        name="callback" 
264        value="<%=callback%>" 
265        skip="<%=callback == null%>" 
266      />
267      <%
268      Enumeration<String, String> eventTypes = new Enumeration<String, String>();
269      for (BioMaterialEvent.Type et : BioMaterialEvent.Type.values())
270      {
271        eventTypes.add(Integer.toString(et.getValue()), HTML.encodeTags(et.toString()));
272      }
273      %>
274      <tbl:columndef 
275        id="type"
276        property="eventType"
277        datatype="int"
278        title="Type"
279        enumeration="<%=eventTypes%>"
280        sortable="true" 
281        filterable="true"
282        exportable="true"
283        show="always" 
284      />
285      <tbl:columndef 
286        id="id"
287        clazz="uniquecol"
288        property="id"
289        datatype="int"
290        title="ID"
291        sortable="true"
292        filterable="true"
293        exportable="true"
294      />
295      <tbl:columndef 
296        id="entryDate"
297        property="entryDate"
298        datatype="date"
299        title="Entry date"
300        sortable="true" 
301        filterable="true"
302        exportable="true"
303        formatter="<%=dateFormatter%>"
304      />
305      <tbl:columndef 
306        id="eventDate"
307        property="eventDate"
308        datatype="date"
309        title="Event date"
310        sortable="true" 
311        filterable="true"
312        exportable="true"
313        formatter="<%=dateFormatter%>"
314      />
315      <tbl:columndef 
316        id="quantity"
317        datatype="float"
318        title="Used quantity (µg)"
319        sortable="false" 
320        filterable="false"
321        exportable="false"
322        unit="<%=microGram%>"
323      />
324      <tbl:columndef 
325        id="protocol"
326        property="protocol.name"
327        datatype="string"
328        title="Protocol"
329        sortable="true" 
330        filterable="true"
331        exportable="true"
332      />
333      <tbl:columndef 
334        id="user"
335        property="user.name"
336        datatype="string"
337        title="User"
338        sortable="true" 
339        filterable="true"
340        exportable="true"
341      />
342      <tbl:columndef 
343        id="comment"
344        property="comment"
345        datatype="string"
346        title="Comment" 
347        sortable="true" 
348        filterable="true" 
349        exportable="true"
350      />
351      <tbl:columndef
352        id="permission"
353        title="Permission"
354      />
355      <tbl:toolbar
356        visible="<%=mode.hasToolbar()%>"
357        >
358        <tbl:button 
359          disabled="<%=createPermission ? false : true%>" 
360          image="<%=createPermission ? "new.gif" : "new_disabled.gif"%>" 
361          onclick="newItem()" 
362          title="New&hellip;" 
363          tooltip="<%=createPermission ? "Create new event" : "You do not have permission to create events"%>" 
364        />
365        <tbl:button 
366          disabled="<%=deletePermission ? false : true%>" 
367          image="<%=deletePermission ? "delete.gif" : "delete_disabled.gif"%>" 
368          title="Delete&hellip;"
369          onclick="deleteItems()" 
370          tooltip="<%=deletePermission ? "Delete the selected events" : "You do not have permission to delete events"%>" 
371        />
372        <tbl:button 
373          image="columns.gif" 
374          onclick="configureColumns()" 
375          title="Columns&hellip;" 
376          tooltip="Show, hide and re-order columns" 
377        />
378        <tbl:button 
379          image="import.gif" 
380          onclick="runPlugin('ImportItems')" 
381          title="Import&hellip;" 
382          tooltip="Import data" 
383          visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
384        />
385        <tbl:button 
386          image="export.gif" 
387          onclick="runPlugin('ExportItems')" 
388          title="Export&hellip;" 
389          tooltip="Export data" 
390          visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
391        />
392        <tbl:button 
393          image="runplugin.gif" 
394          onclick="runPlugin('RunListPlugin')" 
395          title="Run plugin&hellip;" 
396          tooltip="Run a plugin" 
397          visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
398        />
399        <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
400          wrapper="<%=new PrefixSuffixRenderer(jspContext, "<td>", "</td>") %>"/>
401      </tbl:toolbar>
402      <tbl:navigator
403        page="<%=cc.getPage()%>" 
404        rowsperpage="<%=cc.getRowsPerPage()%>" 
405        totalrows="<%=events == null ? 0 : events.getTotalCount()%>" 
406        visible="<%=mode.hasNavigator()%>"
407      />
408      <tbl:data>
409        <tbl:columns>
410        <tbl:presetselector 
411          clazz="columnheader"
412          colspan="3"
413          onchange="presetOnChange()"
414        />
415        </tbl:columns>
416         
417        <tr>
418          <tbl:header 
419            clazz="index"
420            >&nbsp;</tbl:header>
421          <tbl:header 
422            clazz="check" 
423            visible="<%=mode.hasCheck()%>"
424            ><base:icon 
425              image="check_uncheck.gif" 
426              tooltip="Check/uncheck all" 
427              onclick="Forms.checkUncheck(document.forms[formId])" style="align: left;"
428            /></tbl:header>
429          <tbl:header 
430            clazz="check" 
431            visible="<%=mode.hasRadio()%>"
432            />
433          <tbl:header 
434            clazz="icons" 
435            visible="<%=mode.hasIcons()%>"
436            >&nbsp;</tbl:header>
437          <tbl:propertyfilter />
438        </tr>
439   
440          <tbl:rows>
441          <%
442          int index = cc.getPage()*cc.getRowsPerPage();
443          int selectedItemId = cc.getId();
444          if (events != null)
445          {
446            while (events.hasNext())
447            {
448              BioMaterialEvent item = events.next();
449              BioMaterialEvent.Type eventType = item.getEventType();
450              int itemId = item.getId();
451              String name = "TODO";
452              index++;
453              numListed++;
454              %>
455              <tbl:row>
456                <tbl:header 
457                  clazz="index"
458                  ><%=index%></tbl:header>
459                <tbl:header 
460                  clazz="check" 
461                  visible="<%=mode.hasCheck()%>"
462                  ><%
463                  if (eventType == BioMaterialEvent.Type.OTHER){%><input 
464                    type="checkbox" 
465                    name="<%=itemId%>" 
466                    value="<%=itemId%>" 
467                    title="TODO" 
468                    <%=cc.getSelected().contains(itemId) ? "checked" : ""%>
469                  ><%}%></tbl:header>
470                <tbl:header 
471                  clazz="check" 
472                  visible="<%=mode.hasRadio()%>"
473                  ><input 
474                      type="radio" 
475                      name="item_id" 
476                      value="<%=itemId%>" 
477                      title="<%=name%>" 
478                      <%=selectedItemId == itemId ? "checked" : ""%>
479                    ></tbl:header>
480                <tbl:header 
481                  clazz="icons" 
482                  visible="<%=mode.hasIcons()%>"
483                  >&nbsp;</tbl:header>
484                <tbl:cell column="type">
485                  <%
486                  if (eventType == BioMaterialEvent.Type.OTHER)
487                  {
488                    %>
489                    <div class="link" onclick="itemOnClick(event, <%=itemId%>)"><%=eventType%></div>
490                    <%
491                  }
492                  else if (eventType == BioMaterialEvent.Type.CREATION)
493                  {
494                    %>
495                    <div class="link" onclick="viewItem(<%=itemId%>)">
496                    Created: <base:propertyvalue 
497                          item="<%=item%>" 
498                          property="bioMaterial"
499                          enableEditLink="<%=false%>" 
500                          enablePropertyLink="<%=false%>"
501                        />
502                    </div>
503                    <%
504                  }
505                  else if (eventType == BioMaterialEvent.Type.HYBRIDIZATION)
506                  {
507                    %>
508                    <div class="link" onclick="viewItem(<%=itemId%>)">
509                    Hybridization: <base:propertyvalue 
510                              item="<%=item%>" 
511                              property="hybridization"
512                              enableEditLink="<%=false%>" 
513                              enablePropertyLink="<%=false%>"
514                            />
515                    </div>
516                    <%
517                  }
518                  %>
519                </tbl:cell>
520                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
521                <tbl:cell column="eventDate" value="<%=item.getEventDate()%>" />
522                <tbl:cell column="entryDate" value="<%=item.getEntryDate()%>" />
523                <tbl:cell column="quantity"><%=Values.formatNumber(item.getUsedQuantity(bioMaterial), 2)%></tbl:cell>
524                <tbl:cell column="protocol"
525                  ><base:propertyvalue 
526                    item="<%=item%>" 
527                    property="protocol"
528                    enableEditLink="<%=mode.hasEditLink()%>" 
529                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
530                  /></tbl:cell>
531                <tbl:cell column="user"
532                  ><base:propertyvalue 
533                    item="<%=item%>" 
534                    property="user"
535                    enableEditLink="<%=mode.hasEditLink()%>" 
536                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
537                  /></tbl:cell>
538                <tbl:cell column="comment"><%=HTML.encodeTags(item.getComment())%></tbl:cell>
539                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
540              </tbl:row>
541              <%
542            }
543          }
544          %>
545          </tbl:rows>
546        </tbl:data>
547      <%
548      if (numListed == 0)
549      {
550        %>
551        <tbl:panel><%=events == null || events.getTotalCount() == 0 ? "No events were found" : "No events on this page. Please select another page!" %></tbl:panel>
552        <%
553      }
554      else
555      {
556        %>
557        <tbl:navigator
558          page="<%=cc.getPage()%>" 
559          rowsperpage="<%=cc.getRowsPerPage()%>" 
560          totalrows="<%=events == null ? 0 : events.getTotalCount()%>" 
561          visible="<%=mode.hasNavigator()%>"
562          locked="true"
563        />
564        <%
565      }
566      %>
567    </tbl:table>
568    <base:buttongroup align="center">
569      <base:button onclick="returnSelected();" title="Ok" visible="<%=mode.hasOkButton()%>" />
570      <base:button onclick="window.close();" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
571      <base:button onclick="window.close();" title="Close" visible="<%=mode.hasCloseButton()%>" />
572    </base:buttongroup>
573    </t:tab>
574   
575    <t:tab id="overview" title="Overview" 
576      tooltip="Display a tree overview of related items" />
577    </t:tabcontrol>
578
579  </base:body>
580  </base:page>
581  <%
582}
583finally
584{
585  if (events != null) events.close();
586  if (dc != null) dc.close();
587}
588%>
Note: See TracBrowser for help on using the repository browser.