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