source: trunk/www/biomaterials/samples/view_sample.jsp @ 4611

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

References #1092: Add listing of child items that are the same type as the parent

Fixed incorrect label.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 19.9 KB
Line 
1<%-- $Id: view_sample.jsp 4611 2008-10-28 13:50:12Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Johan Enell, Jari Hakkinen, Nicklas Nordborg, Martin Svensson
4  Copyright (C) 2007 Martin Svensson
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.SystemItems"
30  import="net.sf.basedb.core.Extract"
31  import="net.sf.basedb.core.Item"
32  import="net.sf.basedb.core.ItemContext"
33  import="net.sf.basedb.core.Permission"
34  import="net.sf.basedb.core.Sample"
35  import="net.sf.basedb.core.BioSource"
36  import="net.sf.basedb.core.BioMaterialEvent"
37  import="net.sf.basedb.core.Protocol"
38  import="net.sf.basedb.core.User"
39  import="net.sf.basedb.core.Group"
40  import="net.sf.basedb.core.ItemProxy"
41  import="net.sf.basedb.core.ItemQuery"
42  import="net.sf.basedb.core.ItemResultIterator"
43  import="net.sf.basedb.core.ItemResultList"
44  import="net.sf.basedb.core.Include"
45  import="net.sf.basedb.core.MultiPermissions"
46  import="net.sf.basedb.core.query.Orders"
47  import="net.sf.basedb.core.query.Hql"
48  import="net.sf.basedb.core.PermissionDeniedException"
49  import="net.sf.basedb.core.PluginDefinition"
50  import="net.sf.basedb.core.plugin.GuiContext"
51  import="net.sf.basedb.core.plugin.Plugin"
52  import="net.sf.basedb.core.Project"
53  import="net.sf.basedb.clients.web.Base"
54  import="net.sf.basedb.clients.web.PermissionUtil"
55  import="net.sf.basedb.clients.web.util.HTML"
56  import="net.sf.basedb.util.Values"
57  import="net.sf.basedb.util.formatter.Formatter"
58  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
59  import="java.util.ArrayList"
60  import="java.util.Collections"
61  import="java.util.Date"
62  import="java.util.Map"
63  import="java.util.Set"
64  import="java.util.List"
65%>
66<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
67<%@ taglib prefix="t" uri="/WEB-INF/tab.tld" %>
68<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
69<%@ taglib prefix="p" uri="/WEB-INF/path.tld" %>
70<%!
71  private static final Item itemType = Item.SAMPLE;
72  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.ITEM);
73%>
74<%
75final SessionControl sc = Base.getExistingSessionControl(pageContext, true);
76final String ID = sc.getId();
77final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
78final int itemId = cc.getId();
79final String tab = Values.getString(request.getParameter("tab"), "properties");
80final float scale = Base.getScale(sc);
81final DbControl dc = sc.newDbControl();
82try
83{
84  Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
85  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
86
87  String title = null;
88  Sample sample = Sample.getById(dc, itemId);
89  BioMaterialEvent creationEvent = sample.getCreationEvent();
90 
91  final boolean usePermission = sample.hasPermission(Permission.USE);
92  final boolean writePermission = sample.hasPermission(Permission.WRITE);
93  final boolean deletePermission = sample.hasPermission(Permission.DELETE);
94  final boolean sharePermission = sample.hasPermission(Permission.SET_PERMISSION);
95  final boolean setOwnerPermission = sample.hasPermission(Permission.SET_OWNER);
96  final boolean isRemoved = sample.isRemoved();
97  final boolean isUsed = isRemoved && sample.isUsed();
98  final boolean deletePermanentlyPermission = deletePermission && !isUsed;
99  final boolean isOwner = sample.isOwner();
100  %>
101
102  <base:page title="<%=title%>">
103  <base:head scripts="table.js,tabcontrol.js" styles="table.css,toolbar.css,headertabcontrol.css,path.css">
104    <script language="JavaScript">
105    function editItem()
106    {
107      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', <%=itemId%>, true);
108    }
109    function shareItem()
110    {
111      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=ShareItem&item_id=<%=itemId%>', 'ShareSample', 600, 400);
112    }
113    function newExtract()
114    {
115      Main.viewOrEditItem('<%=ID%>', 'EXTRACT', 0, true, '&sample_id=<%=itemId%>');
116    }
117    function deleteItem()
118    {
119      location.replace('index.jsp?ID=<%=ID%>&cmd=DeleteItem&item_id=<%=itemId%>');
120    }
121    function restoreItem()
122    {
123      location.replace('index.jsp?ID=<%=ID%>&cmd=RestoreItem&item_id=<%=itemId%>');
124    }
125    function deleteItemPermanently()
126    {
127      Main.deleteItemPermanently('<%=ID%>', true, '<%=itemType.name()%>', <%=itemId%>, '&callback=itemDeleted');
128    }
129    function itemDeleted()
130    {
131      Main.listItems('<%=ID%>', '<%=itemType.name()%>');
132    }
133    function showUsingItems()
134    {
135      Main.showUsingItems('<%=ID%>', '<%=itemType.name()%>', <%=itemId%>);
136    }
137    function setOwner()
138    {
139      Main.openPopup('index.jsp?ID=<%=ID%>&cmd=SetOwnerOfItem&item_id=<%=itemId%>', 'SetOwnerOfItem', 450, 150);
140    }
141    function runPlugin(cmd)
142    {
143      Main.openPopup('index.jsp?ID=<%=ID%>&cmd='+cmd+'&item_id=<%=itemId%>', 'RunPlugin'+cmd, 740, 540);
144    }
145    function viewEvents()
146    {
147      location.href = '../events/index.jsp?ID=<%=ID%>&cmd=List&biomaterial_id=<%=itemId%>&biomaterial_type=<%=itemType.name()%>';
148    }
149    function switchTab(tabControlId, tabId)
150    {
151      if (tabId == 'events')
152      {
153        viewEvents();
154      }
155      else
156      {
157        TabControl.setActiveTab(tabControlId, tabId);
158      }
159    }
160    </script>
161  </base:head>
162  <base:body>
163    <p>
164    <p:path>
165      <p:pathelement title="Samples" href="<%="index.jsp?ID="+ID%>" />
166      <p:pathelement title="<%=HTML.encodeTags(sample.getName())%>" />
167    </p:path>
168   
169    <t:tabcontrol id="main" active="<%=tab%>" switch="switchTab">
170    <t:tab id="properties" title="Properties">
171
172    <tbl:toolbar
173      >
174      <tbl:button 
175        disabled="<%=writePermission ? false : true%>" 
176        image="<%=writePermission ? "edit.gif" : "edit_disabled.gif"%>" 
177        onclick="editItem()" 
178        title="Edit&hellip;" 
179        tooltip="<%=writePermission ? "Edit this sample" : "You do not have permission to edit this sample"%>" 
180      />
181      <tbl:button 
182        disabled="<%=deletePermission ? false : true%>" 
183        image="<%=deletePermission ? "delete.gif" : "delete_disabled.gif"%>" 
184        onclick="deleteItem()" 
185        title="Delete"
186        visible="<%=!sample.isRemoved()%>"
187        tooltip="<%=deletePermission ? "Delete this sample" : "You do not have permission to delete this sample"%>" 
188      />
189      <tbl:button 
190        disabled="<%=writePermission ? false : true%>" 
191        image="<%=writePermission ? "restore.gif" : "restore_disabled.gif"%>" 
192        onclick="restoreItem()" 
193        title="Restore"
194        visible="<%=sample.isRemoved()%>"
195        tooltip="<%=writePermission ? "Restore this sample" : "You do not have permission to restore this sample"%>" 
196      />
197      <tbl:button 
198        disabled="<%=sharePermission ? false : true%>"
199        image="<%=sharePermission ? "share.gif" : "share_disabled.gif"%>"
200        onclick="shareItem()" 
201        title="Share&hellip;" 
202        tooltip="<%=sharePermission ? "Share this sample to other user, groups and projects" : "You do not have permission to share this sample"%>"
203      />
204      <tbl:button 
205        disabled="<%=setOwnerPermission ? false : true%>"
206        image="<%=setOwnerPermission ? "take_ownership.png" : "take_ownership_disabled.png"%>"
207        onclick="setOwner()" 
208        title="Set owner&hellip;"
209        tooltip="<%=setOwnerPermission ? "Change owner of this item" : "You do not have permission to change ownership of this item"%>"
210      />
211      <tbl:button
212        image="add.png"
213        onclick="newExtract()"
214        title="New extract&hellip;"
215        tooltip="Create a new extract from this sample"
216        visible="<%=sc.hasPermission(Permission.CREATE, Item.EXTRACT) && usePermission%>"
217      />
218      <tbl:button 
219        image="import.gif" 
220        onclick="runPlugin('ImportItem')" 
221        title="Import&hellip;" 
222        tooltip="Import data" 
223        visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
224      />
225      <tbl:button 
226        image="export.gif" 
227        onclick="runPlugin('ExportItem')" 
228        title="Export&hellip;" 
229        tooltip="Export data" 
230        visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
231      />
232      <tbl:button 
233        image="runplugin.gif" 
234        onclick="runPlugin('RunPlugin')" 
235        title="Run plugin&hellip;" 
236        tooltip="Run a plugin" 
237        visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
238      /> 
239      <tbl:button
240        image="help.gif"
241        onclick="<%="Main.openHelp('" + ID +"', 'sample.view.properties')"%>"
242        title="Help&hellip;"
243        tooltip="Get help about this page"
244      />   
245      </tbl:toolbar>
246    <div class="boxedbottom">
247      <div class="itemstatus">Permissions on this item: <i><%=PermissionUtil.getFullPermissionNames(sample)%></i></div>
248      <%
249      if (sample.isRemoved() || sample.isShared())
250      {
251        %>
252        <div class="itemstatus">
253          <base:icon 
254            image="<%=deletePermanentlyPermission ? "deleted.gif" : "deleted_disabled.gif"%>"
255            onclick="<%=deletePermanentlyPermission ? "deleteItemPermanently()" : null%>"
256            tooltip="<%=deletePermanentlyPermission ? "Permanently delete this item" : null%>"
257            visible="<%=isRemoved%>"> This item has been flagged for deletion<br></base:icon>
258          <base:icon image="used.gif" 
259            onclick="showUsingItems()"
260            tooltip="Show the items that are using this one"
261            visible="<%=isUsed%>"> This item is used by other items and can't be permanently deleted<br></base:icon>
262          <base:icon image="shared.gif" 
263            visible="<%=sample.isShared()%>"> This item is shared to other users, groups and/or projects</base:icon>
264        </div>
265        <%
266      }
267      %>
268      <table class="form" cellspacing="0">
269      <tr>
270        <td class="prompt">Name</td>
271        <td><%=HTML.encodeTags(sample.getName())%></td>
272      </tr>
273      <tr>
274        <td class="prompt">External ID</td>
275        <td><%=HTML.encodeTags(sample.getExternalId())%></td>
276      </tr>
277      <tr>
278        <td class="prompt">Created</td>
279        <td><%=dateFormatter.format(creationEvent.getEventDate())%></td>
280      </tr>
281      <tr>
282        <td class="prompt">Registered</td>
283        <td><%=dateFormatter.format(creationEvent.getEntryDate())%></td>
284      </tr>
285      <%
286      if (!sample.isPooled())
287      {
288        %>
289        <tr>
290          <td class="prompt">Biosource</td>
291          <td><base:propertyvalue item="<%=sample%>" property="parent" /></td>
292        </tr>
293        <%
294      }
295      %>
296      <tr>
297        <td class="prompt">Protocol</td>
298        <td><base:propertyvalue item="<%=creationEvent%>" property="protocol" /></td>
299      </tr>
300      <tr>
301        <td class="prompt">Original quantity</td>
302        <td><%=Values.formatNumber(sample.getOriginalQuantity(), 2, " µg")%></td>
303      </tr>
304      <tr>
305        <td class="prompt">Remaining quantity</td>
306        <td><%=Values.formatNumber(sample.getRemainingQuantity(), 2, " µg")%></td>
307      </tr>
308      <tr>
309        <td class="prompt">Owner</td>
310        <td><base:propertyvalue item="<%=sample%>" property="owner" /></td>
311      </tr>
312      <tr valign="baseline">
313        <td class="prompt">Description</td>
314        <td><%=HTML.niceFormat(sample.getDescription())%></td>
315      </tr>
316      </table>
317 
318      <%
319      if (sample.isPooled())
320      {
321        ItemQuery<Sample> samplesQuery = (ItemQuery<Sample>)creationEvent.getSources();
322        samplesQuery.include(Include.ALL);
323        samplesQuery.order(Orders.asc(Hql.property("name")));
324        ItemResultList<Sample> samples = samplesQuery.list(dc);
325        %>
326        <h4 class="docked">Pooled from samples</h4>
327        <tbl:table
328          id="pooled"
329          clazz="itemlist"
330          columns="all"
331          >
332        <tbl:columndef 
333          id="name"
334          title="Name"
335        />
336        <tbl:columndef 
337          id="quantity"
338          title="Used quantity (µg)"
339        />
340        <tbl:columndef 
341          id="description"
342          title="Description"
343        />
344        <tbl:data>
345          <tbl:columns>
346          </tbl:columns>
347          <tbl:rows>
348          <%
349          for (Sample item : samples)
350          {
351            %>
352            <tbl:row>
353              <tbl:cell column="name"><base:icon 
354                  image="deleted.gif" 
355                  tooltip="This item has been scheduled for deletion" 
356                  visible="<%=item.isRemoved()%>"
357                /><%=Base.getLinkedName(ID, item, false, true)%></tbl:cell>
358              <tbl:cell column="quantity"><%=Values.formatNumber(creationEvent.getUsedQuantity(item), 2)%></tbl:cell>
359              <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>
360            </tbl:row>
361            <%
362          }
363          %>
364          </tbl:rows>
365        </tbl:data>
366        </tbl:table>
367        <%
368      }
369     
370      // Samples this item is pooled in.
371      ItemQuery<BioMaterialEvent> poolingQuery = sample.getPoolingEvents();
372      ItemResultList<BioMaterialEvent> poolingEvents = poolingQuery.list(dc);
373      if (poolingEvents.size() == 0)
374      {
375        %>
376        <h4>Pooled in samples</h4>
377        No samples have been pooled from this sample
378        (or, you don't have permission to view them).
379        <%
380      }
381      else
382      {
383        %>
384        <h4 class="docked">Pooled in samples</h4>
385        <tbl:table 
386          id="poolChilds"
387          clazz="itemlist"
388          columns="all"
389          >
390          <tbl:columndef 
391            id="name"
392            title="Name"
393          />
394          <tbl:columndef 
395            id="quantity"
396            title="Original quantity (µg)"
397          />
398          <tbl:columndef 
399            id="parents"
400            title="Used samples[quantity]" 
401          />
402          <tbl:columndef 
403            id="description"
404            title="Description"
405          />
406          <tbl:data>
407            <tbl:columns></tbl:columns>
408            <tbl:rows>
409            <%
410            for (BioMaterialEvent poolingEvt : poolingEvents)
411            {
412              Sample child = (Sample)poolingEvt.getBioMaterial();
413              ItemQuery<Sample> samplesQuery = (ItemQuery<Sample>)poolingEvt.getSources();
414              samplesQuery.include(Include.ALL);
415              samplesQuery.order(Orders.asc(Hql.property("name")));
416              ItemResultList<Sample> parentSamples = samplesQuery.list(dc);
417              %>
418              <tbl:row>
419                <tbl:cell column="name">
420                  <base:icon 
421                    image="deleted.gif" 
422                    tooltip="This item has been scheduled for deletion" 
423                    visible="<%=child.isRemoved()%>"
424                  />
425                  <%=Base.getLinkedName(ID, child, false, true)%>
426                </tbl:cell>
427                <tbl:cell column="quantity"><%=Values.formatNumber(child.getOriginalQuantity(), 2)%></tbl:cell>
428                <tbl:cell column="parents">
429                <%
430                String separator = "";
431                for (Sample parent : parentSamples)
432                {
433                  out.write(separator);
434                  if (parent.equals(sample))
435                      out.write(HTML.encodeTags(parent.getName()));
436                  else                   
437                    out.write(Base.getLinkedName(ID, parent, false, true));
438                  out.write("[" + Values.formatNumber(poolingEvt.getUsedQuantity(parent), 2) + "µg]");
439                  separator = ", ";
440                }
441                %>
442                </tbl:cell>
443                <tbl:cell column="description"><%=HTML.encodeTags(child.getDescription())%></tbl:cell>
444              </tbl:row>
445              <%
446            }
447            %>           
448            </tbl:rows>
449          </tbl:data>
450        </tbl:table>
451        <%
452      }
453       
454      // Extracts created from this sample
455      ItemQuery<Extract> extractQuery = sample.getExtracts();
456      extractQuery.include(Include.ALL);
457      extractQuery.order(Orders.asc(Hql.property("name")));
458      ItemResultList<Extract> extracts = extractQuery.list(dc);
459      if (extracts.size() == 0)
460      {
461        %>
462        <h4>Extracts</h4>
463        No extracts have been created from this sample
464        (or, you don't have permission to view them).
465        <%
466      }
467      else
468      {
469        %>
470        <h4 class="docked">Extracts</h4>
471        <tbl:table
472          id="extracts"
473          clazz="itemlist"
474          columns="all"
475          >
476          <tbl:columndef
477            id="name"
478            title="Name"
479          />
480          <tbl:columndef 
481            id="quantity"
482            title="Used quantity (µg)"
483          />
484          <tbl:columndef
485            id="description"
486            title="Description"
487          />
488          <tbl:data>
489            <tbl:columns></tbl:columns>
490            <tbl:rows>
491              <%
492              for (Extract e : extracts)
493              {
494                %>
495                <tbl:row>
496                  <tbl:cell column="name"><base:icon 
497                  image="deleted.gif" 
498                  tooltip="This item has been scheduled for deletion" 
499                  visible="<%=e.isRemoved()%>"
500                /><%=Base.getLinkedName(ID, e, false, true)%></tbl:cell>
501                  <tbl:cell column="quantity"><%=Values.formatNumber(e.getCreationEvent().getUsedQuantity(sample), 2)%></tbl:cell>
502                  <tbl:cell column="description"><%=HTML.encodeTags(e.getDescription())%></tbl:cell>
503                </tbl:row>
504                <%
505              }
506              %>
507            </tbl:rows>
508          </tbl:data>
509        </tbl:table>
510        <%
511      }     
512     
513      // Tables with users/groups/projects that this item is shared to
514      MultiPermissions mp = new MultiPermissions(Collections.singleton(sample));
515      ItemResultIterator<User> users = mp.getUsers().iterate(dc);
516      ItemResultIterator<Group> groups = mp.getGroups().iterate(dc);
517      ItemResultIterator<Project> projects = mp.getProjects().iterate(dc);
518     
519      if (users.hasNext() || groups.hasNext() || projects.hasNext())
520      {
521        %>
522        <h4 class="docked">Shared to</h4>
523        <tbl:table 
524          id="itemsSharedTo"
525          clazz="itemlist"
526          columns="all"
527        >
528          <tbl:columndef 
529            id="itemType"
530            title="Item type"
531          />
532          <tbl:columndef 
533            id="name"
534            title="Name"
535          />
536          <tbl:columndef 
537            id="permissions"
538            title="Permissions"
539          />
540          <tbl:data>
541            <tbl:columns>
542            </tbl:columns>
543            <tbl:rows>
544            <%
545            while(projects.hasNext())
546            {
547              Project project = projects.next();
548              Set<Permission> permissions = mp.getPermissions(project).values().iterator().next();
549              %>     
550              <tbl:row>
551                <tbl:cell column="itemType"><%=project.getType()%></tbl:cell>
552                <tbl:cell column="name"><base:icon 
553                  image="deleted.gif" 
554                  tooltip="This item has been scheduled for deletion" 
555                  visible="<%=project.isRemoved()%>"
556                /><%=Base.getLinkedName(ID, project, false, true)%></tbl:cell>
557                <tbl:cell column="permissions">
558                  <%=PermissionUtil.translatePermissionsToString(permissions)%>
559                </tbl:cell>
560              </tbl:row>
561              <%
562            }
563            while(groups.hasNext())
564            {
565              Group group = groups.next();
566              Set<Permission> permissions = mp.getPermissions(group).values().iterator().next();
567              %>
568              <tbl:row>             
569                <tbl:cell column="itemType"><%=group.getType()%></tbl:cell>
570                <tbl:cell column="name"><base:icon 
571                  image="deleted.gif" 
572                  tooltip="This item has been scheduled for deletion" 
573                  visible="<%=group.isRemoved()%>"
574                /><%=Base.getLinkedName(ID, group, false, true)%></tbl:cell>
575                <tbl:cell column="permissions">
576                  <%=PermissionUtil.translatePermissionsToString(permissions)%>
577                </tbl:cell>
578              </tbl:row>
579              <% 
580            }
581            while (users.hasNext())
582            {
583              User user = users.next();
584              Set<Permission> permissions = mp.getPermissions(user).values().iterator().next();
585              %>
586              <tbl:row>             
587                <tbl:cell column="itemType"><%=user.getType()%></tbl:cell>
588                <tbl:cell column="name"><base:icon 
589                  image="deleted.gif" 
590                  tooltip="This item has been scheduled for deletion" 
591                  visible="<%=user.isRemoved()%>"
592                /><%=Base.getLinkedName(ID, user, false, true)%></tbl:cell>
593                <tbl:cell column="permissions">
594                  <%=PermissionUtil.translatePermissionsToString(permissions)%>
595                </tbl:cell>
596              </tbl:row>
597              <%
598            }
599            %>
600            </tbl:rows>
601          </tbl:data>
602        </tbl:table>
603        <%
604      }
605      else
606      {
607        %>
608        <h4>Shared to</h4>
609        This sample is not shared
610        (or, you don't have permission to view the ones it is shared to).
611        <%
612      }
613      %>     
614    </div>
615      </t:tab>
616     
617      <t:tab id="annotations" title="Annotations &amp; parameters" 
618        tooltip="View annotation values and protocol parameters">
619        <div class="boxed">
620        <jsp:include page="../../common/annotations/list_annotations.jsp">
621          <jsp:param name="item_type" value="<%=itemType.name()%>" />
622          <jsp:param name="item_id" value="<%=itemId%>" />
623          <jsp:param name="ID" value="<%=ID%>" />
624        </jsp:include>
625        </div>
626      </t:tab>
627     
628      <t:tab id="events" title="Events" />
629     
630      </t:tabcontrol>
631
632
633  </base:body>
634  </base:page>
635  <%
636}
637finally
638{
639  if (dc != null) dc.close();
640}
641
642%>
Note: See TracBrowser for help on using the repository browser.