org.hkijena.jipipe.api.registries

Class JIPipeSettingsRegistry

java.lang.Object

org.hkijena.jipipe.api.registries.JIPipeSettingsRegistry

All Implemented Interfaces:

JIPipeCustomParameterCollection, JIPipeParameterCollection

public class JIPipeSettingsRegistry
extends Object
implements JIPipeParameterCollection, JIPipeCustomParameterCollection

Registry for settings. Settings are organized in "sheets" (parameter collections)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	JIPipeSettingsRegistry.Sheet A settings sheet

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

JIPipeParameterCollection.ParameterChangedEvent, JIPipeParameterCollection.ParameterStructureChangedEvent, JIPipeParameterCollection.ParameterUIChangedEvent

Constructor Summary

Constructors

Constructor and Description
JIPipeSettingsRegistry(JIPipe jiPipe)

Method Summary

Modifier and Type	Method and Description
EventBus	getEventBus() Gets the event bus that posts events about the parameters
JIPipe	getJIPipe()
Map<String,JIPipeParameterAccess>	getParameters() Returns all parameters Please note that those parameters must be sourced in this collection.
static Path	getPropertyFile()
static com.fasterxml.jackson.databind.JsonNode	getRawNode() Gets the raw property files Json node
BiMap<String,JIPipeSettingsRegistry.Sheet>	getRegisteredSheets()
<T extends JIPipeParameterCollection> T	getSettings(String id, Class<T> settingsClass) Gets the settings instance with given ID
void	load(Path file) Loads settings from the specified file
void	onSettingChanged(JIPipeParameterCollection.ParameterChangedEvent event) Triggered when a setting was changed
void	register(String id, String name, Icon icon, String category, Icon categoryIcon, JIPipeParameterCollection parameterCollection) Registers a new settings sheet
void	register(String id, String name, String description, Icon icon, String category, Icon categoryIcon, JIPipeParameterCollection parameterCollection) Registers a new settings sheet
void	reload() Reloads the settings from the default file if it exists
void	save() Saves the settings to the default settings file
void	save(Path file) Saves the settings to the specified file

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.JIPipeCustomParameterCollection

getChildParameterCollections, getIncludeReflectionParameters

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

addParameterChangeListener, addParameterChangeListener, getContextActions, getParameter, getParameterAccess, isParameterUIVisible, isParameterUIVisible, setParameter, triggerParameterChange, triggerParameterStructureChange, triggerParameterUIChange

Constructor Detail

JIPipeSettingsRegistry

public JIPipeSettingsRegistry(JIPipe jiPipe)

Method Detail

getRawNode

public static com.fasterxml.jackson.databind.JsonNode getRawNode()

Gets the raw property files Json node

Returns:

the node. Never null.

getPropertyFile

public static Path getPropertyFile()

Returns:

The location of the file where the settings are stored

register

public void register(String id,
                     String name,
                     Icon icon,
                     String category,
                     Icon categoryIcon,
                     JIPipeParameterCollection parameterCollection)

Registers a new settings sheet

Parameters:

id - unique ID of the sheet

name - sheet name

icon - sheet icon

category - sheet category. If left null or empty, it will default to "General"

categoryIcon - optional icon. If null, a wrench icon is used.

parameterCollection - the object that holds the parameters

register

public void register(String id,
                     String name,
                     String description,
                     Icon icon,
                     String category,
                     Icon categoryIcon,
                     JIPipeParameterCollection parameterCollection)

Registers a new settings sheet

Parameters:

id - unique ID of the sheet

name - sheet name

description - sheet description

icon - sheet icon

category - sheet category. If left null or empty, it will default to "General"

categoryIcon - optional icon. If null, a wrench icon is used.

parameterCollection - the object that holds the parameters

getSettings

public <T extends JIPipeParameterCollection> T getSettings(String id,
                                                           Class<T> settingsClass)

Gets the settings instance with given ID

Type Parameters:

T - the settings class

Parameters:

id - the ID

settingsClass - the settings class

Returns:

the settings instance.

getRegisteredSheets

public BiMap<String,JIPipeSettingsRegistry.Sheet> getRegisteredSheets()

getEventBus

public EventBus getEventBus()

Description copied from interface: JIPipeParameterCollection

Gets the event bus that posts events about the parameters

Specified by:

getEventBus in interface JIPipeParameterCollection

Returns:

The event bus triggering JIPipeParameterCollection.ParameterChangedEvent and JIPipeParameterCollection.ParameterStructureChangedEvent

getParameters

public Map<String,JIPipeParameterAccess> getParameters()

Description copied from interface: JIPipeCustomParameterCollection

Returns all parameters Please note that those parameters must be sourced in this collection. Use getChildParameterCollections() to add those

Specified by:

getParameters in interface JIPipeCustomParameterCollection

Returns:

Map from parameter ID to its access. The ID is not necessarily equal to JIPipeParameterAccess.getKey()

save

public void save(Path file)

Saves the settings to the specified file

Parameters:

file - the file path

save

public void save()

Saves the settings to the default settings file

load

public void load(Path file)

Loads settings from the specified file

Parameters:

file - the file

onSettingChanged

public void onSettingChanged(JIPipeParameterCollection.ParameterChangedEvent event)

Triggered when a setting was changed

Parameters:

event - generated event

reload

public void reload()

Reloads the settings from the default file if it exists

getJIPipe

public JIPipe getJIPipe()