org.knime.core.node
Class KNIMEConstants

java.lang.Object
  extended by org.knime.core.node.KNIMEConstants

public final class KNIMEConstants
extends Object

Class that hold static values about the KNIME platform. This includes, among others, the welcome message and an icon.

Author:
Bernd Wiswedel, University of Konstanz

Field Summary
static boolean ASSERTIONS_ENABLED
          Global flag indicating whether assertions are enabled or disabled.
static String BUILD
          KNIME's build id.
static String BUILD_DATE
          The build date, is set automatically by the build scripts.
static ThreadPool GLOBAL_THREAD_POOL
          The global thread pool from which all threads should be taken.
static String KNIME_DATABASE_FETCHSIZE
          Java property used to adjust the fetch size for retrieving data from a database.
static String KNIME_DATABASE_LOGIN_TIMEOUT
          Java property used to set the timeout in seconds trying to establish a connection to a database.
static String KNIME_HOME_PROPERTYNAME
          The name of the system property whose value is - if set - used as knime home directory.
static ImageIcon KNIME16X16
          Icon 16 times 16 pixel.
static int MAJOR
          KNIME's major release number.
static int MINOR
          KNIME's minor release number.
static String PROPERTY_EXPERT_MODE
          Java property name that is used to identify whether KNIME is started in expert mode or not (e.g.
static String PROPERTY_MAX_THREAD_COUNT
          Java property name to specify the default max thread count variable (can be set via preference page).
static String PROPERTY_SYNCHRONOUS_IO
          Java property to disable the asynchronous writing of KNIME tables.
static String PROPERTY_TABLE_GZIP_COMPRESSION
          Java property to enable/disable table stream compression.
static String PROPERTY_TEMP_DIR
          Java property name to specify the default temp directory for KNIME temp files (such as data files).
static int REV
          KNIME's revision number.
static String VERSION
          Workflow file version.
static String WELCOME_MESSAGE
          Welcome to KNIME Konstanz Information Miner.
 
Method Summary
static String getKNIMEHomeDir()
          The directory where knime will put log files and configuration files.
static String getKNIMETempDir()
          Location for KNIME related temp files such as data container files.
static void setKNIMETempDir(File dir)
          Set a new location for the KNIME temp directory.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

MAJOR

public static final int MAJOR
KNIME's major release number.


MINOR

public static final int MINOR
KNIME's minor release number.


REV

public static final int REV
KNIME's revision number.


BUILD

public static final String BUILD
KNIME's build id.


VERSION

public static final String VERSION
Workflow file version.


BUILD_DATE

public static final String BUILD_DATE
The build date, is set automatically by the build scripts.

See Also:
Constant Field Values

PROPERTY_EXPERT_MODE

public static final String PROPERTY_EXPERT_MODE
Java property name that is used to identify whether KNIME is started in expert mode or not (e.g. whether to show loop nodes or not). This field is also used for the preference pages.

Values of this field must be either "true" or "false".

See Also:
Constant Field Values

PROPERTY_MAX_THREAD_COUNT

public static final String PROPERTY_MAX_THREAD_COUNT
Java property name to specify the default max thread count variable (can be set via preference page).

See Also:
Constant Field Values

PROPERTY_TEMP_DIR

public static final String PROPERTY_TEMP_DIR
Java property name to specify the default temp directory for KNIME temp files (such as data files). This can be changed in the preference pages and is by default the same as the java.io.tmpdir

See Also:
Constant Field Values

PROPERTY_SYNCHRONOUS_IO

public static final String PROPERTY_SYNCHRONOUS_IO
Java property to disable the asynchronous writing of KNIME tables. By default, each table container writing to disk performs the write operation in a dedicated (potentially re-used) thread. Setting this field to true will instruct KNIME to always write synchronously, which in some cases may be slower. (Asynchronous I/O became default with v2.1.)

See Also:
Constant Field Values

PROPERTY_TABLE_GZIP_COMPRESSION

public static final String PROPERTY_TABLE_GZIP_COMPRESSION
Java property to enable/disable table stream compression. Compression results in smaller temp-file sizes but also (sometimes significant) longer runtime. The default is true.

Warning: Changing this property will result in KNIME not being able to read workflows written previously (with a different compression property).

See Also:
Constant Field Values

KNIME_HOME_PROPERTYNAME

public static final String KNIME_HOME_PROPERTYNAME
The name of the system property whose value is - if set - used as knime home directory. If no (or an invalid) value is set, ~user/knime will be used instead. To set the knime home dir from the command line, use -Dknime.home=<absolutePathToNewHomeDir>.

See Also:
Constant Field Values

KNIME_DATABASE_LOGIN_TIMEOUT

public static final String KNIME_DATABASE_LOGIN_TIMEOUT
Java property used to set the timeout in seconds trying to establish a connection to a database.

See Also:
Constant Field Values

KNIME_DATABASE_FETCHSIZE

public static final String KNIME_DATABASE_FETCHSIZE
Java property used to adjust the fetch size for retrieving data from a database.

See Also:
Constant Field Values

WELCOME_MESSAGE

public static final String WELCOME_MESSAGE
Welcome to KNIME Konstanz Information Miner.


KNIME16X16

public static final ImageIcon KNIME16X16
Icon 16 times 16 pixel.


GLOBAL_THREAD_POOL

public static final ThreadPool GLOBAL_THREAD_POOL
The global thread pool from which all threads should be taken.


ASSERTIONS_ENABLED

public static final boolean ASSERTIONS_ENABLED
Global flag indicating whether assertions are enabled or disabled.

Method Detail

getKNIMEHomeDir

public static final String getKNIMEHomeDir()
The directory where knime will put log files and configuration files. If started in eclipse, this is usually ${workspace_path}/.metadata/knime. Otherwise it's in the current working directory. This variable does not have a trailing file separator character.

Returns:
The KNIME home dir.

getKNIMETempDir

public static final String getKNIMETempDir()
Location for KNIME related temp files such as data container files. This is by default System.getProperty("java.io.tmpdir") but can be overwritten in the command line or the preference page. The

Returns:
The path to the temp directory (trailing slashes omitted).

setKNIMETempDir

public static final void setKNIMETempDir(File dir)
Set a new location for the KNIME temp directory. Client should not be required to use this method. It has public scope so that bootstrap classes can initialize this properly.

Parameters:
dir - the new location to set
Throws:
NullPointerException - If the argument is null
IllegalArgumentException - If the argument is not a directory or not writable.


Copyright, 2003 - 2010. All rights reserved.
University of Konstanz, Germany.
Chair for Bioinformatics and Information Mining, Prof. Dr. Michael R. Berthold.
You may not modify, publish, transmit, transfer or sell, reproduce, create derivative works from, distribute, perform, display, or in any way exploit any of the content, in whole or in part, except as otherwise expressly permitted in writing by the copyright owner or as specified in the license file distributed with this product.