mev-4.0.01/source/org/tigr/microarray/mev/script/util/ScriptParameterException.java

Code
Comments
Other
Rev Date Author Line
2 26 Feb 07 jari 1 /*
2 26 Feb 07 jari 2 Copyright @ 1999-2004, The Institute for Genomic Research (TIGR).
2 26 Feb 07 jari 3 All rights reserved.
2 26 Feb 07 jari 4 */
2 26 Feb 07 jari 5 /*
2 26 Feb 07 jari 6  * ScriptParameterException.java
2 26 Feb 07 jari 7  *
2 26 Feb 07 jari 8  * Created on March 29, 2004, 12:09 PM
2 26 Feb 07 jari 9  */
2 26 Feb 07 jari 10
2 26 Feb 07 jari 11 package org.tigr.microarray.mev.script.util;
2 26 Feb 07 jari 12
2 26 Feb 07 jari 13 /** Encapsulates information about script parse errors or parameter
2 26 Feb 07 jari 14  * errors.
2 26 Feb 07 jari 15  * @author braisted
2 26 Feb 07 jari 16  */
2 26 Feb 07 jari 17 public class ScriptParameterException extends java.lang.Exception {
2 26 Feb 07 jari 18     
2 26 Feb 07 jari 19     /** algorithm name
2 26 Feb 07 jari 20      */    
2 26 Feb 07 jari 21     private String algName;
2 26 Feb 07 jari 22     /** algorithm index, for possitive id with algName
2 26 Feb 07 jari 23      */    
2 26 Feb 07 jari 24     private int algIndex;
2 26 Feb 07 jari 25     /** Input data reference to the algorithm generating
2 26 Feb 07 jari 26      * the exception
2 26 Feb 07 jari 27      */    
2 26 Feb 07 jari 28     private int dataRef;
2 26 Feb 07 jari 29     /** parameter key
2 26 Feb 07 jari 30      */    
2 26 Feb 07 jari 31     private String key;
2 26 Feb 07 jari 32     /** parameter value
2 26 Feb 07 jari 33      */    
2 26 Feb 07 jari 34     private String value;
2 26 Feb 07 jari 35     /** Error message
2 26 Feb 07 jari 36      */    
2 26 Feb 07 jari 37     private String message;
2 26 Feb 07 jari 38
2 26 Feb 07 jari 39     /** Exception class
2 26 Feb 07 jari 40      */    
2 26 Feb 07 jari 41     public static final int INVALID_KEY_EXCEPTION = 0;
2 26 Feb 07 jari 42     /** exception class
2 26 Feb 07 jari 43      */    
2 26 Feb 07 jari 44     public static final int MISSING_REQUIRED_PARAMETER_EXCEPTION = 1;
2 26 Feb 07 jari 45     /** exception class
2 26 Feb 07 jari 46      */    
2 26 Feb 07 jari 47     public static final int INVALID_VALUE_TYPE_EXCEPTION = 2;
2 26 Feb 07 jari 48
2 26 Feb 07 jari 49     /** Creates a new instance of <code>ScriptParameterException</code> without detail message.
2 26 Feb 07 jari 50      * @param algName algorithm name
2 26 Feb 07 jari 51      * @param algIndex algorithm index
2 26 Feb 07 jari 52      * @param dataRef input data reference
2 26 Feb 07 jari 53      * @param key parameter key
2 26 Feb 07 jari 54      * @param value parameter value
2 26 Feb 07 jari 55      * @param message error message
2 26 Feb 07 jari 56      */
2 26 Feb 07 jari 57     public ScriptParameterException(String algName, int algIndex, int dataRef, String key, String value, String message) {
2 26 Feb 07 jari 58         this.algName = algName;
2 26 Feb 07 jari 59         this.algIndex = algIndex;
2 26 Feb 07 jari 60         this.dataRef = dataRef;
2 26 Feb 07 jari 61         this.key = key;
2 26 Feb 07 jari 62         this.message = message;
2 26 Feb 07 jari 63     }
2 26 Feb 07 jari 64         
2 26 Feb 07 jari 65     /**
2 26 Feb 07 jari 66      * Constructs an instance of <code>ScriptParameterException</code> with the specified detail message.
2 26 Feb 07 jari 67      * @param msg the detail message.
2 26 Feb 07 jari 68      */
2 26 Feb 07 jari 69     public ScriptParameterException(String msg) {
2 26 Feb 07 jari 70         super(msg);
2 26 Feb 07 jari 71     }
2 26 Feb 07 jari 72     
2 26 Feb 07 jari 73     /** Returns algorithm name
2 26 Feb 07 jari 74      */    
2 26 Feb 07 jari 75     public String getAlgoritmName() {
2 26 Feb 07 jari 76         return algName;
2 26 Feb 07 jari 77     }
2 26 Feb 07 jari 78     
2 26 Feb 07 jari 79     /** Returns alg index
2 26 Feb 07 jari 80      */    
2 26 Feb 07 jari 81     public int getAlgorithmIndex() {
2 26 Feb 07 jari 82         return algIndex;
2 26 Feb 07 jari 83     }
2 26 Feb 07 jari 84     
2 26 Feb 07 jari 85     /** Returns data reference
2 26 Feb 07 jari 86      */    
2 26 Feb 07 jari 87     public int getDataReference() {
2 26 Feb 07 jari 88         return dataRef;
2 26 Feb 07 jari 89     }
2 26 Feb 07 jari 90
2 26 Feb 07 jari 91     /** returns algorithm key
2 26 Feb 07 jari 92      */    
2 26 Feb 07 jari 93     public String getKey() {
2 26 Feb 07 jari 94         return key;
2 26 Feb 07 jari 95     }
2 26 Feb 07 jari 96
2 26 Feb 07 jari 97     /** returns the error message
2 26 Feb 07 jari 98      */    
2 26 Feb 07 jari 99     public String getMessage() {
2 26 Feb 07 jari 100         return message;
2 26 Feb 07 jari 101     }
2 26 Feb 07 jari 102     
2 26 Feb 07 jari 103 }

Generated on Thu Jul 20 09:30:41 2023 (UTC) by svndigest 0.11.2pre (dev build 1672)