source: trunk/www/biomaterials/biosources/list_biosources.jsp @ 6701

Last change on this file since 6701 was 6701, checked in by Nicklas Nordborg, 7 years ago

References #1912: Add more filter rows in list pages

Implemented on the biomaterial list pages.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 20.1 KB
Line 
1<%-- $Id: list_biosources.jsp 6701 2015-01-30 13:14:46Z 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        filterrows="<%=cc.getFilterRows()%>"
147        subclass="fulltable"
148      >
149      <tbl:hidden 
150        name="mode" 
151        value="<%=mode.getName()%>" 
152      />
153      <tbl:hidden 
154        name="callback" 
155        value="<%=callback%>" 
156        skip="<%=callback == null%>" 
157      />
158      <tbl:columndef 
159        id="name"
160        property="name"
161        datatype="string"
162        title="Name"
163        sortable="true" 
164        filterable="true"
165        exportable="true"
166        show="always" 
167      />
168      <tbl:columndef 
169        id="itemSubtype"
170        property="itemSubtype"
171        sortproperty="itemSubtype.name"
172        exportproperty="itemSubtype.name:string"
173        datatype="int"
174        enumeration="<%=Enumeration.fromItems(subtypesQuery.list(dc), "-none-")%>"
175        title="Type"
176        sortable="true" 
177        filterable="true"
178        exportable="true"
179      />
180      <tbl:columndef 
181         id="id"
182        clazz="uniquecol"
183         property="id"
184         datatype="int"
185         title="ID"
186         sortable="true" 
187         filterable="true"
188         exportable="true"
189      />
190      <tbl:columndef 
191        id="externalId"
192        property="externalId"
193        datatype="string"
194        title="External id"
195        sortable="true" 
196        filterable="true"
197        exportable="true"
198      />
199      <tbl:columndef 
200        id="entryDate"
201        property="entryDate"
202        datatype="date"
203        title="Registered"
204        sortable="true" 
205        filterable="true"
206        exportable="true"
207        formatter="<%=dateFormatter%>"
208      />
209      <tbl:columndef
210        id="samples"
211        title="Samples"
212        property="&children(name)"
213        datatype="string"
214        filterable="true"
215        exportable="true"
216      />
217      <tbl:columndef 
218        id="owner"
219        property="owner.name"
220        datatype="string"
221        title="Owner"
222        sortable="true" 
223        filterable="true"
224        exportable="true"
225      />
226      <tbl:columndef 
227        id="description"
228        property="description"
229        datatype="string"
230        title="Description" 
231        sortable="true" 
232        filterable="true" subclass="foobar"
233        exportable="true"
234      />     
235      <tbl:columndef
236        id="bioMaterialList"
237        property="@bioMaterialLists"
238        datatype="int"
239        title="Biomaterial list"
240        filterable="true" 
241        enumeration="<%=Base.getBioMaterialListsEnum(dc, itemType, cc.getInclude())%>"
242        multiple="false"
243      />
244      <%
245      for (AnnotationLoaderUtil loader : annotationLoaders)
246      {
247        AnnotationType at = loader.getAnnotationType();
248        Enumeration<String, String> annotationEnum = null;
249        Formatter formatter = FormatterFactory.getTypeFormatter(sc, at.getValueType());
250        if (at.isEnumeration())
251        {
252          annotationEnum = new Enumeration<String, String>();
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          <%
387          int numFilters = cc.getNumPropertyFilters();
388          int numRows = cc.getFilterRows();
389          for (int filterNo = 0; filterNo < numRows; filterNo++)
390          {
391            boolean lastRow = filterNo == numRows-1;
392            %>
393            <tbl:headerrow>
394              <tbl:header subclass="index" />
395              <tbl:header 
396                subclass="check" 
397                visible="<%=mode.hasCheck()%>"
398                ><base:icon 
399                  id="check.uncheck"
400                  image="check_uncheck.png" 
401                  tooltip="Check/uncheck all" 
402                  visible="<%=lastRow%>"
403                /></tbl:header>
404              <tbl:header 
405                subclass="check" 
406                visible="<%=mode.hasRadio()%>"
407                />
408              <tbl:header 
409                subclass="icons" 
410                visible="<%=mode.hasIcons()%>"
411                >
412                <base:icon
413                  subclass="link table-filter-row-action"
414                  image="add.png"
415                  tooltip="Add extra filter row"
416                  visible="<%=lastRow%>"
417                /><base:icon
418                  subclass="link table-filter-row-action"
419                  image="remove.png"
420                  tooltip="Remove this filter row"
421                  visible="<%=numRows > 1 || numFilters > 0 %>"
422                  data-remove-row="<%=filterNo%>"
423                />
424              </tbl:header>
425              <tbl:propertyfilter row="<%=filterNo%>" />
426            </tbl:headerrow>
427            <%
428          }
429          %>
430        </tbl:headers>
431        <tbl:rows>
432          <%
433          if (cc.getMessage() != null)
434          {
435            %>
436            <tbl:panel subclass="bg-filled-50">
437              <div class="messagecontainer error"><%=cc.getMessage()%></div>
438            </tbl:panel>
439            <%
440            cc.setMessage(null);
441          }
442          int index = cc.getPage()*cc.getRowsPerPage();
443          int selectedItemId = cc.getId();
444          if (bioSources != null)
445          {           
446            while (bioSources.hasNext())
447            {
448              BioSource item = bioSources.next();
449              int itemId = item.getId();
450              boolean usePermission = item.hasPermission(Permission.USE);
451             
452             
453              boolean deletePermission = item.hasPermission(Permission.DELETE);
454              boolean sharePermission = item.hasPermission(Permission.SET_PERMISSION);
455              boolean writePermission = item.hasPermission(Permission.WRITE);
456              String tooltip = mode.isSelectionMode() ? 
457                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : "");
458              String name = HTML.encodeTags(item.getName());
459              index++;
460              numListed++;
461              %>
462              <tbl:row>
463                <tbl:header 
464                  clazz="index"
465                  ><%=index%></tbl:header>
466                <tbl:header 
467                  clazz="check" 
468                  visible="<%=mode.hasCheck()%>"
469                  ><input 
470                    type="checkbox" 
471                    name="<%=itemId%>" 
472                    value="<%=itemId%>" 
473                    title="<%=name%>" 
474                    <%=cc.getSelected().contains(itemId) ? "checked" : ""%> 
475                  ></tbl:header>
476                <tbl:header 
477                  clazz="check" 
478                  visible="<%=mode.hasRadio()%>"
479                  ><input 
480                    type="radio" 
481                    name="item_id" 
482                    value="<%=itemId%>" 
483                    title="<%=name%>" 
484                    <%=selectedItemId == itemId ? "checked" : ""%>
485                  ></tbl:header>
486                <tbl:header 
487                  clazz="icons" 
488                  visible="<%=mode.hasIcons()%>"
489                  ><base:icon 
490                    image="deleted.png"
491                    id="<%="delete."+itemId %>"
492                    subclass="<%=deletePermission ? "table-delete-item" : null %>"
493                    data-item-id="<%=itemId%>"
494                    tooltip="This item has been scheduled for deletion" 
495                    visible="<%=item.isRemoved()%>"
496                  /><base:icon 
497                    image="shared.png" 
498                    id="<%="share."+itemId %>"
499                    subclass="<%=sharePermission ? "table-share-item" : null %>"
500                    data-item-id="<%=itemId%>"
501                    tooltip="This item is shared to other users, groups and/or projects" 
502                    visible="<%=item.isShared()%>"
503                  />&nbsp;</tbl:header>
504                <tbl:cell column="name"><div 
505                  class="link table-item"
506                  data-item-id="<%=itemId%>"
507                  data-no-edit="<%=writePermission ? 0 : 1 %>" 
508                  tabindex="0"
509                  title="<%=tooltip%>"><%=name%></div></tbl:cell>
510                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
511                <tbl:cell column="itemSubtype"><base:propertyvalue 
512                    item="<%=item%>" 
513                    property="itemSubtype"
514                    enableEditLink="<%=mode.hasEditLink()%>" 
515                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
516                  /></tbl:cell>
517                <tbl:cell column="externalId"><%=HTML.encodeTags(item.getExternalId())%></tbl:cell>
518                <tbl:cell column="samples">
519                  <%
520                  sampleQuery.setParameter("bioSource", itemId, Type.INT);
521                  try
522                  {
523                    String separator = "";
524                    for (Sample s : sampleQuery.list(dc))
525                    {
526                      out.write(separator);
527                      if (mode.hasPropertyLink())
528                      {
529                        out.write(Base.getLinkedName(ID, s, false, mode.hasEditLink()));
530                      }
531                      else
532                      {
533                        out.write(HTML.encodeTags(s.getName()));
534                      }
535                      separator = ", ";
536                    }
537                  }
538                  catch (Throwable t)
539                  {
540                    %>
541                    <div class="error"><%=t.getMessage()%></div>
542                    <%
543                  }
544                  %>
545                  <base:icon
546                    id="<%="newsample."+itemId%>"
547                    image="add.png" 
548                    subclass="auto-init"
549                    data-auto-init="new-sample"
550                    data-item-id="<%=itemId %>"
551                    tooltip="Create new sample" 
552                    visible="<%=mode.hasEditLink() && createSamplePermission && usePermission %>"
553                  />
554                </tbl:cell>
555                <tbl:cell column="owner"
556                  ><base:propertyvalue 
557                    item="<%=item%>" 
558                    property="owner"
559                    enableEditLink="<%=mode.hasEditLink()%>" 
560                    enablePropertyLink="<%=mode.hasPropertyLink()%>"
561                  /></tbl:cell>
562                <tbl:cell column="entryDate" value="<%=item.getEntryDate()%>" />
563                <tbl:cell column="description"><%=HTML.encodeTags(item.getDescription())%></tbl:cell>               
564                <%
565                if (item.isAnnotated())
566                {
567                  AnnotationSetSnapshot snapshot = manager.getSnapshot(dc, item.getAnnotationSet().getId());
568                  for (AnnotationLoaderUtil loader : annotationLoaders)
569                  {
570                    if (loader.find(snapshot))
571                    {
572                      %>
573                      <tbl:cell 
574                        column="<%="at"+loader.getId()%>"
575                        ><tbl:cellvalue 
576                          list="<%=loader.getValues()%>"
577                          suffix="<%=loader.getUnitSymbol()%>"
578                      /></tbl:cell>
579                      <%
580                    }
581                  }
582                }
583                %>
584                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
585                <tbl:cell column="sharedTo">
586                  <%
587                  Iterator<Nameable> sharees = ShareableUtil.getSharedTo(dc, item).iterator();
588                  while(sharees.hasNext())
589                  {
590                    Nameable n = sharees.next();
591                    if (mode.hasPropertyLink())
592                    {
593                      out.write(Base.getLinkedName(ID, n, false, mode.hasEditLink()));
594                    }
595                    else
596                    {
597                      out.write(HTML.encodeTags(n.getName()));
598                    }
599                    out.write(sharees.hasNext() ? ", " : "");
600                  }
601                  %>
602                </tbl:cell>
603                <tbl:xt-cells dc="<%=dc%>" item="<%=item%>">
604                  <tbl:cell column="xt-columns" />
605                </tbl:xt-cells>
606              </tbl:row>
607              <%
608              }
609            }
610            if (numListed == 0)
611            {
612              %>
613              <tbl:panel subclass="bg-filled-50">
614                <div class="messagecontainer note">
615                <%=bioSources == null || bioSources.getTotalCount() == 0 ? "No biosources were found" : "No biosources on this page. Please select another page!" %>
616                </div>
617              </tbl:panel>
618              <%
619            }
620          %>
621        </tbl:rows>
622      </tbl:data>
623    </tbl:table>
624    </div>
625
626    <base:buttongroup subclass="dialogbuttons">
627      <base:button id="btnOk" title="Ok" visible="<%=mode.hasOkButton()%>" />
628      <base:button id="close" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
629      <base:button id="close" title="Close" visible="<%=mode.hasCloseButton()%>" />
630    </base:buttongroup>
631  </base:body>
632  </base:page>
633  <%
634}
635finally
636{
637  if (bioSources != null) bioSources.close();
638  if (dc != null) dc.close();
639}
640%>
Note: See TracBrowser for help on using the repository browser.