com.rapidminer.parameter
Class ParameterTypeFile

java.lang.Object
  com.rapidminer.parameter.ParameterType
      com.rapidminer.parameter.ParameterTypeSingle
          com.rapidminer.parameter.ParameterTypeString
              com.rapidminer.parameter.ParameterTypeFile

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable

Direct Known Subclasses:

ParameterTypeAttributeFile, ParameterTypeDirectory

public class ParameterTypeFile
extends ParameterTypeString

A parameter type for files. Operators ask for the selected file with Operator.getParameterAsFile(String). The extension should be defined without the point (separator).

Author:

Ingo Mierswa, Simon Fischer Exp $

See Also:

Serialized Form

Constructor Summary

ParameterTypeFile(java.lang.String key, java.lang.String description, java.lang.String extension, boolean optional)
Creates a new parameter type for files with the given extension.

ParameterTypeFile(java.lang.String key, java.lang.String description, java.lang.String extension, java.lang.String defaultFileName)
Creates a new parameter type for file with the given extension.

Method Summary

java.lang.String	getExtension()
java.lang.String	getRange() Returns a human readable description of the range.
void	setExtension(java.lang.String extension)

Methods inherited from class com.rapidminer.parameter.ParameterTypeString

getDefaultValue, isNumerical, isOptional, setDefaultValue, setOptional

Methods inherited from class com.rapidminer.parameter.ParameterTypeSingle

getXML

Methods inherited from class com.rapidminer.parameter.ParameterType

compareTo, getDescription, getKey, illegalValue, isExpert, isHidden, registerDependencyCondition, setDescription, setExpert, setHidden, setKey, setShowRange, showRange, toString, toString, toXMLString, transformNewValue

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

ParameterTypeFile

public ParameterTypeFile(java.lang.String key,
                         java.lang.String description,
                         java.lang.String extension,
                         boolean optional)

Creates a new parameter type for files with the given extension. If the extension is null no file filters will be used.

ParameterTypeFile

public ParameterTypeFile(java.lang.String key,
                         java.lang.String description,
                         java.lang.String extension,
                         java.lang.String defaultFileName)

Creates a new parameter type for file with the given extension. If the extension is null no file filters will be used. The parameter will be optional.

Method Detail

getExtension

public java.lang.String getExtension()

setExtension

public void setExtension(java.lang.String extension)

getRange

public java.lang.String getRange()

Description copied from class: ParameterType

Returns a human readable description of the range.

Overrides:

getRange in class ParameterTypeString