source: trunk/www/biomaterials/tags/list_tags.jsp @ 6335

Last change on this file since 6335 was 6335, checked in by olle, 9 years ago

Refs #1773. Support for annotatable Tag items added.

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