mev-4.0.01/source/org/tigr/microarray/mev/script/util/ParameterAttributes.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  * ParameterAttributes.java
2 26 Feb 07 jari 7  *
2 26 Feb 07 jari 8  * Created on May 27, 2004, 9:29 AM
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 the attributes of a given parameter.
2 26 Feb 07 jari 14  * ParameterAttributes is used in conjuction with the
2 26 Feb 07 jari 15  * parameter validation to exchange parameter attributes.
2 26 Feb 07 jari 16  * @author braisted
2 26 Feb 07 jari 17  */
2 26 Feb 07 jari 18 public class ParameterAttributes {
2 26 Feb 07 jari 19     
2 26 Feb 07 jari 20     
2 26 Feb 07 jari 21     /** parameter key used in scripting to refer to the parameter
2 26 Feb 07 jari 22      */
2 26 Feb 07 jari 23     String parameterKey;
2 26 Feb 07 jari 24     /** Type of value (int, float, string, double, long)
2 26 Feb 07 jari 25      *
2 26 Feb 07 jari 26      */
2 26 Feb 07 jari 27     String valueType;
2 26 Feb 07 jari 28     /** Required or dependent on other settings.
2 26 Feb 07 jari 29      */
2 26 Feb 07 jari 30     String valueRequirementLevel;
2 26 Feb 07 jari 31     
2 26 Feb 07 jari 32     /** Returns true if the parameter has constraing limits.
2 26 Feb 07 jari 33      */
2 26 Feb 07 jari 34     boolean hasConstraints;
2 26 Feb 07 jari 35     /** If have constraints, min is storred.
2 26 Feb 07 jari 36      */
2 26 Feb 07 jari 37     String min;
2 26 Feb 07 jari 38     /** Min value
2 26 Feb 07 jari 39      */
2 26 Feb 07 jari 40     String max;
2 26 Feb 07 jari 41     
2 26 Feb 07 jari 42     
2 26 Feb 07 jari 43     /** Creates a new instance of ParameterAttributes
2 26 Feb 07 jari 44      * @param key key values
2 26 Feb 07 jari 45      * @param type value type
2 26 Feb 07 jari 46      * @param level level of requirement.
2 26 Feb 07 jari 47      */
2 26 Feb 07 jari 48     public ParameterAttributes(String key, String type, String level) {
2 26 Feb 07 jari 49         hasConstraints = false;
2 26 Feb 07 jari 50         
2 26 Feb 07 jari 51         parameterKey = key;
2 26 Feb 07 jari 52         valueType = type;
2 26 Feb 07 jari 53         valueRequirementLevel = level;
2 26 Feb 07 jari 54     }
2 26 Feb 07 jari 55     
2 26 Feb 07 jari 56     
2 26 Feb 07 jari 57     /** Creates a new instance of ParameterAttributes
2 26 Feb 07 jari 58      * @param key parameter key
2 26 Feb 07 jari 59      * @param type parameter type
2 26 Feb 07 jari 60      * @param level requirement level
2 26 Feb 07 jari 61      * @param min optional min
2 26 Feb 07 jari 62      * @param max optional max
2 26 Feb 07 jari 63      */
2 26 Feb 07 jari 64     
2 26 Feb 07 jari 65     public ParameterAttributes(String key, String type, String level, String min, String max) {
2 26 Feb 07 jari 66         hasConstraints = true;
2 26 Feb 07 jari 67         this.min = min;
2 26 Feb 07 jari 68         this.max = max;
2 26 Feb 07 jari 69         
2 26 Feb 07 jari 70         parameterKey = key;
2 26 Feb 07 jari 71         valueType = type;
2 26 Feb 07 jari 72         valueRequirementLevel = level;
2 26 Feb 07 jari 73     }
2 26 Feb 07 jari 74     
2 26 Feb 07 jari 75     /** returns true if it's a parameter match.
2 26 Feb 07 jari 76      * @param key Key
2 26 Feb 07 jari 77      * @return
2 26 Feb 07 jari 78      */
2 26 Feb 07 jari 79     public boolean isParameter(String key) {
2 26 Feb 07 jari 80         return (key.equals(parameterKey));
2 26 Feb 07 jari 81     }
2 26 Feb 07 jari 82     
2 26 Feb 07 jari 83     /** Returns true if parameter has constraints.
2 26 Feb 07 jari 84      */
2 26 Feb 07 jari 85     public boolean hasConstraints() {
2 26 Feb 07 jari 86         return hasConstraints;
2 26 Feb 07 jari 87     }
2 26 Feb 07 jari 88     
2 26 Feb 07 jari 89     /** Returns the parameter key.
2 26 Feb 07 jari 90      * @return
2 26 Feb 07 jari 91      */
2 26 Feb 07 jari 92     public String getParameterKey() {
2 26 Feb 07 jari 93         return parameterKey;
2 26 Feb 07 jari 94     }
2 26 Feb 07 jari 95     
2 26 Feb 07 jari 96     /** Returns the value type
2 26 Feb 07 jari 97      */
2 26 Feb 07 jari 98     public String getValueType() {
2 26 Feb 07 jari 99         return valueType;
2 26 Feb 07 jari 100     }
2 26 Feb 07 jari 101     
2 26 Feb 07 jari 102     /** Returns the requirement level.
2 26 Feb 07 jari 103      */
2 26 Feb 07 jari 104     public String getValueRequirementLevel() {
2 26 Feb 07 jari 105         return valueRequirementLevel;
2 26 Feb 07 jari 106     }
2 26 Feb 07 jari 107     
2 26 Feb 07 jari 108     /** Returns the min
2 26 Feb 07 jari 109      */
2 26 Feb 07 jari 110     public String getMin() {
2 26 Feb 07 jari 111         return min;
2 26 Feb 07 jari 112     }
2 26 Feb 07 jari 113     
2 26 Feb 07 jari 114     /** Returns the max
2 26 Feb 07 jari 115      */
2 26 Feb 07 jari 116     public String getMax() {
2 26 Feb 07 jari 117         return max;
2 26 Feb 07 jari 118     }
2 26 Feb 07 jari 119 }

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