com.rapidminer.parameter
Class ParameterTypePassword

java.lang.Object
  extended by com.rapidminer.parameter.ParameterType
      extended by com.rapidminer.parameter.ParameterTypeSingle
          extended by com.rapidminer.parameter.ParameterTypeString
              extended by com.rapidminer.parameter.ParameterTypePassword
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable

public class ParameterTypePassword
extends ParameterTypeString

A parameter for passwords. The parameter is written with asteriks in the GUI but can be read in process configuration file. Please make sure that noone but the user can read the password from such a file.

Author:
Ingo Mierswa, Simon Fischer ingomierswa Exp $
See Also:
Serialized Form

Constructor Summary
ParameterTypePassword(java.lang.String key, java.lang.String description)
           
 
Method Summary
 java.lang.String getRange()
          Returns a human readable description of the range.
 java.lang.String getXML(java.lang.String indent, java.lang.String key, java.lang.String value, boolean hideDefault)
          Writes an xml representation of the given key-value pair.
 java.lang.String toString(java.lang.Object value)
          Returns a string representation of this value.
 java.lang.String transformNewValue(java.lang.String value)
          This method will be invoked by the Parameters after a parameter was set and will decrypt the given value.
 
Methods inherited from class com.rapidminer.parameter.ParameterTypeString
getDefaultValue, isNumerical, isOptional, setDefaultValue, setOptional
 
Methods inherited from class com.rapidminer.parameter.ParameterType
compareTo, getDescription, getKey, illegalValue, isExpert, isHidden, registerDependencyCondition, setDescription, setExpert, setHidden, setKey, setShowRange, showRange, toString, toXMLString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

ParameterTypePassword

public ParameterTypePassword(java.lang.String key,
                             java.lang.String description)
Method Detail

getRange

public java.lang.String getRange()
Description copied from class: ParameterType
Returns a human readable description of the range.

Overrides:
getRange in class ParameterTypeString

transformNewValue

public java.lang.String transformNewValue(java.lang.String value)
This method will be invoked by the Parameters after a parameter was set and will decrypt the given value.

Overrides:
transformNewValue in class ParameterType

toString

public java.lang.String toString(java.lang.Object value)
Description copied from class: ParameterType
Returns a string representation of this value.

Overrides:
toString in class ParameterType

getXML

public java.lang.String getXML(java.lang.String indent,
                               java.lang.String key,
                               java.lang.String value,
                               boolean hideDefault)
Description copied from class: ParameterType
Writes an xml representation of the given key-value pair.

Overrides:
getXML in class ParameterTypeSingle


Copyright © 2001-2009 by Rapid-I