source: extensions/net.sf.basedb.examples/trunk/META-INF/extensions.xml @ 1603

<?xml version="1.0" encoding="UTF-8" ?>
<!-- 
  Copyright (C) 2011 Nicklas Nordborg

  This file is part of the Example Code Package for BASE.
  Available at http://baseplugins.thep.lu.se/
  BASE main site: http://base.thep.lu.se/
  
  This is free software; you can redistribute it and/or
  modify it under the terms of the GNU General Public License
  as published by the Free Software Foundation; either version 3
  of the License, or (at your option) any later version.
  
  The software is distributed in the hope that it will be useful,
  but WITHOUT ANY WARRANTY; without even the implied warranty of
  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  GNU General Public License for more details.
  
  You should have received a copy of the GNU General Public License
  along with BASE. If not, see <http://www.gnu.org/licenses/>.
-->
<extensions xmlns="http://base.thep.lu.se/extensions.xsd"
  id-base="net.sf.basedb.examples.extensions.">
  <about>
    <name>Extensions example package</name>
    <description>
      This package contains several simple example extensions.
      Most of them are variants of the well-known "Hello world"
      code example.
    </description>
    <version>1.5-dev</version>
    <min-base-version>3.2.0</min-base-version>
    <copyright>BASE development team</copyright>
    <url>http://baseplugins.thep.lu.se/wiki/net.sf.basedb.examples.extensions</url>
    <email>basedb-users@lists.sourceforge.net</email>
  </about>
  
  <plugin-definition id="ExampleAnalyzer">
    <about>
      <name>Example: Copy spot intensity</name>
      <description>
        An example analysis plugin that creates a new bioassay set
        by multiplying each intensitity value with the same factor, 
        filtering out intensities below a cutoff value.
      </description>
    </about>
    <plugin-class>net.sf.basedb.examples.plugins.ExampleAnalyzer</plugin-class>
  </plugin-definition>
  
  <plugin-definition id="ExampleImporter">
    <about>
      <name>Example: sample importer</name>
      <description>
        An example plugin that pretends to import samples. 
        It can't be configured, but will ask for a file to
        import from and if existing samples should be updated 
        or not. It won't actually import any samples, but 
        will report that a few samples has been imported.
      </description>
    </about>
    <plugin-class>net.sf.basedb.examples.plugins.ExampleImporter</plugin-class>
  </plugin-definition>
  
  <extension
    id="menu.helloworld"
    extends="net.sf.basedb.clients.web.menu.extensions"
    >
    <index>0</index>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.menu.FixedMenuItemFactory
      </factory-class>
      <parameters>
        <type>SUBMENU</type>
        <submenuId>hello</submenuId>
        <title>Hello world examples!</title>
        <tooltip>Find all examples here</tooltip>
        <icon>/images/info.png</icon>
      </parameters>
    </action-factory>
  </extension>
  <extension
    id="menu.helloworldsimple"
    extends="net.sf.basedb.clients.web.menu.extensions"
    >
    <index>1</index>
    <about>
      <name>Hello world</name>
      <description>
        The very first extensions example. Adds a "Hello world"
        menu item that displays "Hello world" in a javascript
        popup when selected.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.menu.FixedMenuItemFactory
      </factory-class>
      <parameters>
        <menuId>hello</menuId>
        <title>Hello world!</title>
        <tooltip>This is to test the extensions system</tooltip>
        <onClick>alert('Hello world!')</onClick>
        <icon>/images/info.png</icon>
      </parameters>
    </action-factory>
  </extension>
  
  <extension
    id="menu.helloworldfactory"
    extends="net.sf.basedb.clients.web.menu.extensions"
    >
    <index>2</index>
    <about>
      <name>Hello factory world</name>
      <description>
        A "Hello world" variant with a custom action factory.
        Everything is hard-coded into the factory.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.menu.HelloWorldFactory
      </factory-class>
    </action-factory>
  </extension>
  
  <extension
    id="menu.hellouser"
    extends="net.sf.basedb.clients.web.menu.extensions"
    >
    <index>3</index>
    <about>
      <name>Greetings user</name>
      <description>
        A "Hello world" variant with a custom action factory
        that displays "Greetings {name of user}" instead. We also
        make the icon configurable.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.menu.HelloUserFactory
      </factory-class>
      <parameters>
        <prefix>Greetings</prefix>
        <icon>/images/take_ownership.png</icon>
      </parameters>
    </action-factory>
  </extension>

  <extension
    id="menu.hellojspworld"
    extends="net.sf.basedb.clients.web.menu.extensions"
    >
    <index>4</index>
    <about>
      <name>Hello JSP world</name>
      <description>
        This example uses a custom JSP page to display the
        "Hello world" message instead of a javascript popup.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.menu.FixedMenuItemFactory
      </factory-class>
      <parameters>
        <menuId>hello</menuId>
        <title>Hello JSP world!</title>
        <tooltip>Opens a JSP page with the message</tooltip>
        <onClick>Main.openPopup('$HOME$/hello_world.jsp?ID=' + getSessionId(), 'HelloJspWorld', 450, 300)</onClick>
        <icon>~/images/world.png</icon>
      </parameters>
    </action-factory>
  </extension>
  <extension
    id="menu.helloxjspworld"
    extends="net.sf.basedb.clients.web.menu.extensions"
    >
    <index>5</index>
    <about>
      <name>Hello X-JSP world</name>
      <description>
        This example uses a custom X-JSP page to display the
        "Hello world" message instead of a javascript popup.
        An X-JSP file is a JSP file that has access to classes in
        the extension's JAR file. NOTE! This example requires that
        the XJSP compiler is installed on the server.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.menu.FixedMenuItemFactory
      </factory-class>
      <parameters>
        <menuId>hello</menuId>
        <title>Hello X-JSP world!</title>
        <tooltip>Opens a X-JSP page with the message</tooltip>
        <onClick>Main.openPopup('$HOME$/hello_world.xjsp?ID=' + getSessionId(), 'HelloXJspWorld', 450, 300)</onClick>
        <icon>~/images/xworld.png</icon>
      </parameters>
    </action-factory>
  </extension>
  <extension
    id="menu.helloservletworld"
    extends="net.sf.basedb.clients.web.menu.extensions"
    >
    <index>6</index>
    <about>
      <name>Hello Servlet world</name>
      <description>
        This example uses a custom Servlet page to display the
        "Hello world" message instead of a javascript popup.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.menu.FixedMenuItemFactory
      </factory-class>
      <parameters>
        <menuId>hello</menuId>
        <title>Hello Servlet world!</title>
        <tooltip>Opens a Servlet generated page with the message</tooltip>
        <onClick>Main.openPopup('$HOME$/HelloWorld/with/some/path-info.servlet?ID=' + getSessionId(), 'HelloServletWorld', 450, 300)</onClick>
        <icon>~/images/servlet.png</icon>
      </parameters>
    </action-factory>
  </extension>
  <extension
    id="menu.helloservletworld2"
    extends="net.sf.basedb.clients.web.menu.extensions"
    >
    <index>7</index>
    <about>
      <name>Hello Servlet world (alternate)</name>
      <description>
        This example uses a custom Servlet page to display the
        "Hello world" message instead of a javascript popup.
        The difference from the above menu is that this uses an
        alternate path to the servlet.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.menu.FixedMenuItemFactory
      </factory-class>
      <parameters>
        <menuId>hello</menuId>
        <title>Hello Servlet world (alternate)!</title>
        <tooltip>Opens a Servlet generated page with the message</tooltip>
        <onClick>Main.openPopup('$SERVLET_HOME$/HelloWorld/with/other/path?ID=' + getSessionId(), 'HelloServletWorld', 450, 300)</onClick>
        <icon>~/images/servlet.png</icon>
      </parameters>
    </action-factory>
  </extension>
  <extension
    id="toolbar.iteminfo"
    extends="net.sf.basedb.clients.web.toolbar.item.all"
    >
    <index>1</index>
    <about>
      <name>Show item info</name>
      <description>
        This example creates a toolbar button on all single-item
        pages that opens a JSP page that displays some information
        about the item.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.toolbar.InfoButtonFactory
      </factory-class>
      <parameters>
        <title>More info...</title>
        <tooltip>Show some information about $NAME</tooltip>
        <icon>/images/info.png</icon>
        <onClick>Examples.showItemInfo('$TYPE', $ID)</onClick>
        <script>~/scripts/examples.jsp</script>
      </parameters>
    </action-factory>
  </extension>
  <extension
    id="toolbar.filterselected"
    extends="net.sf.basedb.clients.web.toolbar.list.annotatable"
    >
    <index>1</index>
    <about>
      <name>Annotation filter</name>
      <description>
        This example creates a toolbar button that can apply a 
        special filter for showing only items that has been
        annotated or only items that has no annotations.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.toolbar.InfoButtonFactory
      </factory-class>
      <parameters>
        <title>Annotation filter...</title>
        <tooltip>Filter items based on if they have been annotated or not</tooltip>
        <icon>/images/filter.png</icon>
        <onClick>Examples.filterAnnotated('$TYPE')</onClick>
        <script>~/scripts/examples.jsp</script>
      </parameters>
    </action-factory>
  </extension>
  <extension
    id="toolbar.clickme"
    extends="net.sf.basedb.clients.web.toolbar.list.all"
    >
    <index>2</index>
    <about>
      <name>Click me!</name>
      <description>
        Click the button!
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.toolbar.FixedButtonFactory
      </factory-class>
      <parameters>
        <title>Click me!</title>
        <tooltip>Come on! Do it!</tooltip>
        <icon>/images/info.gif</icon>
        <onClick>alert('Ouch!')</onClick>
      </parameters>
    </action-factory>
  </extension>
  <extension
    id="history-edit"
    >
    <extends>
      <ref index="2">net.sf.basedb.clients.web.tabcontrol.edit.sample</ref>
      <ref index="2">net.sf.basedb.clients.web.tabcontrol.edit.extract</ref>
    </extends>
    <about>
      <name>History file (edit)</name>
      <description>
        Adds an extra tab to the "Edit sample/extract" dialogs, were the user may
        select a "History file" (whatever that is!) that is linked 
        with an any-to-any link to the item. This action also need the 
        'history-save' action to save the link.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.tabcontrol.IncludeContentTabFactory
      </factory-class>
      <parameters>
        <id>history-file</id>
        <title>History file</title>
        <tooltip>On this form you can link the item with it's history file!</tooltip>
        <include>~/history_file.jsp</include>
      </parameters>
    </action-factory>
  </extension>

  <extension
    id="history-save"
    >
    <extends>
      <ref index="2">net.sf.basedb.clients.web.onsave.sample</ref>
      <ref index="2">net.sf.basedb.clients.web.onsave.extract</ref>
    </extends>
    <about>
      <name>History file (save)</name>
      <description>
        Saves an any-to-any link between a sample/extract and it's history file.
        The history file is set in an extra tab in the "Edit sample/extract" 
        dialogs that is controlled by the 'history-edit' extension.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.edit.HistoryOnSaveActionFactory
      </factory-class>
    </action-factory>
  </extension>

  <extension
    id="onsave.lastupdatedby"
    extends="net.sf.basedb.clients.web.onsave.all"
    >
    <index>3</index>
    <about>
      <name>Last updated by</name>
      <description>
        Creates an any-to-any link between any item and the currently logged in user
        when that item is edited and saved in the web interface.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.edit.LastUpdatedByOnSaveActionFactory
      </factory-class>
    </action-factory>
  </extension>

  <extension
    id="list.owner-registration-date"
    extends="net.sf.basedb.clients.web.listcolumn.ownable"
    >
    <index>1</index>
    <about>
      <name>Owner registration date</name>
      <description>
        Add a column to the list page of all ownable items that display
        the registration date of the owner of the item.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.list.PropertyPathActionFactory
      </factory-class>
      <parameters>
        <id>owner.entryDate</id>
        <title>Owner registration date</title>
        <property>owner.entryDate</property>
        <valueType>DATE</valueType>
      </parameters>
    </action-factory>
  </extension>
  
  <extension
    id="list.owner-email"
    extends="net.sf.basedb.clients.web.listcolumn.ownable"
    >
    <index>2</index>
    <about>
      <name>Owner email</name>
      <description>
        Add a column to the list page of all ownable items that display
        the owner's email address.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.list.PropertyPathActionFactory
      </factory-class>
      <parameters>
        <id>owner.email</id>
        <title>Owner email</title>
        <property>owner.email</property>
        <valueType>STRING</valueType>
        <formatterClass>net.sf.basedb.clients.web.formatter.NiceFormatter</formatterClass>
        <exportFormatterClass>net.sf.basedb.examples.formatter.ToUpperCaseFormatter</exportFormatterClass>
      </parameters>
    </action-factory>
  </extension>
  
  <extension
    id="list.rawbioassay-data-files"
    extends="net.sf.basedb.clients.web.listcolumn.rawbioassay"
    >
    <index>10</index>
    <about>
      <name>Data files</name>
      <description>
        Adds a column to the rawbioassays list that display data files attached to
        each raw bioassay.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.list.DataFilesActionFactory
      </factory-class>
    </action-factory>
  </extension>
  
  <extension
    id="list.extra-id"
    extends="net.sf.basedb.clients.web.listcolumn.all"
    >
    <index>99</index>
    <about>
      <name>Extra id</name>
      <description>
        Add an extra id column to all lists. Useful for
        testing that the extension system is working.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.clients.web.extensions.list.PropertyPathActionFactory
      </factory-class>
      <parameters>
        <id>xid</id>
        <title>XID</title>
        <property>id</property>
        <valueType>INT</valueType>
      </parameters>
    </action-factory>
  </extension>

  <extension 
    id="loader.user"
    extends="net.sf.basedb.util.overview.loader">
    <index>1</index>
    <about>
      <name>Owner of item</name>
      <description>
        Load the owner of each item as a property
        node in the item overview.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.overview.OwnerNodeLoaderFactory
      </factory-class>
    </action-factory>
  </extension>

  <extension 
    id="validator.user"
    extends="net.sf.basedb.util.overview.validator">
    <index>1</index>
    <about>
      <name>Check the owner of an item</name>
      <description>
        This validator check the following things:
        * Missing and denied access to the owner of an item
        * That an URL has been specified for the user and has a valid syntax
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.overview.OwnerValidatorFactory
      </factory-class>
    </action-factory>
  </extension>
  
  <extension
    id="validationrule.missing-owner"
    extends="net.sf.basedb.util.overview.validationrule">
    <index>1</index>
    <about>
      <name>Missing owner</name>
      <description>
        Checks if an owner has been set for an item. Can't really happen
        since an owner is always set by the core API.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.util.overview.extensions.ReflectValidationRuleActionFactory
      </factory-class>
      <parameters>
        <field>net.sf.basedb.examples.extensions.overview.OwnerValidator.MISSING_OWNER</field>
      </parameters>
    </action-factory>
  </extension>
  
  <extension
    id="validationrule.denied-owner"
    extends="net.sf.basedb.util.overview.validationrule">
    <index>2</index>
    <about>
      <name>Access denied to owner</name>
      <description>Checks if the user is denied access to the owner of an item.</description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.util.overview.extensions.ReflectValidationRuleActionFactory
      </factory-class>
      <parameters>
        <field>net.sf.basedb.examples.extensions.overview.OwnerValidator.DENIED_OWNER</field>
      </parameters>
    </action-factory>
  </extension>
  
  <extension
    id="validationrule.missing-url"
    extends="net.sf.basedb.util.overview.validationrule">
    <index>3</index>
    <about>
      <name>Missing URL</name>
      <description>Check that an URL has been set for a user</description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.util.overview.extensions.ReflectValidationRuleActionFactory
      </factory-class>
      <parameters>
        <field>net.sf.basedb.examples.extensions.overview.OwnerValidator.MISSING_URL</field>
      </parameters>
    </action-factory>
  </extension>

  <extension
    id="validationrule.invalid-url"
    extends="net.sf.basedb.util.overview.validationrule">
    <index>4</index>
    <about>
      <name>Invalid URL</name>
      <description>Checks if an URL has a valid syntax.</description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.util.overview.extensions.ReflectValidationRuleActionFactory
      </factory-class>
      <parameters>
        <field>net.sf.basedb.examples.extensions.overview.OwnerValidator.INVALID_URL</field>
      </parameters>
    </action-factory>
  </extension>

  <extension 
    id="loader.role"
    extends="net.sf.basedb.util.overview.loader">
    <index>2</index>
    <about>
      <name>Role membership</name>
      <description>
        Load the role membership of users as a folder-node with one item-node
        for each role.
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.overview.RoleNodeLoaderFactory
      </factory-class>
    </action-factory>
  </extension>

  <extension 
    id="validator.role"
    extends="net.sf.basedb.util.overview.validator">
    <index>2</index>
    <about>
      <name>Check the role membership of a user</name>
      <description>
        This validator check the following things:
        * The the user is a member of at least one role
      </description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.examples.extensions.overview.RoleValidatorFactory
      </factory-class>
    </action-factory>
  </extension>

  <extension
    id="validationrule.missing-role"
    extends="net.sf.basedb.util.overview.validationrule">
    <index>5</index>
    <about>
      <name>Missing role</name>
      <description>Checks if a user is a member of at least one role.</description>
    </about>
    <action-factory>
      <factory-class>
        net.sf.basedb.util.overview.extensions.ReflectValidationRuleActionFactory
      </factory-class>
      <parameters>
        <field>net.sf.basedb.examples.extensions.overview.RoleValidator.MISSING_ROLE</field>
      </parameters>
    </action-factory>
  </extension>

</extensions>