org.hkijena.jipipe.plugins.settings

Class JIPipeRuntimeApplicationSettings

java.lang.Object

org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

org.hkijena.jipipe.api.settings.JIPipeDefaultApplicationsSettingsSheet

org.hkijena.jipipe.plugins.settings.JIPipeRuntimeApplicationSettings

All Implemented Interfaces:

JIPipeParameterCollection, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEventListener, JIPipeApplicationSettingsSheet, JIPipeSettingsSheet

public class JIPipeRuntimeApplicationSettings
extends JIPipeDefaultApplicationsSettingsSheet

Settings related to how algorithms are executed

Nested Class Summary

Nested classes/interfaces inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterChangedEventEmitter, JIPipeParameterCollection.ParameterChangedEventListener, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEventEmitter, JIPipeParameterCollection.ParameterStructureChangedEventListener, JIPipeParameterCollection.ParameterUIChangedEvent, JIPipeParameterCollection.ParameterUIChangedEventEmitter, JIPipeParameterCollection.ParameterUIChangedEventListener

Field Summary

Fields

Modifier and Type	Field and Description
static String	ID

Constructor Summary

Constructors

Constructor and Description
JIPipeRuntimeApplicationSettings() Creates a new instance

Method Summary

Modifier and Type	Method and Description
JIPipeDefaultApplicationSettingsSheetCategory	getDefaultCategory() Returns one of the predefined categories
int	getDefaultQuickRunThreads()
int	getDefaultRunThreads()
String	getDescription() Description of this settings sheet
Icon	getIcon() The icon of the settings sheet
String	getId() The unique ID of the settings sheet
static JIPipeRuntimeApplicationSettings	getInstance()
int	getLogLimit()
String	getName() The name of the settings sheet as displayed in the UI
OptionalPathParameter	getTempDirectory()
static Path	getTemporaryBaseDirectory()
static Path	getTemporaryDirectory(String baseName) Generates a temporary directory
static Path	getTemporaryFile(String prefix, String suffix) Generates a temporary directory
boolean	isAllowCache()
boolean	isAllowSkipAlgorithmsWithoutInput()
boolean	isPerProjectTempDirectory()
void	setAllowCache(boolean allowCache)
void	setAllowSkipAlgorithmsWithoutInput(boolean allowSkipAlgorithmsWithoutInput)
boolean	setDefaultQuickRunThreads(int defaultTestBenchThreads) Sets the number of threads for test bench
boolean	setDefaultRunThreads(int defaultRunThreads) Sets the number of threads
void	setLogLimit(int logLimit)
void	setPerProjectTempDirectory(boolean perProjectTempDirectory)
void	setTempDirectory(OptionalPathParameter tempDirectory)

Methods inherited from class org.hkijena.jipipe.api.settings.JIPipeDefaultApplicationsSettingsSheet

getCategory, getCategoryIcon

Methods inherited from class org.hkijena.jipipe.api.parameters.AbstractJIPipeParameterCollection

getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, onParameterChanged, onParameterStructureChanged, onParameterUIChanged, registerSubParameter, registerSubParameters

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.hkijena.jipipe.api.parameters.JIPipeParameterCollection

deserializeFromJsonNode, emitParameterChangedEvent, emitParameterStructureChangedEvent, emitParameterUIChangedEvent, getContextActions, getParameter, getParameterAccess, getParameterChangedEventEmitter, getParameterStructureChangedEventEmitter, getParameterUIChangedEventEmitter, installUIOverrideParameterEditor, installUIParameterOptions, isParameterUIVisible, isParameterUIVisible, serializeToJsonFile, serializeToJsonGenerator, serializeToJsonString, setParameter

Field Detail

ID

public static final String ID

See Also:

Constant Field Values

Constructor Detail

JIPipeRuntimeApplicationSettings

public JIPipeRuntimeApplicationSettings()

Creates a new instance

Method Detail

getInstance

public static JIPipeRuntimeApplicationSettings getInstance()

getTemporaryBaseDirectory

public static Path getTemporaryBaseDirectory()

getTemporaryDirectory

public static Path getTemporaryDirectory(String baseName)

Generates a temporary directory

Parameters:

baseName - optional base name

Returns:

a temporary directory

getTemporaryFile

public static Path getTemporaryFile(String prefix,
                                    String suffix)

Generates a temporary directory

Parameters:

prefix - prefix

suffix - suffix

Returns:

a temporary directory

isPerProjectTempDirectory

public boolean isPerProjectTempDirectory()

setPerProjectTempDirectory

public void setPerProjectTempDirectory(boolean perProjectTempDirectory)

isAllowSkipAlgorithmsWithoutInput

public boolean isAllowSkipAlgorithmsWithoutInput()

setAllowSkipAlgorithmsWithoutInput

public void setAllowSkipAlgorithmsWithoutInput(boolean allowSkipAlgorithmsWithoutInput)

isAllowCache

public boolean isAllowCache()

setAllowCache

public void setAllowCache(boolean allowCache)

getTempDirectory

public OptionalPathParameter getTempDirectory()

setTempDirectory

public void setTempDirectory(OptionalPathParameter tempDirectory)

getDefaultRunThreads

public int getDefaultRunThreads()

setDefaultRunThreads

public boolean setDefaultRunThreads(int defaultRunThreads)

Sets the number of threads

Parameters:

defaultRunThreads - threads

Returns:

if successful

getDefaultQuickRunThreads

public int getDefaultQuickRunThreads()

setDefaultQuickRunThreads

public boolean setDefaultQuickRunThreads(int defaultTestBenchThreads)

Sets the number of threads for test bench

Parameters:

defaultTestBenchThreads - threads

Returns:

if successful

getLogLimit

public int getLogLimit()

setLogLimit

public void setLogLimit(int logLimit)

getDefaultCategory

public JIPipeDefaultApplicationSettingsSheetCategory getDefaultCategory()

Description copied from class: JIPipeDefaultApplicationsSettingsSheet

Returns one of the predefined categories

Specified by:

getDefaultCategory in class JIPipeDefaultApplicationsSettingsSheet

Returns:

the category

getId

public String getId()

Description copied from interface: JIPipeSettingsSheet

The unique ID of the settings sheet

Returns:

the ID

getIcon

public Icon getIcon()

Description copied from interface: JIPipeSettingsSheet

The icon of the settings sheet

Returns:

the icon

getName

public String getName()

Description copied from interface: JIPipeSettingsSheet

The name of the settings sheet as displayed in the UI

Returns:

the name

getDescription

public String getDescription()

Description copied from interface: JIPipeSettingsSheet

Description of this settings sheet

Returns:

the description