source: trunk/www/lims/plates/wells/list_wells.jsp @ 4860

Last change on this file since 4860 was 4860, checked in by Martin Svensson, 13 years ago

References #1282 Use WellCoordinateFormatter? to view row as a character and column as a number. The filters are not updated yet.

  • Property svn:eol-style set to native
  • Property svn:keywords set to Date Id
File size: 19.4 KB
Line 
1<%-- $Id: list_wells.jsp 4860 2009-03-27 14:45:27Z martin $
2  ------------------------------------------------------------------
3  Copyright (C) 2006 Johan Enell, Jari Hakkinen, Nicklas Nordborg, Martin Svensson
4  Copyright (C) 2007 Johan Enell, Nicklas Nordborg
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 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.ItemContext"
31  import="net.sf.basedb.core.AnnotationType"
32  import="net.sf.basedb.core.AnnotationSet"
33  import="net.sf.basedb.core.Annotation"
34  import="net.sf.basedb.core.Plate"
35  import="net.sf.basedb.core.Well"
36  import="net.sf.basedb.core.ReporterType"
37  import="net.sf.basedb.core.Reporter"
38  import="net.sf.basedb.core.ItemQuery"
39  import="net.sf.basedb.core.ItemResultIterator"
40  import="net.sf.basedb.core.ItemResultList"
41  import="net.sf.basedb.core.Permission"
42  import="net.sf.basedb.core.PluginDefinition"
43  import="net.sf.basedb.core.ExtendedProperty"
44  import="net.sf.basedb.core.ExtendedProperties"
45  import="net.sf.basedb.core.PermissionDeniedException"
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.query.Hql"
50  import="net.sf.basedb.core.plugin.GuiContext"
51  import="net.sf.basedb.core.plugin.Plugin"
52  import="net.sf.basedb.core.data.ReporterData"
53  import="net.sf.basedb.util.Enumeration"
54  import="net.sf.basedb.clients.web.Base"
55  import="net.sf.basedb.clients.web.ModeInfo"
56  import="net.sf.basedb.clients.web.PermissionUtil"
57  import="net.sf.basedb.clients.web.util.HTML"
58  import="net.sf.basedb.util.Values"
59  import="net.sf.basedb.util.formatter.Formatter"
60  import="net.sf.basedb.util.formatter.WellCoordinateFormatter"
61  import="net.sf.basedb.clients.web.formatter.FormatterFactory"
62  import="java.util.List"
63  import="java.util.Map"
64  import="java.util.Date"
65%>
66<%@ taglib prefix="base" uri="/WEB-INF/base.tld" %>
67<%@ taglib prefix="tbl" uri="/WEB-INF/table.tld" %>
68<%@ taglib prefix="t" uri="/WEB-INF/tab.tld" %>
69<%@ taglib prefix="p" uri="/WEB-INF/path.tld" %>
70<%!
71  private static final Item itemType = Item.WELL;
72  private static final GuiContext guiContext = new GuiContext(itemType, GuiContext.Type.LIST);
73%>
74<%
75final int plateId = Values.getInt(request.getParameter("plate_id"));
76final SessionControl sc = Base.getExistingSessionControl(pageContext, Permission.DENIED, itemType);
77final String ID = sc.getId();
78final ItemContext cc = Base.getAndSetCurrentContext(sc, itemType, null, null);
79
80final ModeInfo mode = ModeInfo.get(request.getParameter("mode"));
81final String callback = request.getParameter("callback");
82final String title = mode.generateTitle("well", "wells");
83final DbControl dc = sc.newDbControl();
84ItemResultIterator<Well> wells = null;
85ItemResultList<AnnotationType> annotationTypes = null;
86try
87{
88  final ItemQuery<AnnotationType> annotationTypeQuery = Base.getAnnotationTypesQuery(itemType);
89  annotationTypes = annotationTypeQuery.list(dc);
90  final Plate plate = Plate.getById(dc, plateId);
91  final boolean createPermission = plate.hasPermission(Permission.WRITE);
92  final boolean deletePermission = createPermission;
93
94  Map<Plugin.MainType, Integer> pluginCount = PluginDefinition.countPlugins(dc, guiContext);
95  final ItemQuery<ReporterType> typeQuery = ReporterType.getQuery();
96  typeQuery.order(Orders.asc(Hql.property("name")));
97  typeQuery.setCacheResult(true);
98  List<ExtendedProperty> reporterProperties = ExtendedProperties.getProperties("ReporterData");
99  Formatter<Date> dateTimeFormatter = FormatterFactory.getDateTimeFormatter(sc);
100  Formatter<Date> dateFormatter = FormatterFactory.getDateFormatter(sc);
101 
102  try
103  {
104    final ItemQuery<Well> query = Base.getConfiguredQuery(dc, cc, true, plate.getWells(), mode);
105    query.join(Hql.leftJoin(null, "reporter", "rpt", null, false));
106    if (!"row".equals(cc.getSortProperty())) query.order(Orders.asc(Hql.property("row")));
107    if (!"column".equals(cc.getSortProperty())) query.order(Orders.asc(Hql.property("column")));
108    wells = query.iterate(dc);
109  }
110  catch (Throwable t)
111  {
112    cc.setMessage(t.getMessage());
113    t.printStackTrace();
114  }
115  int numListed = 0;
116  %>
117  <base:page title="<%=title%>" type="<%=mode.getPageType()%>">
118  <base:head scripts="table.js,tabcontrol.js" styles="table.css,headertabcontrol.css,path.css">
119    <script language="JavaScript">
120    var submitPage = 'index.jsp';
121    var formId = 'wells';
122    function editItem(itemId)
123    {
124      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, true);
125    }
126    function viewItem(itemId)
127    {
128      Main.viewOrEditItem('<%=ID%>', '<%=itemType.name()%>', itemId, false);
129    }
130    function itemOnClick(evt, itemId)
131    {
132      Table.itemOnClick(formId, evt, itemId, '<%=mode.getName()%>', viewItem, editItem, returnSelected);
133    }
134    function configureColumns()
135    {
136      Table.configureColumns('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
137    }
138    function runPlugin(cmd)
139    {
140      Table.submitToPopup(formId, cmd, 540, 460);
141    }
142    function returnSelected()
143    {
144      Table.returnSelected(formId, <%=callback != null ? "window.opener."+callback : "null" %>);
145      window.close();
146    }
147    function presetOnChange()
148    {
149      Table.presetOnChange('<%=ID%>', formId, '<%=itemType.name()%>', '<%=(String)cc.getObject("defaultColumns")%>');
150    }
151    function switchTab(tabControlId, tabId)
152    {
153      if (tabId == 'properties' || tabId == 'annotations')
154      {
155        location.href = '../index.jsp?ID=<%=ID%>&cmd=ViewItem&item_id=<%=plateId%>&tab='+tabId;
156      }
157      else if (tabId == 'events')
158      {
159        location.href = '../events/index.jsp?ID=<%=ID%>&plate_id=<%=plateId%>';
160      }
161      else
162      {
163        TabControl.setActiveTab(tabControlId, tabId);
164      }
165    }
166    function newReporterList()
167    {
168      Table.submitToPopup(formId, 'CreateReporterList', 540, 400);
169    }
170    </script>
171  </base:head>
172 
173  <base:body>
174    <p>
175    <p:path>
176      <p:pathelement title="Plates" href="<%="../index.jsp?ID="+ID%>" />
177      <p:pathelement title="<%=HTML.encodeTags(plate.getName())%>" />
178    </p:path>
179
180    <t:tabcontrol id="main" active="wells" switch="switchTab">
181    <t:tab id="properties" title="Properties" />
182    <t:tab id="annotations" title="Annotations" />
183    <t:tab id="events" title="Events" />
184   
185    <t:tab id="wells" title="Wells">
186   
187    <%
188    if (cc.getMessage() != null)
189    {
190      %>
191      <div class="error"><%=cc.getMessage()%></div>
192      <%
193      cc.setMessage(null);
194    }
195    %>
196    <tbl:table 
197      id="wells" 
198      clazz="itemlist" 
199      columns="<%=cc.getSetting("columns")%>"
200      sortby="<%=cc.getSortProperty()%>" 
201      direction="<%=cc.getSortDirection()%>"
202      title="<%=title%>"
203      action="index.jsp"
204      sc="<%=sc%>"
205      item="<%=itemType%>"
206      >
207      <tbl:hidden 
208        name="mode" 
209        value="<%=mode.getName()%>" 
210      />
211      <tbl:hidden 
212        name="plate_id" 
213        value="<%=String.valueOf(plateId)%>" 
214      />
215      <tbl:hidden 
216        name="callback" 
217        value="<%=callback%>" 
218        skip="<%=callback == null%>" 
219      />
220      <tbl:columndef 
221        id="row"
222        property="row"
223        datatype="int"
224        title="Row"
225        sortable="true" 
226        filterable="true"
227        exportable="true"
228        show="always"
229        formatter="<%=new WellCoordinateFormatter(true)%>" 
230      />
231      <tbl:columndef 
232        id="column"
233        property="column"
234        datatype="int"
235        title="Column"
236        sortable="true" 
237        filterable="true"
238        exportable="true"
239        show="always" 
240        formatter="<%=new WellCoordinateFormatter(false)%>" 
241      />
242      <tbl:columndef 
243        id="id"
244        clazz="uniquecol"
245        property="id"
246        datatype="int"
247        title="ID"
248        sortable="true"
249        filterable="true"
250        exportable="true"
251      />
252      <tbl:columndef 
253        id="parent"
254        title="Parent"
255      />
256      <tbl:columndef
257        id="reporterList"
258        property="$rpt.£reporterListScores"
259        datatype="int"
260        title="[Rep] Reporter list"
261        filterable="true"
262        enumeration="<%=Base.getReporterListsEnum(dc)%>"
263        multiple="false"
264      />
265      <tbl:columndef 
266        id="reporter.name"
267        property="reporter.name"
268        datatype="string"
269        title="[Rep] Name"
270        sortable="true" 
271        filterable="true"
272        exportable="true"
273      />
274      <tbl:columndef 
275        id="reporter.externalId"
276        clazz="uniquecol"
277        property="reporter.externalId"
278        datatype="string"
279        title="[Rep] ID"
280        sortable="true" 
281        filterable="true"
282        exportable="true"
283      />
284      <tbl:columndef 
285        id="reporter.symbol"
286        property="reporter.symbol"
287        datatype="string"
288        title="[Rep] Gene symbol"
289        sortable="true" 
290        filterable="true"
291        exportable="true"
292      />
293      <tbl:columndef 
294        id="reporter.description"
295        property="reporter.description"
296        datatype="string"
297        title="[Rep] Description" 
298        sortable="true" 
299        filterable="true" 
300        exportable="true"
301      />
302      <tbl:columndef 
303        id="reporter.entryDate"
304        property="reporter.entryDate"
305        datatype="date"
306        title="[Rep] Registered"
307        sortable="true" 
308        filterable="true"
309        exportable="true"
310        formatter="<%=dateFormatter%>"
311      />
312      <tbl:columndef 
313        id="reporter.lastUpdate"
314        property="reporter.lastUpdate"
315        datatype="date"
316        title="[Rep] Last update" 
317        sortable="true" 
318        filterable="true" 
319        exportable="true"
320        formatter="<%=dateTimeFormatter%>"
321      />
322      <%
323      Enumeration<String, String> types = new Enumeration<String, String>();
324      ItemResultList<ReporterType> reporterTypes = typeQuery.list(dc);
325      types.add("", "- none -");
326      for (ReporterType rt : reporterTypes)
327      {
328        types.add(Integer.toString(rt.getId()), HTML.encodeTags(rt.getName()));
329      }
330      %>
331      <tbl:columndef 
332        id="reporter.reporterType"
333        property="reporter.reporterType"
334        sortproperty="reporter.reporterType.name"
335        exportproperty="reporter.reporterType.name"
336        datatype="int"
337        enumeration="<%=types%>"
338        title="[Rep] Type"
339        sortable="true" 
340        filterable="true"
341        exportable="true"
342      />
343      <%
344      if (reporterProperties != null)
345      {
346        for (ExtendedProperty ep : reporterProperties)
347        {
348          String name = ep.getName();
349          %>
350          <tbl:columndef
351            id="<%="reporter."+name%>"
352            property="<%="reporter."+name%>"
353            datatype="<%=ep.getType().getStringValue()%>"
354            title="<%="[Rep] "+HTML.encodeTags(ep.getTitle())%>"
355            sortable="true"
356            filterable="true"
357            exportable="true"
358            formatter="<%=FormatterFactory.getExtendedPropertyFormatter(sc, ep)%>"
359          />
360          <%
361        }
362      }
363      %>
364      <%
365      for (AnnotationType at : annotationTypes)
366      {
367        Enumeration<String, String> annotationEnum = null;
368        Formatter formatter = FormatterFactory.getTypeFormatter(sc, at.getValueType());
369        if (at.isEnumeration())
370        {
371          annotationEnum = new Enumeration<String, String>();
372          List<?> values = at.getValues();
373          for (Object value : values)
374          {
375            String encoded = formatter.format(value);
376            annotationEnum.add(encoded, encoded);
377          }
378        }
379        %>
380        <tbl:columndef 
381          id="<%="at"+at.getId()%>"
382          title="<%=HTML.encodeTags(at.getName())+" [A]"%>" 
383          property="<%="#"+at.getId()%>"
384          annotation="true"
385          datatype="<%=at.getValueType().getStringValue()%>"
386          enumeration="<%=annotationEnum%>"
387          sortable="false" 
388          filterable="true" 
389          exportable="true"
390          formatter="<%=formatter%>"
391          unit="<%=at.getDefaultUnit()%>"
392        />
393        <%
394      }
395      %>
396      <tbl:columndef
397        id="permission"
398        title="Permission"
399      />
400      <tbl:toolbar
401        visible="<%=mode.hasToolbar()%>"
402        >
403        <tbl:button 
404          image="columns.gif" 
405          onclick="configureColumns()" 
406          title="Columns&hellip;" 
407          tooltip="Show, hide and re-order columns" 
408        />
409        <tbl:button
410          image="add.png"
411          onclick="newReporterList()"
412          title="New reporter list&hellip;"
413          tooltip="Create a new reporter list from matching wells"
414          visible="<%=sc.hasPermission(Permission.CREATE, Item.REPORTERLIST)%>"
415        />
416        <tbl:button 
417          image="import.gif" 
418          onclick="runPlugin('ImportItems')" 
419          title="Import&hellip;" 
420          tooltip="Import data" 
421          visible="<%=pluginCount.containsKey(Plugin.MainType.IMPORT)%>"
422        />
423        <tbl:button 
424          image="export.gif" 
425          onclick="runPlugin('ExportItems')" 
426          title="Export&hellip;" 
427          tooltip="Export data" 
428          visible="<%=pluginCount.containsKey(Plugin.MainType.EXPORT)%>"
429        />
430        <tbl:button 
431          image="runplugin.gif" 
432          onclick="runPlugin('RunListPlugin')" 
433          title="Run plugin&hellip;" 
434          tooltip="Run a plugin" 
435          visible="<%=pluginCount.containsKey(Plugin.MainType.OTHER)%>"
436        />
437      </tbl:toolbar>
438      <tbl:navigator
439        page="<%=cc.getPage()%>" 
440        rowsperpage="<%=cc.getRowsPerPage()%>" 
441        totalrows="<%=wells == null ? 0 : wells.getTotalCount()%>" 
442        visible="<%=mode.hasNavigator()%>"
443      />
444      <tbl:data>
445        <tbl:columns>
446        <tbl:presetselector 
447          clazz="columnheader"
448          colspan="3"
449          onchange="presetOnChange()"
450        />
451        </tbl:columns>
452         
453        <tr>
454          <tbl:header 
455            clazz="index"
456            >&nbsp;</tbl:header>
457          <tbl:header 
458            clazz="check" 
459            visible="<%=mode.hasCheck()%>"
460            ><base:icon 
461              image="check_uncheck.gif" 
462              tooltip="Check/uncheck all" 
463              onclick="Forms.checkUncheck(document.forms[formId])" style="align: left;"
464            /></tbl:header>
465          <tbl:header 
466            clazz="check" 
467            visible="<%=mode.hasRadio()%>"
468            />
469          <tbl:header 
470            clazz="icons" 
471            visible="<%=mode.hasIcons()%>"
472            >&nbsp;</tbl:header>
473          <tbl:propertyfilter />
474        </tr>
475   
476          <tbl:rows>
477          <%
478          int index = cc.getPage()*cc.getRowsPerPage();
479          int selectedItemId = cc.getId();
480          if (wells != null)
481          {           
482            while (wells.hasNext())
483            {
484              Well item = wells.next();
485              int itemId = item.getId();
486              boolean writePermission = item.hasPermission(Permission.WRITE);
487              String tooltip = mode.isSelectionMode() ? 
488                  "Select this item" : "View this item" + (writePermission ? " (use CTRL, ALT or SHIFT to edit)" : ""); 
489              index++;
490              numListed++;
491              %>
492              <tbl:row>
493                <tbl:header 
494                  clazz="index"
495                  ><%=index%></tbl:header>
496                <tbl:header 
497                  clazz="check" 
498                  visible="<%=mode.hasCheck()%>"
499                  ><input 
500                      type="checkbox" 
501                      name="<%=itemId%>" 
502                      value="<%=itemId%>" 
503                      title="TODO" 
504                      <%=cc.getSelected().contains(itemId) ? "checked" : ""%>
505                    ></tbl:header>
506                <tbl:header 
507                  clazz="check" 
508                  visible="<%=mode.hasRadio()%>"
509                  ><input 
510                      type="radio" 
511                      name="item_id" 
512                      value="<%=itemId%>" 
513                      title="TODO" 
514                      <%=selectedItemId == itemId ? "checked" : ""%>
515                    ></tbl:header>
516                <tbl:header 
517                  clazz="icons" 
518                  visible="<%=mode.hasIcons()%>"
519                  >&nbsp;</tbl:header>
520                <tbl:cell column="row"><div class="link" 
521                  onclick="itemOnClick(<%=writePermission ? "event" : null%>, <%=itemId%>)" 
522                  title="<%=tooltip%>"><tbl:cellvalue value="<%=item.getRow()%>" /></div></tbl:cell>
523                <tbl:cell column="column" value="<%=item.getColumn()%>" />
524                <tbl:cell column="id"><%=item.getId()%></tbl:cell>
525                <tbl:cell column="parent">
526                  <%
527                  try
528                  {
529                    Well parent = item.getParent();
530                    if (parent == null)
531                    {
532                      %>
533                      <i>- none -</i>
534                      <%
535                    }
536                    else
537                    {
538                      %>
539                      <%=Base.getLink(ID, 
540                        parent.getPlate().getName() + " [" + parent.getRow() + ", " + parent.getColumn() + "]", 
541                        Item.WELL, parent.getId(), true)%>
542                      <%
543                    }
544                  }
545                  catch (PermissionDeniedException ex)
546                  {
547                    %>
548                    <i>- denied -</i>
549                    <%
550                  }
551                  %>
552                </tbl:cell>
553                <%
554                ReporterData reporter = item.getReporter();
555                if (reporter == null)
556                {
557                  %>
558                  <tbl:cell column="reporter.name"><i>- none -</i></tbl:cell>
559                  <tbl:cell column="reporter.externalId"><i>- none -</i></tbl:cell>
560                  <%
561                }
562                else
563                {
564                  %>
565                  <tbl:cell column="reporter.name"><%=Base.getLink(ID, reporter.getName(), Item.REPORTER, reporter.getId(), true)%></tbl:cell>
566                  <tbl:cell column="reporter.externalId"><%=HTML.encodeTags(reporter.getExternalId())%></tbl:cell>
567                  <tbl:cell column="reporter.symbol"><%=HTML.encodeTags(reporter.getSymbol())%></tbl:cell>
568                  <tbl:cell column="reporter.description"><%=HTML.encodeTags(reporter.getDescription())%></tbl:cell>
569                  <tbl:cell column="reporter.entryDate" value="<%=reporter.getEntryDate()%>" />
570                  <tbl:cell column="reporter.lastUpdate" value="<%=reporter.getLastUpdate()%>" />
571                  <tbl:cell column="reporter.reporterType"
572                    ><base:propertyvalue 
573                      dbcontrol="<%=dc%>" 
574                      item="<%=reporter%>" 
575                      property="reporterType"
576                      enableEditLink="<%=mode.hasEditLink()%>" 
577                      enablePropertyLink="<%=mode.hasPropertyLink()%>"
578                    /></tbl:cell>
579                  <%
580                  if (reporterProperties != null)
581                  {
582                    for (ExtendedProperty ep : reporterProperties)
583                    {
584                      String name = ep.getName();
585                      %>
586                      <tbl:cell column="<%="reporter."+name%>"><tbl:cellvalue value="<%=reporter.getExtended(name)%>" /></tbl:cell>
587                      <%
588                    }
589                  }
590                }
591                AnnotationSet as = item.isAnnotated() ? item.getAnnotationSet() : null;
592                if (as != null)
593                {
594                  for (AnnotationType at : annotationTypes)
595                  {
596                    if (as.hasAnnotation(at))
597                    {
598                      Annotation a = as.getAnnotation(at);
599                      String suffix = a.getUnitSymbol(null);
600                      if (suffix != null) suffix = "&nbsp;" + suffix;
601                      %>
602                      <tbl:cell 
603                        column="<%="at"+at.getId()%>"
604                        ><tbl:cellvalue 
605                          list="<%=a.getValues(null)%>"
606                          suffix="<%=suffix%>"
607                      /></tbl:cell>
608                      <%
609                    }
610                  }
611                }
612                %>
613                <tbl:cell column="permission"><%=PermissionUtil.getShortPermissions(item)%></tbl:cell>
614              </tbl:row>
615              <%
616            }
617          }
618          %>
619          </tbl:rows>
620        </tbl:data>
621      <%
622      if (numListed == 0)
623      {
624        %>
625        <tbl:panel><%=wells == null || wells.getTotalCount() == 0 ? "No wells were found" : "No wells on this page. Please select another page!" %></tbl:panel>
626        <%
627      }
628      else
629      {
630        %>
631        <tbl:navigator
632          page="<%=cc.getPage()%>" 
633          rowsperpage="<%=cc.getRowsPerPage()%>" 
634          totalrows="<%=wells == null ? 0 : wells.getTotalCount()%>" 
635          visible="<%=mode.hasNavigator()%>"
636          locked="true"
637        />
638        <%
639      }
640      %>
641    </tbl:table>
642    <base:buttongroup align="center">
643      <base:button onclick="returnSelected();" title="Ok" visible="<%=mode.hasOkButton()%>" />
644      <base:button onclick="window.close();" title="Cancel" visible="<%=mode.hasCancelButton()%>" />
645      <base:button onclick="window.close();" title="Close" visible="<%=mode.hasCloseButton()%>" />
646    </base:buttongroup>
647 
648    </t:tab>
649    </t:tabcontrol>
650
651 
652  </base:body>
653  </base:page>
654  <%
655}
656finally
657{
658  if (wells != null) wells.close();
659  if (dc != null) dc.close();
660}
661%>
Note: See TracBrowser for help on using the repository browser.