doc/src/docbook/appendix/extended_properties.xml

Code
Comments
Other
Rev Date Author Line
3334 14 May 07 nicklas 1 <?xml version="1.0" encoding="UTF-8"?>
3334 14 May 07 nicklas 2 <!DOCTYPE appendix PUBLIC 
3334 14 May 07 nicklas 3     "-//Dawid Weiss//DTD DocBook V3.1-Based Extension for XML and graphics inclusion//EN" 
3334 14 May 07 nicklas 4     "../../../../lib/docbook/preprocess/dweiss-docbook-extensions.dtd">
3334 14 May 07 nicklas 5 <!--
3334 14 May 07 nicklas 6   $Id$
3334 14 May 07 nicklas 7   
3675 16 Aug 07 jari 8   Copyright (C) 2007 Nicklas Nordborg, Martin Svensson
3334 14 May 07 nicklas 9   
3334 14 May 07 nicklas 10   This file is part of BASE - BioArray Software Environment.
3334 14 May 07 nicklas 11   Available at http://base.thep.lu.se/
3334 14 May 07 nicklas 12   
3334 14 May 07 nicklas 13   BASE is free software; you can redistribute it and/or
3334 14 May 07 nicklas 14   modify it under the terms of the GNU General Public License
4477 05 Sep 08 jari 15   as published by the Free Software Foundation; either version 3
3334 14 May 07 nicklas 16   of the License, or (at your option) any later version.
3334 14 May 07 nicklas 17   
3334 14 May 07 nicklas 18   BASE is distributed in the hope that it will be useful,
3334 14 May 07 nicklas 19   but WITHOUT ANY WARRANTY; without even the implied warranty of
3334 14 May 07 nicklas 20   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
3334 14 May 07 nicklas 21   GNU General Public License for more details.
3334 14 May 07 nicklas 22   
3334 14 May 07 nicklas 23   You should have received a copy of the GNU General Public License
4509 11 Sep 08 jari 24   along with BASE. If not, see <http://www.gnu.org/licenses/>.
3334 14 May 07 nicklas 25 -->
3334 14 May 07 nicklas 26
3334 14 May 07 nicklas 27 <appendix id="appendix.extendedproperties">
5782 04 Oct 11 nicklas 28   <?dbhtml filename="extendedproperties.html" ?>
3334 14 May 07 nicklas 29   <title>extended-properties.xml reference</title>
3334 14 May 07 nicklas 30   
3612 31 Jul 07 nicklas 31   
3612 31 Jul 07 nicklas 32   <bridgehead>What is extended-properties.xml?</bridgehead>
3612 31 Jul 07 nicklas 33
3334 14 May 07 nicklas 34   <para>
3612 31 Jul 07 nicklas 35     The <filename>extended-properties.xml</filename> file is a configuration
3612 31 Jul 07 nicklas 36     file for customizing some of the tables in the BASE database. 
3612 31 Jul 07 nicklas 37     It is located in the <filename>&lt;basedir&gt;/www/WEB-INF/classes</filename>
3612 31 Jul 07 nicklas 38     directory. Only a limited number of tables support this feature, the most important
3612 31 Jul 07 nicklas 39     one is the table for storing reporter information.
3334 14 May 07 nicklas 40   </para>
3334 14 May 07 nicklas 41
5678 29 Jun 11 nicklas 42   <tip>
5678 29 Jun 11 nicklas 43     <para>
5678 29 Jun 11 nicklas 44       It is also possible to put additional extended property definitions in the
5678 29 Jun 11 nicklas 45       <filename>&lt;basedir&gt;/www/WEB-INF/classes/extended-properties</filename>
5678 29 Jun 11 nicklas 46       subdirectory. BASE will merge all <filename>*.xml</filename> it finds with 
5678 29 Jun 11 nicklas 47       the main <filename>extended-properties.xml</filename> file. The extra 
5678 29 Jun 11 nicklas 48       configuration files should have the same format as the main 
5678 29 Jun 11 nicklas 49       <filename>extended-properties.xml</filename> file. The extra files
5678 29 Jun 11 nicklas 50       may contain extra columns for classes that are already
5678 29 Jun 11 nicklas 51       defined in the main file, but existing columns can't be removed or
5678 29 Jun 11 nicklas 52       re-defined. 
5678 29 Jun 11 nicklas 53       We recommend that you don't modify the default <filename>extended-properties.xml</filename>
5678 29 Jun 11 nicklas 54       file at all (unless you want to remove some of the columns). This will make it
5678 29 Jun 11 nicklas 55       easier when upgrading BASE since you don't have to worry about losing
5678 29 Jun 11 nicklas 56       your own changes.
5678 29 Jun 11 nicklas 57       
5678 29 Jun 11 nicklas 58     </para>
5678 29 Jun 11 nicklas 59   </tip>
5678 29 Jun 11 nicklas 60
5678 29 Jun 11 nicklas 61
3612 31 Jul 07 nicklas 62   <para>
3612 31 Jul 07 nicklas 63     The default <filename>extended-properties.xml</filename> that ships
4487 08 Sep 08 jari 64     with BASE is biased towards the BASE version 1.2 setup for 2-spotted microarray
3612 31 Jul 07 nicklas 65     data. If you want your BASE installation to be configured differently we
3612 31 Jul 07 nicklas 66     recommend that you do it before the first initialisation of the database.
3612 31 Jul 07 nicklas 67     It is possible to change the configuration of an existing BASE installation but it
3612 31 Jul 07 nicklas 68     may require manual updates to the database. Follow this procedure:
3612 31 Jul 07 nicklas 69   </para>
3612 31 Jul 07 nicklas 70
3612 31 Jul 07 nicklas 71   <orderedlist>
3612 31 Jul 07 nicklas 72   <listitem>
3612 31 Jul 07 nicklas 73     <para>
3612 31 Jul 07 nicklas 74     Shut down the BASE web server. If you have installed job agents you should shut
3612 31 Jul 07 nicklas 75     down them as well.
3612 31 Jul 07 nicklas 76     </para>
3612 31 Jul 07 nicklas 77   </listitem>
3612 31 Jul 07 nicklas 78   
3612 31 Jul 07 nicklas 79   <listitem>
3612 31 Jul 07 nicklas 80     <para>
5678 29 Jun 11 nicklas 81     Modify the <filename>extended-properties.xml</filename> file or create a new file
5678 29 Jun 11 nicklas 82     in the <filename>extended-properties</filename> subdirectory. If you have installed
3612 31 Jul 07 nicklas 83     job agents, make sure they all have the same version as the web server.
3612 31 Jul 07 nicklas 84     </para>
3612 31 Jul 07 nicklas 85   </listitem>
3612 31 Jul 07 nicklas 86   
3612 31 Jul 07 nicklas 87   <listitem>
3612 31 Jul 07 nicklas 88     <para>
3612 31 Jul 07 nicklas 89     Run the <filename>updatedb.sh</filename> script. New
3612 31 Jul 07 nicklas 90     columns will automatically be created, but the script can't delete columns that 
4487 08 Sep 08 jari 91     have been removed, or modify columns that have changed data type. You will have to 
3612 31 Jul 07 nicklas 92     do these kind of changes by manually executing SQL against your database. Check your 
3612 31 Jul 07 nicklas 93     database documentation for information about SQL syntax.
3612 31 Jul 07 nicklas 94     </para>
3612 31 Jul 07 nicklas 95     
3612 31 Jul 07 nicklas 96     <tip>
4487 08 Sep 08 jari 97       <title>Create a parallel installation</title>
3612 31 Jul 07 nicklas 98       <para>
4487 08 Sep 08 jari 99       You can always create a new temporary parallel installation to check 
3612 31 Jul 07 nicklas 100       what the table generated by installation script looks like. Compare the 
3612 31 Jul 07 nicklas 101       new table to the existing one and make sure they match.
3612 31 Jul 07 nicklas 102       </para>
3612 31 Jul 07 nicklas 103     </tip>
3612 31 Jul 07 nicklas 104   </listitem>
3612 31 Jul 07 nicklas 105   
3612 31 Jul 07 nicklas 106   <listitem>
3612 31 Jul 07 nicklas 107     <para>
3660 13 Aug 07 martin 108     Start up the BASE web server and job agents, if any, again.
3612 31 Jul 07 nicklas 109     </para>
3612 31 Jul 07 nicklas 110   </listitem>
3612 31 Jul 07 nicklas 111   
3612 31 Jul 07 nicklas 112   </orderedlist>
3612 31 Jul 07 nicklas 113
3612 31 Jul 07 nicklas 114   <tip>
3612 31 Jul 07 nicklas 115     <title>Start with few columns</title>
3612 31 Jul 07 nicklas 116     <para>
3612 31 Jul 07 nicklas 117     It is better to start with too few columns, since it is easier to add
3612 31 Jul 07 nicklas 118     more columns than it is to remove columns that are not needed.
3612 31 Jul 07 nicklas 119     </para>
3612 31 Jul 07 nicklas 120   </tip>
3612 31 Jul 07 nicklas 121   
3612 31 Jul 07 nicklas 122   <bridgehead>Sample extended properties setups</bridgehead>
3612 31 Jul 07 nicklas 123   
3612 31 Jul 07 nicklas 124   <itemizedlist>
3612 31 Jul 07 nicklas 125   <listitem>
3612 31 Jul 07 nicklas 126     <para>
3612 31 Jul 07 nicklas 127     After installing BASE the default <filename>extended-properties.xml</filename> 
3612 31 Jul 07 nicklas 128     is located in the <filename>&lt;basedir&gt;/www/WEB-INF/classes</filename> directory.
4487 08 Sep 08 jari 129     This setup is biased towards the BASE version 1.2 setup for
4487 08 Sep 08 jari 130     2-spotted cDNA arrays.  If you are migrating from BASE version 1.2
4487 08 Sep 08 jari 131     you <emphasis>must</emphasis> to use the default setup.
3612 31 Jul 07 nicklas 132     </para>
3612 31 Jul 07 nicklas 133   </listitem>
3612 31 Jul 07 nicklas 134   
3612 31 Jul 07 nicklas 135   <listitem>
3612 31 Jul 07 nicklas 136     <para>
3612 31 Jul 07 nicklas 137     A <filename>minimalistic_extended-properties.xml</filename> setup which doesn't 
3612 31 Jul 07 nicklas 138     define any extra columns at all. This file
3612 31 Jul 07 nicklas 139     can be found in the <filename>&lt;basedir&gt;/misc/config</filename> directory,
3612 31 Jul 07 nicklas 140     and should be used if it is not known what reporter data will be stored in the 
3612 31 Jul 07 nicklas 141     database. The addition of more columns later is straightforward.
3612 31 Jul 07 nicklas 142     </para>
3612 31 Jul 07 nicklas 143   </listitem>
3612 31 Jul 07 nicklas 144   </itemizedlist>
3612 31 Jul 07 nicklas 145
3612 31 Jul 07 nicklas 146   <bridgehead>Format of the extended-properties.xml file</bridgehead>
3612 31 Jul 07 nicklas 147   <para>
3612 31 Jul 07 nicklas 148     The <filename>extended-properties.xml</filename> is an XML file.
3612 31 Jul 07 nicklas 149     The following example will serve as a description of the format:
3612 31 Jul 07 nicklas 150   </para>
3612 31 Jul 07 nicklas 151   
3996 23 Nov 07 nicklas 152   <programlisting language="xml">
3612 31 Jul 07 nicklas 153 &lt;?xml version="1.0" ?&gt;
3612 31 Jul 07 nicklas 154 &lt;!DOCTYPE extended-properties SYSTEM "extended-properties.dtd"&gt;
3612 31 Jul 07 nicklas 155 &lt;extended-properties&gt;
3612 31 Jul 07 nicklas 156    &lt;class name="ReporterData"&gt;
3612 31 Jul 07 nicklas 157       &lt;property
3612 31 Jul 07 nicklas 158          name="extra1"
3612 31 Jul 07 nicklas 159          column="extra1"
3612 31 Jul 07 nicklas 160          title="Extra property"
3612 31 Jul 07 nicklas 161          type="string"
3612 31 Jul 07 nicklas 162          length="255"
3612 31 Jul 07 nicklas 163          null="true"
3612 31 Jul 07 nicklas 164          update="true"
3612 31 Jul 07 nicklas 165          insert="true"
3612 31 Jul 07 nicklas 166          averagemethod="max"
6428 03 Mar 14 nicklas 167          restricted-edit="false"
7497 11 Jul 18 nicklas 168          hidden="false"
3612 31 Jul 07 nicklas 169          description="An extra property for all reporters"
3612 31 Jul 07 nicklas 170       &gt;
3612 31 Jul 07 nicklas 171       &lt;link
3612 31 Jul 07 nicklas 172          regexp=".*"
3612 31 Jul 07 nicklas 173          url="http://www.myexternaldb.com/find?{value}"
3612 31 Jul 07 nicklas 174       /&gt;
3612 31 Jul 07 nicklas 175       &lt;/property&gt;
3612 31 Jul 07 nicklas 176    &lt;/class&gt;
3612 31 Jul 07 nicklas 177 &lt;/extended-properties&gt;
3612 31 Jul 07 nicklas 178 </programlisting>
3612 31 Jul 07 nicklas 179   
3612 31 Jul 07 nicklas 180   <para>
3612 31 Jul 07 nicklas 181     Each table that can be customized is represented by a <sgmltag class="starttag">class</sgmltag> 
3612 31 Jul 07 nicklas 182     tag. The value of the <sgmltag>name</sgmltag> attribute is the name of the Java class
3612 31 Jul 07 nicklas 183     that handles the information in that table. In the case of reporters
3612 31 Jul 07 nicklas 184     the class name is <constant>ReporterData</constant>.
3612 31 Jul 07 nicklas 185   </para>
3612 31 Jul 07 nicklas 186   
3612 31 Jul 07 nicklas 187   <para>
3612 31 Jul 07 nicklas 188     Each <sgmltag class="starttag">class</sgmltag> tag may contain one or more
3612 31 Jul 07 nicklas 189     <sgmltag class="starttag">property</sgmltag> tags, each one describing a single
3612 31 Jul 07 nicklas 190     column in the table. The possible attributes of the <sgmltag class="starttag">property</sgmltag>
3612 31 Jul 07 nicklas 191     tag are:
3612 31 Jul 07 nicklas 192   </para>
3612 31 Jul 07 nicklas 193   
3996 23 Nov 07 nicklas 194     <table frame="all" id="appendix.extendedproperties.property">
3996 23 Nov 07 nicklas 195     <title>Attributes for the <sgmltag class="starttag">property</sgmltag> tag</title>
3612 31 Jul 07 nicklas 196     <tgroup cols="3" align="left">
3612 31 Jul 07 nicklas 197       <colspec colname="attribute" align="left" />
3612 31 Jul 07 nicklas 198       <colspec colname="required" />
3612 31 Jul 07 nicklas 199       <colspec colname="comment" />
3612 31 Jul 07 nicklas 200       <thead>
3612 31 Jul 07 nicklas 201         <row>
3612 31 Jul 07 nicklas 202           <entry>Attribute</entry>
3612 31 Jul 07 nicklas 203           <entry>Required</entry>
3612 31 Jul 07 nicklas 204           <entry>Comment</entry>
3612 31 Jul 07 nicklas 205         </row>
3612 31 Jul 07 nicklas 206       </thead>
3612 31 Jul 07 nicklas 207       <tbody>
3612 31 Jul 07 nicklas 208         <row>
3612 31 Jul 07 nicklas 209           <entry>name</entry>
3612 31 Jul 07 nicklas 210           <entry>yes</entry>
3612 31 Jul 07 nicklas 211           <entry>
3612 31 Jul 07 nicklas 212             A unique name (within the class) of the extra property. 
3612 31 Jul 07 nicklas 213             The name must only contain letters, numbers and underscores but the first character 
3612 31 Jul 07 nicklas 214             can't be a number. The name is used to identify the extra column in the Java code
3612 31 Jul 07 nicklas 215             and in the Query API.
3612 31 Jul 07 nicklas 216           </entry>
3612 31 Jul 07 nicklas 217         </row>
3612 31 Jul 07 nicklas 218         <row>
3612 31 Jul 07 nicklas 219           <entry>column</entry>
3612 31 Jul 07 nicklas 220           <entry>yes</entry>
3612 31 Jul 07 nicklas 221           <entry>
3612 31 Jul 07 nicklas 222             The name of the database column. This value must be unique within the 
3612 31 Jul 07 nicklas 223             class. Valid names depends on the database, but it should be safe
3612 31 Jul 07 nicklas 224             to follow the same rules as for the <sgmltag>name</sgmltag> attribute. 
3612 31 Jul 07 nicklas 225             In most cases, it makes  sense to use the same value for both the 
3612 31 Jul 07 nicklas 226             <sgmltag>name</sgmltag> and <sgmltag>column</sgmltag> attributes.
3612 31 Jul 07 nicklas 227           </entry>
3612 31 Jul 07 nicklas 228         </row>
3612 31 Jul 07 nicklas 229         <row>
3612 31 Jul 07 nicklas 230           <entry>title</entry>
3612 31 Jul 07 nicklas 231           <entry>no</entry>
3612 31 Jul 07 nicklas 232           <entry>
3612 31 Jul 07 nicklas 233             The title of the extra property as it is displayed in client applications.
4487 08 Sep 08 jari 234             If not specified the value of the <sgmltag>name</sgmltag> attribute is used.
3612 31 Jul 07 nicklas 235           </entry>
3612 31 Jul 07 nicklas 236         </row>
3612 31 Jul 07 nicklas 237         <row>
3612 31 Jul 07 nicklas 238           <entry>description</entry>
3612 31 Jul 07 nicklas 239           <entry>no</entry>
3612 31 Jul 07 nicklas 240           <entry>
3612 31 Jul 07 nicklas 241             A longer (but still short!) description of the extra property which can be
3612 31 Jul 07 nicklas 242             used in client applications to provide help.
3612 31 Jul 07 nicklas 243           </entry>
3612 31 Jul 07 nicklas 244         </row>
3612 31 Jul 07 nicklas 245         <row>
3612 31 Jul 07 nicklas 246           <entry>type</entry>
3612 31 Jul 07 nicklas 247           <entry>yes</entry>
3612 31 Jul 07 nicklas 248           <entry>
3612 31 Jul 07 nicklas 249             The data type of the column. Allowed values are:
3612 31 Jul 07 nicklas 250             <itemizedlist>
3612 31 Jul 07 nicklas 251             <listitem>
3612 31 Jul 07 nicklas 252               <simpara>int</simpara>
3612 31 Jul 07 nicklas 253             </listitem>
3612 31 Jul 07 nicklas 254             <listitem>
3612 31 Jul 07 nicklas 255               <simpara>long</simpara>
3612 31 Jul 07 nicklas 256             </listitem>
3612 31 Jul 07 nicklas 257             <listitem>
3612 31 Jul 07 nicklas 258               <simpara>float</simpara>
3612 31 Jul 07 nicklas 259             </listitem>
3612 31 Jul 07 nicklas 260             <listitem>
3612 31 Jul 07 nicklas 261               <simpara>double</simpara>
3612 31 Jul 07 nicklas 262             </listitem>
3612 31 Jul 07 nicklas 263             <listitem>
3612 31 Jul 07 nicklas 264               <simpara>boolean</simpara>
3612 31 Jul 07 nicklas 265             </listitem>
3612 31 Jul 07 nicklas 266             <listitem>
3612 31 Jul 07 nicklas 267               <simpara>string</simpara>
3612 31 Jul 07 nicklas 268             </listitem>
3612 31 Jul 07 nicklas 269             <listitem>
3612 31 Jul 07 nicklas 270               <simpara>date</simpara>
3612 31 Jul 07 nicklas 271             </listitem>
5436 30 Sep 10 nicklas 272             <listitem>
5436 30 Sep 10 nicklas 273               <simpara>timestamp</simpara>
5436 30 Sep 10 nicklas 274             </listitem>
3612 31 Jul 07 nicklas 275             </itemizedlist>
3612 31 Jul 07 nicklas 276             
3612 31 Jul 07 nicklas 277             <para>
3612 31 Jul 07 nicklas 278               Note that the given types are converted into the most appropriate database 
3612 31 Jul 07 nicklas 279               column type by Hibernate.
3612 31 Jul 07 nicklas 280             </para>
3612 31 Jul 07 nicklas 281           </entry>
3612 31 Jul 07 nicklas 282         </row>
3612 31 Jul 07 nicklas 283         <row>
3612 31 Jul 07 nicklas 284           <entry>length</entry>
3612 31 Jul 07 nicklas 285           <entry>no</entry>
3612 31 Jul 07 nicklas 286           <entry>
3612 31 Jul 07 nicklas 287             If the column is a string type, this is the maximum length that can
3612 31 Jul 07 nicklas 288             be stored in the database. If no value is given, 255 is assumed.
3612 31 Jul 07 nicklas 289           </entry>
3612 31 Jul 07 nicklas 290         </row>
3612 31 Jul 07 nicklas 291         <row>
3612 31 Jul 07 nicklas 292           <entry>null</entry>
3612 31 Jul 07 nicklas 293           <entry>no</entry>
3612 31 Jul 07 nicklas 294           <entry>
3612 31 Jul 07 nicklas 295             If the column should allow <constant>null</constant> values or not.
3612 31 Jul 07 nicklas 296             Allowed values are <constant>true</constant> (default) and 
3612 31 Jul 07 nicklas 297             <constant>false</constant>.
3612 31 Jul 07 nicklas 298           </entry>
3612 31 Jul 07 nicklas 299         </row>
3612 31 Jul 07 nicklas 300         <row>
3612 31 Jul 07 nicklas 301           <entry>insert</entry>
3612 31 Jul 07 nicklas 302           <entry>no</entry>
3612 31 Jul 07 nicklas 303           <entry>
3660 13 Aug 07 martin 304             If values for this property should be inserted into the database or not.
3612 31 Jul 07 nicklas 305             Allowed values are <constant>true</constant> (default) and 
3612 31 Jul 07 nicklas 306             <constant>false</constant>.
3612 31 Jul 07 nicklas 307           </entry>
3612 31 Jul 07 nicklas 308         </row>
3612 31 Jul 07 nicklas 309         <row>
3612 31 Jul 07 nicklas 310           <entry>update</entry>
3612 31 Jul 07 nicklas 311           <entry>no</entry>
3612 31 Jul 07 nicklas 312           <entry>
3660 13 Aug 07 martin 313             If values for this property should be updated in the database or not.
3612 31 Jul 07 nicklas 314             Allowed values are <constant>true</constant> (default) and 
3612 31 Jul 07 nicklas 315             <constant>false</constant>.
3612 31 Jul 07 nicklas 316           </entry>
3612 31 Jul 07 nicklas 317         </row>
3612 31 Jul 07 nicklas 318         <row>
6428 03 Mar 14 nicklas 319           <entry>restricted-edit</entry>
6428 03 Mar 14 nicklas 320           <entry>no</entry>
6428 03 Mar 14 nicklas 321           <entry>
6428 03 Mar 14 nicklas 322             Allowed values are <constant>false</constant> (default) and 
6428 03 Mar 14 nicklas 323             <constant>true</constant>. If set, there is some restriction
6428 03 Mar 14 nicklas 324             on who may change the values. This is currently only implemented
6428 03 Mar 14 nicklas 325             for users. If the property is restricted only an administrator is allowed
6428 03 Mar 14 nicklas 326             to change the value, not the user itself.
6428 03 Mar 14 nicklas 327           </entry>
6428 03 Mar 14 nicklas 328         </row>
6428 03 Mar 14 nicklas 329         <row>
7497 11 Jul 18 nicklas 330           <entry>hidden</entry>
7497 11 Jul 18 nicklas 331           <entry>no</entry>
7497 11 Jul 18 nicklas 332           <entry>
7497 11 Jul 18 nicklas 333             Allowed values are <constant>false</constant> (default) and 
7497 11 Jul 18 nicklas 334             <constant>true</constant>. If set, the property is normally
7497 11 Jul 18 nicklas 335             not visible in the user interface. It is still possible for
7497 11 Jul 18 nicklas 336             plug-ins and extensions to access and modify the property
7497 11 Jul 18 nicklas 337             (using regular access permission rules).
7497 11 Jul 18 nicklas 338           </entry>
7497 11 Jul 18 nicklas 339         </row>
7497 11 Jul 18 nicklas 340         <row>
3612 31 Jul 07 nicklas 341           <entry>averagemethod</entry>
3612 31 Jul 07 nicklas 342           <entry>no</entry>
3612 31 Jul 07 nicklas 343           <entry>
3612 31 Jul 07 nicklas 344             The method to use when calculating the average of a set of values. 
3612 31 Jul 07 nicklas 345             This attribute replaces the <sgmltag>averagable</sgmltag> attribute. 
3612 31 Jul 07 nicklas 346             The following values can be used:
3612 31 Jul 07 nicklas 347              
3612 31 Jul 07 nicklas 348             <itemizedlist>
3612 31 Jul 07 nicklas 349             <listitem>
3612 31 Jul 07 nicklas 350               <simpara>
3612 31 Jul 07 nicklas 351               <constant>none</constant>: average values are not supported 
3612 31 Jul 07 nicklas 352               (default for non-numerical columns)
3612 31 Jul 07 nicklas 353               </simpara>
3612 31 Jul 07 nicklas 354             </listitem> 
3612 31 Jul 07 nicklas 355             <listitem>
3612 31 Jul 07 nicklas 356               <simpara>
3612 31 Jul 07 nicklas 357               <constant>arithmetic_mean</constant>: calculate the arithmetic mean 
3612 31 Jul 07 nicklas 358               (default for numerical columns; not supported for non-numerical columns)
3612 31 Jul 07 nicklas 359               </simpara>
3612 31 Jul 07 nicklas 360             </listitem> 
3612 31 Jul 07 nicklas 361             <listitem>
3612 31 Jul 07 nicklas 362               <simpara>
3612 31 Jul 07 nicklas 363               <constant>geometric_mean</constant>: calculate the geometric mean 
3612 31 Jul 07 nicklas 364               (not supported for non-numerical columns)
3612 31 Jul 07 nicklas 365               </simpara>
3612 31 Jul 07 nicklas 366             </listitem> 
3612 31 Jul 07 nicklas 367             <listitem>
3612 31 Jul 07 nicklas 368               <simpara>
5678 29 Jun 11 nicklas 369               <constant>quadratic_mean</constant>: calculate the quadtratic mean 
5678 29 Jun 11 nicklas 370               (not supported for non-numerical columns)
5678 29 Jun 11 nicklas 371               </simpara>
5678 29 Jun 11 nicklas 372             </listitem> 
5678 29 Jun 11 nicklas 373             <listitem>
5678 29 Jun 11 nicklas 374               <simpara>
3612 31 Jul 07 nicklas 375               <constant>min</constant>: use the minimum value of the values in the set
3612 31 Jul 07 nicklas 376               </simpara>
3612 31 Jul 07 nicklas 377             </listitem> 
3612 31 Jul 07 nicklas 378             <listitem>
3612 31 Jul 07 nicklas 379               <simpara>
3612 31 Jul 07 nicklas 380               <constant>max</constant>: use the maximum value of the values in the set
3612 31 Jul 07 nicklas 381               </simpara>
3612 31 Jul 07 nicklas 382             </listitem> 
3612 31 Jul 07 nicklas 383             </itemizedlist>
3612 31 Jul 07 nicklas 384              
3612 31 Jul 07 nicklas 385           </entry>
3612 31 Jul 07 nicklas 386         </row>
3612 31 Jul 07 nicklas 387       </tbody>
3612 31 Jul 07 nicklas 388     </tgroup>
3996 23 Nov 07 nicklas 389     </table>
3612 31 Jul 07 nicklas 390   
3612 31 Jul 07 nicklas 391   <para>
3612 31 Jul 07 nicklas 392     Each <sgmltag class="starttag">property</sgmltag> tag may contain zero or more
3612 31 Jul 07 nicklas 393     <sgmltag class="starttag">link</sgmltag> tags that can be used by client
3612 31 Jul 07 nicklas 394     application to provide clickable links to other databases. Each 
3612 31 Jul 07 nicklas 395     <sgmltag class="starttag">link</sgmltag> has a <sgmltag>regexp</sgmltag>
3612 31 Jul 07 nicklas 396     and an <sgmltag>url</sgmltag> attribute. If the regular expression matches 
3612 31 Jul 07 nicklas 397     the value a link will be created, otherwise not. The order of the 
3612 31 Jul 07 nicklas 398     <sgmltag class="starttag">link</sgmltag> tags are important, since only
3612 31 Jul 07 nicklas 399     the first one that matches is used. The <sgmltag>url</sgmltag> attribute may
3612 31 Jul 07 nicklas 400     contain the string <constant>{value}</constant> which will be replaced by the
3612 31 Jul 07 nicklas 401     actual value when the link is generated.
3612 31 Jul 07 nicklas 402   </para>
3612 31 Jul 07 nicklas 403   
3612 31 Jul 07 nicklas 404   <note>
3612 31 Jul 07 nicklas 405     <para>
3612 31 Jul 07 nicklas 406     If the link contains the character <constant>&amp;</constant> it must be
4487 08 Sep 08 jari 407     escaped as <constant>&amp;amp;</constant>. For example, to link to a UniGene 
3612 31 Jul 07 nicklas 408     entry:
3612 31 Jul 07 nicklas 409     </para>
3612 31 Jul 07 nicklas 410     <programlisting>
3612 31 Jul 07 nicklas 411 &lt;link
3612 31 Jul 07 nicklas 412    regexp="\w+\.\d+"
3612 31 Jul 07 nicklas 413    url="http://www.ncbi.nlm.nih.gov/entrez/query.fcgi?db=unigene&amp;amp;term={value}[ClusterID]"
3612 31 Jul 07 nicklas 414 /&gt;
3612 31 Jul 07 nicklas 415 </programlisting>
3612 31 Jul 07 nicklas 416   </note>
3612 31 Jul 07 nicklas 417
3612 31 Jul 07 nicklas 418   
3334 14 May 07 nicklas 419 </appendix>
3334 14 May 07 nicklas 420

Generated on Sat Oct  7 02:27:09 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)