com.rapidminer
Class RapidMiner

java.lang.Object
  com.rapidminer.RapidMiner

Direct Known Subclasses:

RapidMinerCommandLine, RapidMinerGUI

public class RapidMiner
extends java.lang.Object

Main program. Entry point for command line programm, GUI and wrappers. Please note that applications which use RapidMiner as a data mining library will have to invoke one of the init methods provided by this class before applying processes or operators. Several init methods exist and choosing the correct one with optimal parameters might drastically reduce runtime and / or initialization time.

Author:

Ingo Mierswa

Nested Class Summary

static class	RapidMiner.ExecutionMode Indicates how RapidMiner is being executed.
static class	RapidMiner.ExitMode

Field Summary

static java.lang.String	PROCESS_FILE_EXTENSION
static java.lang.String	PROPERTY_DEVELOPER_MODE Enables special features for developers: Validate process action, operator doc editor, etc.
static java.lang.String	PROPERTY_HOME_REPOSITORY_URL
static java.lang.String	PROPERTY_HOME_REPOSITORY_USER
static java.lang.String	PROPERTY_RAPIDMINER_GENERAL_DEBUGMODE The property name for "Indicates if RapidMiner should be used in debug mode (print exception stacks and shows more technical error messages)"
static java.lang.String	PROPERTY_RAPIDMINER_GENERAL_DEFAULT_ENCODING The name of the property indicating the default encoding for files.
static java.lang.String	PROPERTY_RAPIDMINER_GENERAL_FRACTIONDIGITS_NUMBERS The property name for "The number of fraction digits of formatted numbers.
static java.lang.String	PROPERTY_RAPIDMINER_GENERAL_FRACTIONDIGITS_PERCENT The property name for "The number of fraction digits of formatted percent values.
static java.lang.String	PROPERTY_RAPIDMINER_GENERAL_LOGFILE_FORMAT The property name for "Use unix special characters for logfile highlighting (requires new RapidMiner instance).
static java.lang.String	PROPERTY_RAPIDMINER_GENERAL_MAX_META_DATA_ATTRIBUTES The name of the property indicating the maximum number of attributes stored for shortened meta data transformation.
static java.lang.String	PROPERTY_RAPIDMINER_GENERAL_MAX_NOMINAL_VALUES The name of the property indicating the maximum number of nominal values to store for meta data transformation.
static java.lang.String	PROPERTY_RAPIDMINER_GENERAL_MAX_TEST_ROWS The name of the property defining how many lines are read for guessing values types for input operations without defined value type.
static java.lang.String	PROPERTY_RAPIDMINER_GENERAL_TIME_ZONE The name of the property indicating the preferred globally used time zone.
static java.lang.String	PROPERTY_RAPIDMINER_GLOBAL_LOG_FILE The name of the property indicating the path to the global logging file.
static java.lang.String	PROPERTY_RAPIDMINER_GLOBAL_LOG_VERBOSITY The name of the property indicating the path to the global logging file.
static java.lang.String	PROPERTY_RAPIDMINER_INIT_LOCALE_COUNTRY
static java.lang.String	PROPERTY_RAPIDMINER_INIT_LOCALE_LANGUAGE
static java.lang.String	PROPERTY_RAPIDMINER_INIT_LOCALE_VARIANT
static java.lang.String	PROPERTY_RAPIDMINER_INIT_OPERATORS A file path to an operator description XML file.
static java.lang.String	PROPERTY_RAPIDMINER_INIT_PLUGINS Boolean parameter indicating if the plugins should be initialized at all.
static java.lang.String	PROPERTY_RAPIDMINER_INIT_PLUGINS_LOCATION A file path to the directory containing the plugin Jar files.
static java.lang.String	PROPERTY_RAPIDMINER_OBJECTS_ADDITIONAL The name of the property indicating the path to additional ioobjects description XML file(s).
static java.lang.String	PROPERTY_RAPIDMINER_OPERATORS_ADDITIONAL The name of the property indicating the path to a additional operator description XML file(s).
static java.lang.String	PROPERTY_RAPIDMINER_RC_FILE The name of the property indicating the path to an RC file (settings).
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_DB_ONLY_STANDARD_TABLES If set to true, the query builders and database assistants and query_builders show only standard tables (no views and system tables).
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_EDITOR The property name for "Path to external Java editor.
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_MAIL_DEFAULT_PROCESS_DURATION_FOR_MAIL The default value of the minimum time a process must run such that it sends a notification mail upon completion.
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_MAIL_DEFAULT_RECIPIENT Property specifying the email address to which mails are sent if no email address is specified in the ProcessRootOperator.
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD The property specifying the method to send mails.
static int	PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD_SENDMAIL
static int	PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD_SMTP
static java.lang.String[]	PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD_VALUES
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_SENDMAIL_COMMAND The property name for "Path to sendmail.
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_SMTP_HOST The property name for "The smtp host.
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_SMTP_PASSWD The property name for the "SMTP pssword (is necessary).
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_SMTP_PORT The property name for "The smtp port.
static java.lang.String	PROPERTY_RAPIDMINER_TOOLS_SMTP_USER The property name for the "SMTP user.
static java.lang.String	PROPERTY_RAPIDMINER_VERSION The name of the property indicating the version of RapidMiner (read only).
static java.lang.String	SYSTEM_ENCODING_NAME

Constructor Summary

RapidMiner()

Method Summary

static void	addShutdownHook(java.lang.Runnable runnable)
static RapidMiner.ExecutionMode	getExecutionMode()
static InputHandler	getInputHandler()
static java.lang.String	getLongVersion()
static java.util.Set<ParameterType>	getRapidMinerProperties() Returns a set of ParameterTypes for the RapidMiner system properties.
static java.lang.String	getRapidMinerPropertyValue(java.lang.String property) This method will return the value of an registered RapidMiner Property or null if no property is known with the given identifier.
static java.lang.String	getShortVersion()
static SplashScreen	getSplashScreen()
static java.awt.Frame	getSplashScreenFrame()
static VersionNumber	getVersion()
static java.util.Set<ParameterType>	getYaleProperties() Deprecated. Use getRapidMinerProperties() instead
static void	hideSplash()
static void	init() Initializes RapidMiner.
static void	quit(RapidMiner.ExitMode exitMode)
static Process	readExperimentFile(java.io.File experimentfile) Deprecated. Use readProcessFile(File) instead
static Process	readProcessFile(java.io.File processFile)
static Process	readProcessFile(java.io.File processFile, ProgressListener progressListener)
static void	registerRapidMinerProperty(ParameterType type) This registers a property with the name of the given ParameterType.
static void	registerYaleProperty(ParameterType type) Deprecated. Use registerRapidMinerProperty(ParameterType) instead
static void	setExecutionMode(RapidMiner.ExecutionMode executionMode)
static void	setInputHandler(InputHandler inputHandler)
static void	setLocale(java.lang.String language, java.lang.String country, java.lang.String variant)
static void	setRapidMinerPropertyValue(java.lang.String property, java.lang.String value) This method will set the given property to the given value.
static SplashScreen	showSplash()
static SplashScreen	showSplash(java.awt.Image productLogo)
static void	splashMessage(java.lang.String messageKey) Displays the message with 18n key gui.splash.messageKey.
static void	splashMessage(java.lang.String messageKey, java.lang.Object... args) Displays the formatted message with 18n key gui.splash.messageKey.

Methods inherited from class java.lang.Object

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

Field Detail

SYSTEM_ENCODING_NAME

public static final java.lang.String SYSTEM_ENCODING_NAME

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_VERSION

public static final java.lang.String PROPERTY_RAPIDMINER_VERSION

The name of the property indicating the version of RapidMiner (read only).

See Also:

Constant Field Values

PROPERTY_DEVELOPER_MODE

public static final java.lang.String PROPERTY_DEVELOPER_MODE

Enables special features for developers: Validate process action, operator doc editor, etc.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_OPERATORS_ADDITIONAL

public static final java.lang.String PROPERTY_RAPIDMINER_OPERATORS_ADDITIONAL

The name of the property indicating the path to a additional operator description XML file(s). If more than one, then the files have to be separated using the File.pathSeparator character.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_OBJECTS_ADDITIONAL

public static final java.lang.String PROPERTY_RAPIDMINER_OBJECTS_ADDITIONAL

The name of the property indicating the path to additional ioobjects description XML file(s). If more than one, then the files have to be separated using the File.pathSeparator character.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_RC_FILE

public static final java.lang.String PROPERTY_RAPIDMINER_RC_FILE

The name of the property indicating the path to an RC file (settings).

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GLOBAL_LOG_FILE

public static final java.lang.String PROPERTY_RAPIDMINER_GLOBAL_LOG_FILE

The name of the property indicating the path to the global logging file.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GLOBAL_LOG_VERBOSITY

public static final java.lang.String PROPERTY_RAPIDMINER_GLOBAL_LOG_VERBOSITY

The name of the property indicating the path to the global logging file.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_INIT_OPERATORS

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_OPERATORS

A file path to an operator description XML file.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_INIT_LOCALE_LANGUAGE

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_LOCALE_LANGUAGE

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_INIT_LOCALE_COUNTRY

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_LOCALE_COUNTRY

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_INIT_LOCALE_VARIANT

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_LOCALE_VARIANT

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_INIT_PLUGINS

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_PLUGINS

Boolean parameter indicating if the plugins should be initialized at all.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_INIT_PLUGINS_LOCATION

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_PLUGINS_LOCATION

A file path to the directory containing the plugin Jar files.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GENERAL_FRACTIONDIGITS_NUMBERS

public static final java.lang.String PROPERTY_RAPIDMINER_GENERAL_FRACTIONDIGITS_NUMBERS

The property name for "The number of fraction digits of formatted numbers."

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GENERAL_FRACTIONDIGITS_PERCENT

public static final java.lang.String PROPERTY_RAPIDMINER_GENERAL_FRACTIONDIGITS_PERCENT

The property name for "The number of fraction digits of formatted percent values."

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GENERAL_MAX_META_DATA_ATTRIBUTES

public static final java.lang.String PROPERTY_RAPIDMINER_GENERAL_MAX_META_DATA_ATTRIBUTES

The name of the property indicating the maximum number of attributes stored for shortened meta data transformation.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GENERAL_MAX_NOMINAL_VALUES

public static final java.lang.String PROPERTY_RAPIDMINER_GENERAL_MAX_NOMINAL_VALUES

The name of the property indicating the maximum number of nominal values to store for meta data transformation.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GENERAL_MAX_TEST_ROWS

public static final java.lang.String PROPERTY_RAPIDMINER_GENERAL_MAX_TEST_ROWS

The name of the property defining how many lines are read for guessing values types for input operations without defined value type.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_EDITOR

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_EDITOR

The property name for "Path to external Java editor. %f is replaced by filename and %l by the linenumber."

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD

The property specifying the method to send mails. Either SMTP or sendmail.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD_VALUES

public static final java.lang.String[] PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD_VALUES

PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD_SENDMAIL

public static final int PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD_SENDMAIL

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD_SMTP

public static final int PROPERTY_RAPIDMINER_TOOLS_MAIL_METHOD_SMTP

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_MAIL_DEFAULT_RECIPIENT

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_MAIL_DEFAULT_RECIPIENT

Property specifying the email address to which mails are sent if no email address is specified in the ProcessRootOperator.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_MAIL_DEFAULT_PROCESS_DURATION_FOR_MAIL

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_MAIL_DEFAULT_PROCESS_DURATION_FOR_MAIL

The default value of the minimum time a process must run such that it sends a notification mail upon completion.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_SENDMAIL_COMMAND

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_SENDMAIL_COMMAND

The property name for "Path to sendmail. Used for email notifications."

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_SMTP_HOST

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_SMTP_HOST

The property name for "The smtp host. Used for email notifications."

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_SMTP_PORT

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_SMTP_PORT

The property name for "The smtp port. Used for email notifications."

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_SMTP_USER

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_SMTP_USER

The property name for the "SMTP user. Used for email notifications."

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_SMTP_PASSWD

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_SMTP_PASSWD

The property name for the "SMTP pssword (is necessary). Used for email notifications."

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_TOOLS_DB_ONLY_STANDARD_TABLES

public static final java.lang.String PROPERTY_RAPIDMINER_TOOLS_DB_ONLY_STANDARD_TABLES

If set to true, the query builders and database assistants and query_builders show only standard tables (no views and system tables).

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GENERAL_LOGFILE_FORMAT

public static final java.lang.String PROPERTY_RAPIDMINER_GENERAL_LOGFILE_FORMAT

The property name for "Use unix special characters for logfile highlighting (requires new RapidMiner instance)."

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GENERAL_DEBUGMODE

public static final java.lang.String PROPERTY_RAPIDMINER_GENERAL_DEBUGMODE

The property name for "Indicates if RapidMiner should be used in debug mode (print exception stacks and shows more technical error messages)"

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GENERAL_DEFAULT_ENCODING

public static final java.lang.String PROPERTY_RAPIDMINER_GENERAL_DEFAULT_ENCODING

The name of the property indicating the default encoding for files.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_GENERAL_TIME_ZONE

public static final java.lang.String PROPERTY_RAPIDMINER_GENERAL_TIME_ZONE

The name of the property indicating the preferred globally used time zone.

See Also:

Constant Field Values

PROCESS_FILE_EXTENSION

public static final java.lang.String PROCESS_FILE_EXTENSION

See Also:

Constant Field Values

PROPERTY_HOME_REPOSITORY_URL

public static final java.lang.String PROPERTY_HOME_REPOSITORY_URL

See Also:

Constant Field Values

PROPERTY_HOME_REPOSITORY_USER

public static final java.lang.String PROPERTY_HOME_REPOSITORY_USER

See Also:

Constant Field Values

Constructor Detail

RapidMiner

public RapidMiner()

Method Detail

getShortVersion

public static java.lang.String getShortVersion()

getLongVersion

public static java.lang.String getLongVersion()

getVersion

public static VersionNumber getVersion()

readExperimentFile

@Deprecated
public static Process readExperimentFile(java.io.File experimentfile)
                                  throws XMLException,
                                         java.io.IOException,
                                         java.lang.InstantiationException,
                                         java.lang.IllegalAccessException

Deprecated. Use readProcessFile(File) instead

Throws:

XMLException

java.io.IOException

java.lang.InstantiationException

java.lang.IllegalAccessException

readProcessFile

public static Process readProcessFile(java.io.File processFile)
                               throws XMLException,
                                      java.io.IOException,
                                      java.lang.InstantiationException,
                                      java.lang.IllegalAccessException

Throws:

XMLException

java.io.IOException

java.lang.InstantiationException

java.lang.IllegalAccessException

readProcessFile

public static Process readProcessFile(java.io.File processFile,
                                      ProgressListener progressListener)
                               throws XMLException,
                                      java.io.IOException,
                                      java.lang.InstantiationException,
                                      java.lang.IllegalAccessException

Throws:

XMLException

java.io.IOException

java.lang.InstantiationException

java.lang.IllegalAccessException

init

public static void init()

Initializes RapidMiner. During initialization, the following system properties are evaluated. All can be specified in one of the RapidMiner configuration files, by using System.setProperty(String, String), or by passing a -Dkey=value to the Java executable.

• rapidminer.init.operators (file path)
• rapidminer.init.plugins (true or false)
• rapidminer.init.plugins.location (directory path)
• rapidminer.init.weka (true or false)
• rapidminer.init.jdbc.lib (true or false)
• rapidminer.init.jdbc.lib.location (directory path)
• rapidminer.init.jdbc.classpath (true or false)

showSplash

public static SplashScreen showSplash()

showSplash

public static SplashScreen showSplash(java.awt.Image productLogo)

hideSplash

public static void hideSplash()

splashMessage

public static void splashMessage(java.lang.String messageKey)

Displays the message with 18n key gui.splash.messageKey.

splashMessage

public static void splashMessage(java.lang.String messageKey,
                                 java.lang.Object... args)

Displays the formatted message with 18n key gui.splash.messageKey.

getSplashScreen

public static SplashScreen getSplashScreen()

getSplashScreenFrame

public static java.awt.Frame getSplashScreenFrame()

setInputHandler

public static void setInputHandler(InputHandler inputHandler)

getInputHandler

public static InputHandler getInputHandler()

getYaleProperties

@Deprecated
public static java.util.Set<ParameterType> getYaleProperties()

Deprecated. Use getRapidMinerProperties() instead

Returns a set of ParameterTypes for the RapidMiner system properties.

getRapidMinerProperties

public static java.util.Set<ParameterType> getRapidMinerProperties()

Returns a set of ParameterTypes for the RapidMiner system properties.

registerYaleProperty

@Deprecated
public static void registerYaleProperty(ParameterType type)

Deprecated. Use registerRapidMinerProperty(ParameterType) instead

registerRapidMinerProperty

public static void registerRapidMinerProperty(ParameterType type)

This registers a property with the name of the given ParameterType. For convenience the property is of this type, for offering the user a reasonable interface.

getRapidMinerPropertyValue

public static java.lang.String getRapidMinerPropertyValue(java.lang.String property)

This method will return the value of an registered RapidMiner Property or null if no property is known with the given identifier.

Parameters:

property - The identifier of the property

Returns:

the String value of the property or null if property is unknown.

setRapidMinerPropertyValue

public static void setRapidMinerPropertyValue(java.lang.String property,
                                              java.lang.String value)

This method will set the given property to the given value.

addShutdownHook

public static void addShutdownHook(java.lang.Runnable runnable)

quit

public static void quit(RapidMiner.ExitMode exitMode)

getExecutionMode

public static RapidMiner.ExecutionMode getExecutionMode()

setExecutionMode

public static void setExecutionMode(RapidMiner.ExecutionMode executionMode)

setLocale

public static void setLocale(java.lang.String language,
                             java.lang.String country,
                             java.lang.String variant)