org.genepattern.webservice
Class ParameterInfo

java.lang.Object
  extended byorg.genepattern.webservice.ParameterInfo
All Implemented Interfaces:
java.io.Serializable

public class ParameterInfo
extends java.lang.Object
implements java.io.Serializable

See Also:
Serialized Form

Field Summary
static java.lang.String CACHED_INPUT_MODE
           
static java.lang.String FILE_TYPE
           
static java.lang.String INPUT_MODE
           
static java.lang.String MODE
           
static java.lang.String OUTPUT_MODE
           
static java.lang.String TYPE
           
static java.lang.String URL_INPUT_MODE
           
 
Constructor Summary
ParameterInfo()
          Creates new ParameterInfo
ParameterInfo(java.lang.String name, java.lang.String value, java.lang.String description)
           
 
Method Summary
 java.util.HashMap getAttributes()
          Gets HashMap attributes
 java.lang.String[] getChoices(java.lang.String delimiter)
           
 java.lang.String getDescription()
           
 java.lang.String getLabel()
          Gets the parameter displaying label.
 java.lang.String getName()
           
 java.lang.String getUIValue(ParameterInfo formalParam)
           
 java.lang.String getValue()
           
 boolean hasChoices(java.lang.String delimiter)
           
 boolean isInputFile()
          Checks to see if this parameter is used to specify uploaded file from client.
 boolean isOutputFile()
          Checks to see if this parameter is used to specify output file from server
 void setAsInputFile()
          Sets this as an input file parameter.
 void setAsOutputFile()
          Sets this as an output file parameter.
 void setAttributes(java.util.HashMap attributes)
          Sets attributes for the ParameterInfo
 void setDescription(java.lang.String description)
           
 void setLabel(java.lang.String label)
          Sets the parameter displaying label
 void setName(java.lang.String name)
           
 void setValue(java.lang.String value)
           
 java.lang.String toString()
          returns a String representation of this
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Field Detail

TYPE

public static final java.lang.String TYPE
See Also:
Constant Field Values

MODE

public static final java.lang.String MODE
See Also:
Constant Field Values

FILE_TYPE

public static final java.lang.String FILE_TYPE
See Also:
Constant Field Values

INPUT_MODE

public static final java.lang.String INPUT_MODE
See Also:
Constant Field Values

OUTPUT_MODE

public static final java.lang.String OUTPUT_MODE
See Also:
Constant Field Values

CACHED_INPUT_MODE

public static final java.lang.String CACHED_INPUT_MODE
See Also:
Constant Field Values

URL_INPUT_MODE

public static final java.lang.String URL_INPUT_MODE
See Also:
Constant Field Values
Constructor Detail

ParameterInfo

public ParameterInfo()
Creates new ParameterInfo


ParameterInfo

public ParameterInfo(java.lang.String name,
                     java.lang.String value,
                     java.lang.String description)
Method Detail

setName

public void setName(java.lang.String name)

getName

public java.lang.String getName()

setValue

public void setValue(java.lang.String value)

getValue

public java.lang.String getValue()

setDescription

public void setDescription(java.lang.String description)

getDescription

public java.lang.String getDescription()

setAttributes

public void setAttributes(java.util.HashMap attributes)
Sets attributes for the ParameterInfo

Parameters:
attributes - a HashMap containing detail information about this parameter

getAttributes

public java.util.HashMap getAttributes()
Gets HashMap attributes

Returns:
HashMap attributes containing keys as described in the public static field, and values for description of detail information about the parameter

isInputFile

public boolean isInputFile()
Checks to see if this parameter is used to specify uploaded file from client.

Returns:
true if this is a uploaded file from client

isOutputFile

public boolean isOutputFile()
Checks to see if this parameter is used to specify output file from server

Returns:
true if this is used to specify result file from server

setAsInputFile

public void setAsInputFile()
Sets this as an input file parameter.


setAsOutputFile

public void setAsOutputFile()
Sets this as an output file parameter.


toString

public java.lang.String toString()
returns a String representation of this


hasChoices

public boolean hasChoices(java.lang.String delimiter)

getChoices

public java.lang.String[] getChoices(java.lang.String delimiter)

getUIValue

public java.lang.String getUIValue(ParameterInfo formalParam)

getLabel

public java.lang.String getLabel()
Gets the parameter displaying label.

Returns:
displaying label as a String

setLabel

public void setLabel(java.lang.String label)
Sets the parameter displaying label

Parameters:
label - used as displaying purpose


Hosted by docs.bugaco.com