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

Field Summary

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_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_HOME The name of the property indicating the home directory of RapidMiner.
static java.lang.String	PROPERTY_RAPIDMINER_INIT_JDBC_CLASSPATH Boolean parameter indicating if the drivers located somewhere in the classpath should be initialized.
static java.lang.String	PROPERTY_RAPIDMINER_INIT_JDBC_LIB Boolean parameter indicating if the drivers located in the lib directory of RapidMiner should be initialized.
static java.lang.String	PROPERTY_RAPIDMINER_INIT_JDBC_LIB_LOCATION A file path to the directory containing the JDBC drivers (usually the lib/jdbc directory of RapidMiner).
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_INIT_WEKA Boolean parameter indicating if the operators based on Weka should be initialized.
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_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.
static java.lang.String	PROPERTY_RAPIDMINER_WEKA_JAR The name of the property indicating the path to the Weka Jar file.
static java.lang.String	SYSTEM_ENCODING_NAME

Constructor Summary

RapidMiner()

Method Summary

static void	cleanUp() Cleans up the object visualizers available for this process and clears the current temp directory.
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	getShortVersion()
static SplashScreen	getSplashScreen()
static java.awt.Frame	getSplashScreenFrame()
static java.util.Set<ParameterType>	getYaleProperties() Deprecated. Use getRapidMinerProperties() instead
static void	hideSplash()
static void	init() Initializes RapidMiner.
static void	init(boolean addWekaOperators, boolean searchJDBCInLibDir, boolean searchJDBCInClasspath, boolean addPlugins) Initializes RapidMiner with its core operators.
static void	init(java.io.InputStream operatorsXMLStream, boolean addWekaOperators, boolean searchJDBCInLibDir, boolean searchJDBCInClasspath, boolean addPlugins) Initializes RapidMiner.
static void	init(java.io.InputStream operatorsXMLStream, java.io.File pluginDir, boolean addWekaOperators, boolean searchJDBCInLibDir, boolean searchJDBCInClasspath, boolean addPlugins) Initializes RapidMiner.
static void	init(java.io.InputStream operatorsXMLStream, java.io.File pluginDir, java.io.File jdbcDir, boolean addWekaOperators, boolean searchJDBCInLibDir, boolean searchJDBCInClasspath, boolean addPlugins) Initializes RapidMiner.
static void	init(java.io.InputStream operatorsXMLStream, java.io.InputStream additionalXMLStream, java.io.File pluginDir, java.io.File jdbcDir, boolean addWekaOperators, boolean searchJDBCInLibDir, boolean searchJDBCInClasspath, boolean addPlugins) Initializes RapidMiner.
static void	quit(int errorcode)
static Process	readExperimentFile(java.io.File experimentfile) Deprecated. Use readProcessFile(File) instead
static Process	readProcessFile(java.io.File processFile)
static void	registerRapidMinerProperty(ParameterType type)
static void	registerYaleProperty(ParameterType type) Deprecated. Use registerRapidMinerProperty(ParameterType) instead
static void	setInputHandler(InputHandler inputHandler)
static SplashScreen	showSplash()
static SplashScreen	showSplash(java.awt.Image productLogo)
static void	splashMessage(java.lang.String message)

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_HOME

public static final java.lang.String PROPERTY_RAPIDMINER_HOME

The name of the property indicating the home directory of RapidMiner.

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.

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_WEKA_JAR

public static final java.lang.String PROPERTY_RAPIDMINER_WEKA_JAR

The name of the property indicating the path to the Weka Jar file.

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_WEKA

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_WEKA

Boolean parameter indicating if the operators based on Weka should be initialized.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_INIT_JDBC_LIB_LOCATION

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_JDBC_LIB_LOCATION

A file path to the directory containing the JDBC drivers (usually the lib/jdbc directory of RapidMiner).

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_INIT_JDBC_LIB

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_JDBC_LIB

Boolean parameter indicating if the drivers located in the lib directory of RapidMiner should be initialized.

See Also:

Constant Field Values

PROPERTY_RAPIDMINER_INIT_JDBC_CLASSPATH

public static final java.lang.String PROPERTY_RAPIDMINER_INIT_JDBC_CLASSPATH

Boolean parameter indicating if the drivers located somewhere in the classpath should be initialized.

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_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_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

Constructor Detail

RapidMiner

public RapidMiner()

Method Detail

getShortVersion

public static java.lang.String getShortVersion()

getLongVersion

public static java.lang.String getLongVersion()

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

init

public static void init(java.io.InputStream operatorsXMLStream,
                        java.io.File pluginDir,
                        boolean addWekaOperators,
                        boolean searchJDBCInLibDir,
                        boolean searchJDBCInClasspath,
                        boolean addPlugins)

Initializes RapidMiner.

Parameters:

operatorsXMLStream - the stream to the operators.xml (operator description), use core operators.xml if null

pluginDir - the directory where plugins are located, use core plugin directory if null

addWekaOperators - inidcates if the operator wrappers for Weka should be loaded

searchJDBCInLibDir - indicates if JDBC drivers from the directory RAPID_MINER_HOME/lib/jdbc should be loaded

searchJDBCInClasspath - indicates if JDBC drivers from the classpath libraries should be loaded

addPlugins - indicates if the plugins should be loaded

init

public static void init(java.io.InputStream operatorsXMLStream,
                        java.io.File pluginDir,
                        java.io.File jdbcDir,
                        boolean addWekaOperators,
                        boolean searchJDBCInLibDir,
                        boolean searchJDBCInClasspath,
                        boolean addPlugins)

Initializes RapidMiner.

Parameters:

operatorsXMLStream - the stream to the operators.xml (operator description), use core operators.xml if null

pluginDir - the directory where plugins are located, use core plugin directory if null

addWekaOperators - inidcates if the operator wrappers for Weka should be loaded

searchJDBCInLibDir - indicates if JDBC drivers from the directory RAPID_MINER_HOME/lib/jdbc should be loaded

searchJDBCInClasspath - indicates if JDBC drivers from the classpath libraries should be loaded

addPlugins - indicates if the plugins should be loaded

init

public static void init(java.io.InputStream operatorsXMLStream,
                        java.io.InputStream additionalXMLStream,
                        java.io.File pluginDir,
                        java.io.File jdbcDir,
                        boolean addWekaOperators,
                        boolean searchJDBCInLibDir,
                        boolean searchJDBCInClasspath,
                        boolean addPlugins)

Initializes RapidMiner.

Parameters:

operatorsXMLStream - the stream to the core operators.xml (operator description), use core operators.xml if null

additionalXMLStream - the stream to possibly additional operators.xml (operator description), use no additional if null

pluginDir - the directory where plugins are located, use core plugin directory if null

jdbcDir - the directory where the JDBC drivers are located, use core lib/jdbc directory if null

addWekaOperators - inidcates if the operator wrappers for Weka should be loaded

searchJDBCInLibDir - indicates if JDBC drivers from the directory RAPID_MINER_HOME/lib/jdbc should be loaded

searchJDBCInClasspath - indicates if JDBC drivers from the classpath libraries should be loaded

addPlugins - indicates if the plugins should be loaded

init

public static void init(java.io.InputStream operatorsXMLStream,
                        boolean addWekaOperators,
                        boolean searchJDBCInLibDir,
                        boolean searchJDBCInClasspath,
                        boolean addPlugins)

Initializes RapidMiner.

Parameters:

operatorsXMLStream - the stream to the operators.xml (operator description), use core operators.xml if null

addWekaOperators - inidcates if the operator wrappers for Weka should be loaded

searchJDBCInLibDir - indicates if JDBC drivers from the directory RAPID_MINER_HOME/lib/jdbc should be loaded

searchJDBCInClasspath - indicates if JDBC drivers from the classpath libraries should be loaded

addPlugins - indicates if the plugins should be loaded

init

public static void init(boolean addWekaOperators,
                        boolean searchJDBCInLibDir,
                        boolean searchJDBCInClasspath,
                        boolean addPlugins)

Initializes RapidMiner with its core operators.

Parameters:

addWekaOperators - inidcates if the operator wrappers for Weka should be loaded

searchJDBCInLibDir - indicates if JDBC drivers from the directory RAPID_MINER_HOME/lib/jdbc should be loaded

searchJDBCInClasspath - indicates if JDBC drivers from the classpath libraries should be loaded

addPlugins - indicates if the plugins should be loaded

init

public static void init()

Initializes RapidMiner. Will use the core operators.xml operator description, all available Weka operators, and all JDBC drivers found in the directory RAPID_MINER_HOME/lib/jdbc. Will not search for JDBC drivers in other classpath libraries. Will use all plugins in the plugins directory. Use the method init(InputStream, File, boolean, boolean, boolean, boolean) for more sophisticated initialization possibilities. Alternatively, you could also set the following system properties, e.g. during startup via "-Drapidminer.init.weka=false" or with System.setProperty(String, String):

• 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)

cleanUp

public static void cleanUp()

Cleans up the object visualizers available for this process and clears the current temp directory. This method should be performed in cases where RapidMiner is embedded into other applications and only single operators (in contrast to a complete process) are performed within several runs, e.g. in a loop. TODO: bind object visualizers and temp file service to a process instead of managing these things in a static way.

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 message)

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)

quit

public static void quit(int errorcode)