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