View Javadoc

1   /*
2    *                Doelan development code
3    *
4    * This code may be freely distributed and modified under the
5    * terms of the GNU General Public Licence.  This should
6    * be distributed with the code. If you do not have a copy,
7    * see:
8    *
9    *      http://www.gnu.org/copyleft/gpl.txt
10   *
11   * Copyright (c) 2004-2005 ENS Microarray Platform
12   * Copyright for this code is held jointly by the individual
13   * authors.  These should be listed in @author doc comments.
14   *
15   * For more information on the Doelan project and its aims,
16   * or to join the Doelan mailing list, visit the home page
17   * at:
18   *
19   *      http://www.transcriptome.ens.fr/doelan
20   */
21  
22  package fr.ens.transcriptome.doelan.algorithms;
23  
24  import fr.ens.transcriptome.nividic.platform.PlatformException;
25  import fr.ens.transcriptome.nividic.platform.module.Module;
26  import fr.ens.transcriptome.nividic.platform.workflow.Algorithm;
27  
28  /***
29   * This class is the super class of QualityUnitTest and QualityGlobalTest.
30   * @author Laurent Jourdren
31   */
32  public abstract class QualityTest extends Algorithm implements Module {
33  
34    /*** Identifier for result event. */
35    public static final int RESULT_EVENT = 1000;
36  
37    /*** Identifier for result event. */
38    public static final int GLOBAL_TEST_INIT_EVENT = 1001;
39  
40    /*** Identifier for result event. */
41    public static final int CONFIGURE_TEST_EVENT = 1002;
42  
43    /***
44     * Test if the test is deletable().
45     * @return true if the test is deletable
46     */
47    public abstract boolean isDeletable();
48  
49    /***
50     * Test if the test is modifiable.
51     * @return true if the test is modifiable
52     */
53    public abstract boolean isModifiable();
54  
55    /***
56     * Test if the test could be showed.
57     * @return true if the test could be showed
58     */
59    public abstract boolean isShowable();
60  
61    /***
62     * Test if the test could be diplayed in the list of tests to add.
63     * @return true if the test could be showed
64     */
65    public abstract boolean isAddable();
66  
67    /***
68     * Test if only one instance of the test could be created.
69     * @return true if only one instance of the test could be created
70     */
71    public abstract boolean isUniqueInstance();
72  
73    //
74    // Constructor
75    //
76  
77    /***
78     * Public constructor.
79     * @throws PlatformException If the name or the version of the element is
80     *                 <b>null </b>.
81     */
82    public QualityTest() throws PlatformException {
83      // MUST BE EMPTY
84    }
85  
86  }