source: branches/3.4-stable/www/biomaterials/biosources/list_biosources.jsp @ 6780

Last change on this file since 6780 was 6780, checked in by Nicklas Nordborg, 8 years ago

Fixes #1929: Add 'none' option in annotation filters

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 19.4 KB
Line 
1<%-- $Id: list_biosources.jsp 6780 2015-03-18 06:53:09Z nicklas $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Jari Häkkinen, Nicklas Nordborg, Martin Svensson
4  Copyright (C) 2007 Johan Enell, 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 pageEncoding="UTF-8" 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.BioSource"
31  import="net.sf.basedb.core.Sample"
32  import="net.sf.basedb.core.AnnotationType"
33  import="net.sf.basedb.core.ItemSubtype"
34  import="net.sf.basedb.core.AnnotationSet"
35  import="net.sf.basedb.core.Annotation"
36  import="net.sf.basedb.core.ItemQuery"
37  import="net.sf.basedb.core.Include"
38  import="net.sf.basedb.core.ItemResultIterator"
39  import="net.sf.basedb.core.ItemResultList"
40  import="net.sf.basedb.core.ItemContext"
41  import="net.sf.basedb.core.Nameable"
42  import="net.sf.basedb.core.Permission"
43  import="net.sf.basedb.core.PluginDefinition"
44  import="net.sf.basedb.core.Type"
45  import="net.sf.basedb.core.query.Hql"
46  import="net.sf.basedb.core.query.Restrictions"
47  import="net.sf.basedb.core.query.Expressions"
48  import="net.sf.basedb.core.query.Orders"
49  import="net.sf.basedb.core.plugin.GuiContext"
50  import="net.sf.basedb.core.plugin.Plugin"
51  import="net.sf.basedb.core.snapshot.AnnotationLoaderUtil"
52  import="net.sf.basedb.core.snapshot.AnnotationTypeFilter"
53  import="net.sf.basedb.core.snapshot.AnnotationSnapshot"
54  import="net.sf.basedb.core.snapshot.AnnotationSetSnapshot"
55  import="net.sf.basedb.core.snapshot.SnapshotManager"
56  import="net.sf.basedb.util.Enumeration"
57  import="net.sf.basedb.util.ShareableUtil"
58  import="net.sf.basedb.clients.web.Base"
59  import="net.sf.basedb.clients.web.ModeInfo"
60  import="net.sf.basedb.clients.web.PermissionUtil"
61  import="net.sf.basedb.clients.web.util.HTML"
62  import="net.sf.basedb.util.formatter.Formatter"
63  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
64  import="net.sf.basedb.clients.web.extensions.ExtensionsControl"
65  import="net.sf.basedb.clients.web.extensions.JspContext"
66  import="net.sf.basedb.clients.web.extensions.renderer.PrefixSuffixRenderer"
67  import="net.sf.basedb.clients.web.extensions.toolbar.ToolbarUtil"
68  import="net.sf.basedb.clients.web.extensions.list.ListColumnUtil"
69  import="net.sf.basedb.util.extensions.ExtensionsInvoker"
70  import="net.sf.basedb.util.Values"
71  import="java.util.Iterator"
72  import="java.util.Date"
73  import="java.util.List"
74  import="java.util.Map"
75  import="java.util.ArrayList"
76%>
77<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
78<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
79<%@ taglib prefix="ext" uri="/WEB-INF/extensions.tld" %>
80<%!
81  private static final Item itemType = Item.BIOSOURCE;
82  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
83%>
84<%
85final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
86final String ID = sc.getId();
87final boolean createPermission = sc.hasPermission(Permission.CREATE, itemType);
88final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
89
90final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
91final String callback = request.getParameter("callback");
92final String title = mode.generateTitle("biosource", "biosources");
93final DbControl dc = sc.newDbControl();
94ItemResultIterator<BioSource> bioSources = null;
95List<AnnotationLoaderUtil> annotationLoaders = new ArrayList<AnnotationLoaderUtil>();
96try
97{
98  final ItemQuery<AnnotationType> annotationTypeQuery = Base.getAnnotationTypesQuery(itemType);
99  SnapshotManager manager = new SnapshotManager();
100  for (AnnotationType at : annotationTypeQuery.list(dc))
101  {
102    annotationLoaders.add(new AnnotationLoaderUtil(dc, manager, at));
103  }
104  final ItemQuery<ItemSubtype> subtypesQuery = Base.getSubtypesQuery(itemType);
105
106  final ItemQuery<Sample> sampleQuery = Sample.getQuery();
107  sampleQuery.include(cc.getInclude());
108  sampleQuery.restrict(Restrictions.eq(Hql.property("parent"), Expressions.parameter("bioSource")));
109  sampleQuery.order(Orders.asc(Hql.property("name")));
110  final boolean createSamplePermission = sc.hasPermission(Permission.CREATE, Item.SAMPLE);
111
112  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
113  try
114  {
115    final ItemQuery<BioSource> query = Base.getConfiguredQuery(dc, cc, true, BioSource.getQuery(), mode);
116    bioSources = query.iterate(dc);
117  }
118  catch (Throwable t)
119  {
120    cc.setMessage(t.getMessage());
121    t.printStackTrace();
122  }
123  int numListed = 0;
124  Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
125  JspContext jspContext = ExtensionsControl.createContext(dc, pageContext, guiContext, null);
126  ExtensionsInvoker invoker = ToolbarUtil.useExtensions(jspContext);
127  ExtensionsInvoker columnsInvoker = ListColumnUtil.useExtensions(jspContext);
128  %>
129  <base:page title="<%=title==null ? "Biosources" : title%>" type="<%=mode.getPageType()%>" id="list-page">
130  <base:head scripts="table.js,~biosources.js" styles="table.css,toolbar.css">
131    <ext:scripts context="<%=jspContext%>" />
132    <ext:stylesheets context="<%=jspContext%>" />
133  </base:head>
134 
135  <base:body >
136    <h1><%=title==null ? "Biosources" : title%></h1>
137    <div class="content">
138      <tbl:table 
139        id="biosources" 
140        columns="<%=cc.getSetting("columns")%>"
141        sortby="<%=cc.getSortProperty()%>" 
142        direction="<%=cc.getSortDirection()%>"
143        action="index.jsp"
144        sc="<%=sc%>"
145        item="<%=itemType%>"
146        subclass="fulltable"
147      >
148      <tbl:hidden 
149        name="mode" 
150        value="<%=mode.getName()%>" 
151      />
152      <tbl:hidden 
153        name="callback" 
154        value="<%=callback%>" 
155        skip="<%=callback == null%>" 
156      />
157      <tbl:columndef 
158        id="name"
159        property="name"
160        datatype="string"
161        title="Name"
162        sortable="true" 
163        filterable="true"
164        exportable="true"
165        show="always" 
166      />
167      <tbl:columndef 
168        id="itemSubtype"
169        property="itemSubtype"
170        sortproperty="itemSubtype.name"
171        exportproperty="itemSubtype.name:string"
172        datatype="int"
173        enumeration="<%=Enumeration.fromItems(subtypesQuery.list(dc), "-none-")%>"
174        title="Type"
175        sortable="true" 
176        filterable="true"
177        exportable="true"
178      />
179      <tbl:columndef 
180         id="id"
181        clazz="uniquecol"
182         property="id"
183         datatype="int"
184         title="ID"
185         sortable="true" 
186         filterable="true"
187         exportable="true"
188      />
189      <tbl:columndef 
190        id="externalId"
191        property="externalId"
192        datatype="string"
193        title="External id"
194        sortable="true" 
195        filterable="true"
196        exportable="true"
197      />
198      <tbl:columndef 
199        id="entryDate"
200        property="entryDate"
201        datatype="date"
202        title="Registered"
203        sortable="true" 
204        filterable="true"
205        exportable="true"
206        formatter="<%=dateFormatter%>"
207      />
208      <tbl:columndef
209        id="samples"
210        title="Samples"
211        property="&children(name)"
212        datatype="string"
213        filterable="true"
214        exportable="true"
215      />
216      <tbl:columndef 
217        id="owner"
218        property="owner.name"
219        datatype="string"
220        title="Owner"
221        sortable="true" 
222        filterable="true"
223        exportable="true"
224      />
225      <tbl:columndef 
226        id="description"
227        property="description"
228        datatype="string"
229        title="Description" 
230        sortable="true" 
231        filterable="true" subclass="foobar"
232        exportable="true"
233      />     
234      <tbl:columndef
235        id="bioMaterialList"
236        property="@bioMaterialLists"
237        datatype="int"
238        title="Biomaterial list"
239        filterable="true" 
240        enumeration="<%=Base.getBioMaterialListsEnum(dc, itemType, cc.getInclude())%>"
241        multiple="false"
242      />
243      <%
244      for (AnnotationLoaderUtil loader : annotationLoaders)
245      {
246        AnnotationType at = loader.getAnnotationType();
247        Enumeration<String, String> annotationEnum = null;
248        Formatter formatter = FormatterFactory.getTypeFormatter(sc, at.getValueType());
249        if (at.isEnumeration())
250        {
251          annotationEnum = new Enumeration<String, String>();
252          if (!at.getDisplayAsList()) annotationEnum.add("", "-none-");
253          List<?> values = at.getValues();
254          for (Object value : values)
255          {
256            String encoded = formatter.format(value);
257            annotationEnum.add(encoded, encoded);
258          }
259        }
260        %>
261        <tbl:columndef 
262          id="<%="at"+at.getId()%>"
263          title="<%=HTML.encodeTags(at.getName())+" [A]"%>" 
264          property="<%="#"+at.getId()%>"
265          annotation="true"
266          datatype="<%=at.getValueType().getStringValue()%>"
267          enumeration="<%=annotationEnum%>"
268          smartenum="<%=at.getDisplayAsList() %>"
269          sortable="<%=at.getMultiplicity() == 1%>" 
270          filterable="true" 
271          exportable="true"
272          formatter="<%=formatter%>"
273          unit="<%=at.getDefaultUnit()%>"
274        />
275        <%
276      }
277      %>
278      <tbl:columndef
279        id="permission"
280        title="Permission"
281      />
282      <tbl:columndef
283        id="sharedTo"
284        title="Shared to"
285        filterable="true"
286        filterproperty="!sharedTo.name"
287        datatype="string"
288      />
289      <tbl:columndef 
290        id="xt-columns" 
291        extensions="<%=columnsInvoker%>" 
292        jspcontext="<%=jspContext%>" 
293      />
294      <div class="panelgroup bg-filled-50 bottomborder">
295        <tbl:toolbar
296          visible="<%=mode.hasToolbar()%>"
297          subclass="bottomborder"
298          >
299          <tbl:button 
300            id="btnNewItem"
301            disabled="<%=!createPermission%>" 
302            image="new.png" 
303            title="New&hellip;" 
304            tooltip="<%=createPermission ? "Create new biosource" : "You do not have permission to create biosources"%>" 
305          />
306          <tbl:button 
307            id="btnDeleteItems"
308            image="delete.png"
309            title="Delete" 
310            tooltip="Delete the selected items" 
311          />
312          <tbl:button 
313            id="btnRestoreItems"
314            image="restore.png"
315            title="Restore" 
316            tooltip="Restore the selected (deleted) items"
317          />
318          <tbl:button 
319            id="btnShareItems"
320            image="share.png"
321            title="Share&hellip;" 
322            tooltip="Share the selected items"
323          />
324          <tbl:button 
325            id="btnSetOwner"
326            image="take_ownership.png"
327            title="Set owner&hellip;"
328            tooltip="Change owner of the selected items"
329          />
330          <tbl:button 
331            id="btnColumns"
332            image="columns.png" 
333            title="Columns&hellip;" 
334            tooltip="Show, hide and re-order columns" 
335          />
336          <tbl:button
337            id="btnNewBioMaterialList"
338            image="add.png"
339            title="New biomaterial list&hellip;"
340            tooltip="Create a new biomaterial list from matching biosources"
341            visible="<%=sc.hasPermission(Permission.CREATE, Item.BIOMATERIALLIST)%>"
342          />
343          <tbl:button 
344            id="btnImport"
345            data-plugin-type="IMPORT"
346            image="import.png" 
347            title="Import&hellip;" 
348            tooltip="Import data" 
349            visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
350          />
351          <tbl:button 
352            id="btnExport"
353            data-plugin-type="EXPORT"
354            image="export.png" 
355            title="Export&hellip;" 
356            tooltip="Export data" 
357            visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
358          />
359          <tbl:button 
360            id="btnRunPlugin"
361            data-plugin-type="OTHER"
362            image="runplugin.png" 
363            title="Run plugin&hellip;" 
364            tooltip="Run a plugin" 
365            visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
366          />
367          <ext:render extensions="<%=invoker%>" context="<%=jspContext%>" 
368            wrapper="<%=new PrefixSuffixRenderer(jspContext, "<td>", "</td>") %>"/>
369        </tbl:toolbar>
370        <tbl:panel>
371          <tbl:presetselector />
372          <tbl:navigator
373            page="<%=cc.getPage()%>" 
374            rowsperpage="<%=cc.getRowsPerPage()%>" 
375            totalrows="<%=bioSources == null ? 0 : bioSources.getTotalCount()%>" 
376            visible="<%=mode.hasNavigator()%>"
377          />
378        </tbl:panel>
379      </div>
380      <tbl:data>
381        <tbl:headers>
382          <tbl:headerrow>
383            <tbl:header colspan="3" />
384            <tbl:columnheaders />
385          </tbl:headerrow>
386          <tbl:headerrow>
387            <tbl:header subclass="index" />
388            <tbl:header 
389              subclass="check" 
390              visible="<%=mode.hasCheck()%>"
391              ><base:icon 
392                id="check.uncheck"
393                image="check_uncheck.png" 
394                tooltip="Check/uncheck all" 
395              /></tbl:header>
396            <tbl:header 
397              subclass="check" 
398              visible="<%=mode.hasRadio()%>"
399              />
400            <tbl:header 
401              subclass="icons" 
402              visible="<%=mode.hasIcons()%>"
403              />
404            <tbl:propertyfilter />
405          </tbl:headerrow>
406        </tbl:headers>
407        <tbl:rows>
408          <%
409          if (cc.getMessage() != null)
410          {
411            %>
412            <tbl:panel subclass="bg-filled-50">
413              <div class="messagecontainer error"><%=cc.getMessage()%></div>
414            </tbl:panel>
415            <%
416            cc.setMessage(null);
417          }
418          int index = cc.getPage()*cc.getRowsPerPage();
419          int selectedItemId = cc.getId();
420          if (bioSources != null)
421          {           
422            while (bioSources.hasNext())
423            {
424              BioSource item = bioSources.next();
425              int itemId = item.getId();
426              boolean usePermission = item.hasPermission(Permission.USE);
427             
428             
429              boolean deletePermission = item.hasPermission(Permission.DELETE);
430              boolean sharePermission = item.hasPermission(Permission.SET_PERMISSION);
431              boolean writePermission = item.hasPermission(Permission.WRITE);
432              String tooltip = mode.isSelectionMode() ? 
433                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : "");
434              String name = HTML.encodeTags(item.getName());
435              index++;
436              numListed++;
437              %>
438              <tbl:row>
439                <tbl:header 
440                  clazz="index"
441                  ><%=index%></tbl:header>
442                <tbl:header 
443                  clazz="check" 
444                  visible="<%=mode.hasCheck()%>"
445                  ><input 
446                    type="checkbox" 
447                    name="<%=itemId%>" 
448                    value="<%=itemId%>" 
449                    title="<%=name%>" 
450                    <%=cc.getSelected().contains(itemId) ? "checked" : ""%> 
451                  ></tbl:header>
452                <tbl:header 
453                  clazz="check" 
454                  visible="<%=mode.hasRadio()%>"
455                  ><input 
456                    type="radio" 
457                    name="item_id" 
458                    value="<%=itemId%>" 
459                    title="<%=name%>" 
460                    <%=selectedItemId == itemId ? "checked" : ""%>
461                  ></tbl:header>
462                <tbl:header 
463                  clazz="icons" 
464                  visible="<%=mode.hasIcons()%>"
465                  ><base:icon 
466                    image="deleted.png"
467                    id="<%="delete."+itemId %>"
468                    subclass="<%=deletePermission ? "table-delete-item" : null %>"
469                    data-item-id="<%=itemId%>"
470                    tooltip="This item has been scheduled for deletion" 
471                    visible="<%=item.isRemoved()%>"
472                  /><base:icon 
473                    image="shared.png" 
474                    id="<%="share."+itemId %>"
475                    subclass="<%=sharePermission ? "table-share-item" : null %>"
476                    data-item-id="<%=itemId%>"
477                    tooltip="This item is shared to other users, groups and/or projects" 
478                    visible="<%=item.isShared()%>"
479                  />&nbsp;</tbl:header>
480                <tbl:cell column="name"><div 
481                  class="link table-item"
482                  data-item-id="<%=itemId%>"
483                  data-no-edit="<%=writePermission ? 0 : 1 %>" 
484                  tabindex="0"
485                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
486                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
487                <tbl:cell column="itemSubtype"><base:propertyvalue 
488                    item="<%=item%>" 
489                    property="itemSubtype"
490                    enableEditLink="<%=mode.hasEditLink()%>" 
491                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
492                  /></tbl:cell>
493                <tbl:cell column="externalId"><%=HTML.encodeTags(item.getExternalId())%></tbl:cell>
494                <tbl:cell column="samples">
495                  <%
496                  sampleQuery.setParameter("bioSource", itemId, Type.INT);
497                  try
498                  {
499                    String separator = "";
500                    for (Sample s : sampleQuery.list(dc))
501                    {
502                      out.write(separator);
503                      if (mode.hasPropertyLink())
504                      {
505                        out.write(Base.getLinkedName(ID, s, false, mode.hasEditLink()));
506                      }
507                      else
508                      {
509                        out.write(HTML.encodeTags(s.getName()));
510                      }
511                      separator = ", ";
512                    }
513                  }
514                  catch (Throwable t)
515                  {
516                    %>
517                    <div class="error"><%=t.getMessage()%></div>
518                    <%
519                  }
520                  %>
521                  <base:icon
522                    id="<%="newsample."+itemId%>"
523                    image="add.png" 
524                    subclass="auto-init"
525                    data-auto-init="new-sample"
526                    data-item-id="<%=itemId %>"
527                    tooltip="Create new sample" 
528                    visible="<%=mode.hasEditLink() && createSamplePermission && usePermission %>"
529                  />
530                </tbl:cell>
531                <tbl:cell column="owner"
532                  ><base:propertyvalue 
533                    item="<%=item%>" 
534                    property="owner"
535                    enableEditLink="<%=mode.hasEditLink()%>" 
536                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
537                  /></tbl:cell>
538                <tbl:cell column="entryDate" value="<%=item.getEntryDate()%>" />
539                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>               
540                <%
541                if (item.isAnnotated())
542                {
543                  AnnotationSetSnapshot snapshot = manager.getSnapshot(dc, item.getAnnotationSet().getId());
544                  for (AnnotationLoaderUtil loader : annotationLoaders)
545                  {
546                    %>
547                    <tbl:cell 
548                      column="<%="at"+loader.getId()%>"
549                      ><%
550                      if (loader.find(snapshot)) 
551                      {
552                        %><tbl:cellvalue 
553                          list="<%=loader.getValues()%>"
554                          suffix="<%=loader.getUnitSymbol()%>"
555                        /><%
556                      }
557                      %></tbl:cell>
558                    <%
559                  }
560                }
561                %>
562                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
563                <tbl:cell column="sharedTo">
564                  <%
565                  Iterator<Nameable> sharees = ShareableUtil.getSharedTo(dc, item).iterator();
566                  while(sharees.hasNext())
567                  {
568                    Nameable n = sharees.next();
569                    if (mode.hasPropertyLink())
570                    {
571                      out.write(Base.getLinkedName(ID, n, false, mode.hasEditLink()));
572                    }
573                    else
574                    {
575                      out.write(HTML.encodeTags(n.getName()));
576                    }
577                    out.write(sharees.hasNext() ? ", " : "");
578                  }
579                  %>
580                </tbl:cell>
581                <tbl:xt-cells dc="<%=dc%>" item="<%=item%>">
582                  <tbl:cell column="xt-columns" />
583                </tbl:xt-cells>
584              </tbl:row>
585              <%
586              }
587            }
588            if (numListed == 0)
589            {
590              %>
591              <tbl:panel subclass="bg-filled-50">
592                <div class="messagecontainer note">
593                <%=bioSources == null || bioSources.getTotalCount() == 0 ? "No biosources were found" : "No biosources on this page. Please select another page!" %>
594                </div>
595              </tbl:panel>
596              <%
597            }
598          %>
599        </tbl:rows>
600      </tbl:data>
601    </tbl:table>
602    </div>
603
604    <base:buttongroup subclass="dialogbuttons">
605      <base:button id="btnOk" title="Ok" visible="<%=mode.hasOkButton()%>" />
606      <base:button id="close" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
607      <base:button id="close" title="Close" visible="<%=mode.hasCloseButton()%>" />
608    </base:buttongroup>
609  </base:body>
610  </base:page>
611  <%
612}
613finally
614{
615  if (bioSources != null) bioSources.close();
616  if (dc != null) dc.close();
617}
618%>
Note: See TracBrowser for help on using the repository browser.