Changeset 7409


Ignore:
Timestamp:
12/13/10 12:46:36 (9 years ago)
Author:
aivar
Message:

More documentation.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • branches/maven/projects/deep-zoom-plugin/src/main/java/loci/multiinstanceplugin/IPluginLauncher.java

    r7367 r7409  
     1// 
     2// IPluginLauncher.java 
     3// 
     4 
    15/* 
    2  * To change this template, choose Tools | Templates 
    3  * and open the template in the editor. 
    4  */ 
     6Multiple instance chainable plugin framework. 
     7 
     8Copyright (c) 2010, UW-Madison LOCI 
     9All rights reserved. 
     10 
     11Redistribution and use in source and binary forms, with or without 
     12modification, are permitted provided that the following conditions are met: 
     13  * Redistributions of source code must retain the above copyright 
     14    notice, this list of conditions and the following disclaimer. 
     15  * Redistributions in binary form must reproduce the above copyright 
     16    notice, this list of conditions and the following disclaimer in the 
     17    documentation and/or other materials provided with the distribution. 
     18  * Neither the name of the UW-Madison LOCI nor the 
     19    names of its contributors may be used to endorse or promote products 
     20    derived from this software without specific prior written permission. 
     21 
     22THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" 
     23AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 
     24IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 
     25ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDERS OR CONTRIBUTORS BE 
     26LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR 
     27CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF 
     28SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS 
     29INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN 
     30CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) 
     31ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE 
     32POSSIBILITY OF SUCH DAMAGE. 
     33*/ 
     34 
    535 
    636package loci.multiinstanceplugin; 
     
    939 
    1040/** 
     41 * Interface to the plugin launcher. 
    1142 * 
    12  * @author aivar 
     43 * Each ILinkedPlugin is associated with a plugin class and has a 
     44 * IPluginLauncher that is uses internally to chain its plugin. 
     45 * 
     46 * The plugin launcher communicates with the plugin scheduler. 
     47 * 
     48 * @author Aivar Grislis 
    1349 */ 
    1450public interface IPluginLauncher { 
    1551 
     52    /** 
     53     * Chains this plugin to the next one. 
     54     * 
     55     * @param outName output name for this plugin 
     56     * @param next next plugin 
     57     * @param inName input name for next plugin 
     58     */ 
    1659    public void chainNext(String outName, IPluginLauncher next, String inName); 
    1760 
     61    /** 
     62     * Chains this plugin to the previous one. 
     63     * 
     64     * @param inName input name for this plugin 
     65     * @param previous previous plugin 
     66     * @param outName output namem for previous plugin 
     67     */ 
    1868    public void chainPrevious(String inName, IPluginLauncher previous, String outName); 
    1969 
     70    /** 
     71     * Used to initiate a plugin chain.  This named image becomes the input for 
     72     * this plugin. 
     73     * 
     74     * @param name 
     75     * @param image 
     76     */ 
    2077    public void externalPut(String name, ImageWrapper image); 
    2178 
     79    /** 
     80     * Given a name, makes it unique for this plugin launcher instance. 
     81     * 
     82     * @param name 
     83     * @return 
     84     */ 
    2285    public String uniqueName(String name); 
    2386 
     87    /** 
     88     * Used for plugin chaining.  Called from scheduler.  Tells launcher to 
     89     * associate this plugin's output name with an input name unique to a 
     90     * plugin launcher instance. 
     91     * 
     92     * @param outName 
     93     * @param fullInName 
     94     */ 
    2495    public void associate(String outName, String fullInName); 
    2596 
     97    /** 
     98     * Used to shut down processing. 
     99     */ 
    26100    public void quit(); 
    27101} 
Note: See TracChangeset for help on using the changeset viewer.