com.lf.commons.model

Class ModelUtils

java.lang.Object

com.lf.commons.model.ModelUtils

public class ModelUtils
extends java.lang.Object

This class holds various methods for common use with the application models.

Since:

1.6

Version:

$Revision: 1.32 $, $Date: 2012/12/28 11:44:25 $

Author:

Axel Schwolow

Constructor Summary

Constructors

Constructor and Description
ModelUtils() Constructor method for i18n purposes only.

Method Summary

Methods

Modifier and Type	Method and Description
static void	configure(java.lang.String id, Configuration config, java.awt.Component comp, java.lang.String name) Restores values from persistent data stores.
static void	configureCheckBox(java.lang.String id, Configuration config, javax.swing.JCheckBox comp, java.lang.String name) Restores values from persistent data stores.
static void	configureCheckBoxMenuItem(java.lang.String id, Configuration config, javax.swing.JCheckBoxMenuItem comp, java.lang.String name) Restores values from persistent data stores.
static void	configureCollapsiblePanel(java.lang.String id, Configuration config, CollapsiblePanel comp, java.lang.String name) Restores values from persistent data stores.
static void	configureComboBoxIndex(java.lang.String id, Configuration config, javax.swing.JComboBox comp, java.lang.String name) Restores values from persistent data stores (selection by index).
static void	configureComboBoxObject(java.lang.String id, Configuration config, javax.swing.JComboBox comp, java.lang.String name) Restores values from persistent data stores (selection by item object).
static void	configureDialog(java.lang.String id, Configuration config, javax.swing.JDialog comp, java.lang.String name) Restores values from persistent data stores.
static void	configureFrame(java.lang.String id, Configuration config, javax.swing.JFrame comp, java.lang.String name) Restores values from persistent data stores.
static void	configureHistoryField(java.lang.String id, Configuration config, HistoryField comp, java.lang.String name) Restores values from persistent data stores.
static void	configureRadioButton(java.lang.String id, Configuration config, javax.swing.JRadioButton comp, java.lang.String name) Restores values from persistent data stores.
static void	configureSlider(java.lang.String id, Configuration config, javax.swing.JSlider comp, java.lang.String name) Restores values from persistent data stores.
static void	configureSplitPane(java.lang.String id, Configuration config, javax.swing.JSplitPane comp, java.lang.String name) Restores values from persistent data stores.
static void	configureTabbedPane(java.lang.String id, Configuration config, javax.swing.JTabbedPane comp, java.lang.String name) Restores values from persistent data stores.
static void	configureTable(java.lang.String id, Configuration config, javax.swing.JTable comp, java.lang.String name) Restores values from persistent data stores.
static void	configureTableNavigation(java.lang.String id, Configuration config, TableNavigation comp, java.lang.String name) Restores values from persistent data stores.
static void	configureTextArea(java.lang.String id, Configuration config, javax.swing.JTextArea comp, java.lang.String name) Restores values from persistent data stores.
static void	configureTextField(java.lang.String id, Configuration config, javax.swing.JTextField comp, java.lang.String name) Restores values from persistent data stores.
static void	configureToggleButton(java.lang.String id, Configuration config, javax.swing.JToggleButton comp, java.lang.String name) Restores values from persistent data stores.
static java.lang.String	generateID(java.util.Hashtable<java.lang.String,ResourceFile> resources) Generates a unique hexadecimal identifier for model resource files.
static void	removeArtifacts(Configuration config, int index, java.lang.String pattern) Removes artifact entries from the given configuration.
static void	removeArtifacts(Configuration config, java.lang.String prefix, int index) Removes artifact entries from the given configuration.
static void	store(java.lang.String id, Configuration config, java.awt.Component comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeCheckBox(java.lang.String id, Configuration config, javax.swing.JCheckBox comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeCheckBoxMenuItem(java.lang.String id, Configuration config, javax.swing.JCheckBoxMenuItem comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeCollapsiblePanel(java.lang.String id, Configuration config, CollapsiblePanel comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeComboBoxIndex(java.lang.String id, Configuration config, javax.swing.JComboBox comp, java.lang.String name) Stores the current configuration values persistently (selection by index).
static void	storeComboBoxObject(java.lang.String id, Configuration config, javax.swing.JComboBox comp, java.lang.String name) Stores the current configuration values persistently (selection by item object).
static void	storeDialog(java.lang.String id, Configuration config, javax.swing.JDialog comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeFrame(java.lang.String id, Configuration config, javax.swing.JFrame comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeHistoryField(java.lang.String id, Configuration config, HistoryField comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeRadioButton(java.lang.String id, Configuration config, javax.swing.JRadioButton comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeSlider(java.lang.String id, Configuration config, javax.swing.JSlider comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeSplitPane(java.lang.String id, Configuration config, javax.swing.JSplitPane comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeTabbedPane(java.lang.String id, Configuration config, javax.swing.JTabbedPane comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeTable(java.lang.String id, Configuration config, javax.swing.JTable comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeTableNavigation(java.lang.String id, Configuration config, TableNavigation comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeTextArea(java.lang.String id, Configuration config, javax.swing.JTextArea comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeTextField(java.lang.String id, Configuration config, javax.swing.JTextField comp, java.lang.String name) Stores the current configuration values persistently.
static void	storeToggleButton(java.lang.String id, Configuration config, javax.swing.JToggleButton comp, java.lang.String name) Stores the current configuration values persistently.

Methods inherited from class java.lang.Object

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

Constructor Detail

ModelUtils

public ModelUtils()
           throws java.lang.InstantiationException

Constructor method for i18n purposes only.

Can only be used if beans design time is set (e.g. by external tools like the I18NExtractor).

Throws:

java.lang.InstantiationException - Error indication

Since:

1.6

Method Detail

generateID

public static java.lang.String generateID(java.util.Hashtable<java.lang.String,ResourceFile> resources)

Generates a unique hexadecimal identifier for model resource files.

This identifiers can be used for obfuscation functionality.

Parameters:

resources - Container with registered resources

Returns:

The unique ID

Since:

1.5

configure

public static void configure(java.lang.String id,
             Configuration config,
             java.awt.Component comp,
             java.lang.String name)

Restores values from persistent data stores.

This method should not be used since the performance of this method is not as well as when using the configure method for the well-known component types. This method has to determine the component type by conditional branches and that slows the operation down.

Parameters:

id - The unique identifier for the instance

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.IllegalArgumentException - If the component is not currently supported

Since:

1.6

configureCheckBox

public static void configureCheckBox(java.lang.String id,
                     Configuration config,
                     javax.swing.JCheckBox comp,
                     java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureCheckBoxMenuItem

public static void configureCheckBoxMenuItem(java.lang.String id,
                             Configuration config,
                             javax.swing.JCheckBoxMenuItem comp,
                             java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureRadioButton

public static void configureRadioButton(java.lang.String id,
                        Configuration config,
                        javax.swing.JRadioButton comp,
                        java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureToggleButton

public static void configureToggleButton(java.lang.String id,
                         Configuration config,
                         javax.swing.JToggleButton comp,
                         java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureTextField

public static void configureTextField(java.lang.String id,
                      Configuration config,
                      javax.swing.JTextField comp,
                      java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureComboBoxIndex

public static void configureComboBoxIndex(java.lang.String id,
                          Configuration config,
                          javax.swing.JComboBox comp,
                          java.lang.String name)

Restores values from persistent data stores (selection by index).

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureComboBoxObject

public static void configureComboBoxObject(java.lang.String id,
                           Configuration config,
                           javax.swing.JComboBox comp,
                           java.lang.String name)

Restores values from persistent data stores (selection by item object).

Use this variant only if the combo box is loaded with ComboBoxItem objects. The String representation of the selected object is used here.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureSplitPane

public static void configureSplitPane(java.lang.String id,
                      Configuration config,
                      javax.swing.JSplitPane comp,
                      java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureTable

public static void configureTable(java.lang.String id,
                  Configuration config,
                  javax.swing.JTable comp,
                  java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureDialog

public static void configureDialog(java.lang.String id,
                   Configuration config,
                   javax.swing.JDialog comp,
                   java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureFrame

public static void configureFrame(java.lang.String id,
                  Configuration config,
                  javax.swing.JFrame comp,
                  java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureTabbedPane

public static void configureTabbedPane(java.lang.String id,
                       Configuration config,
                       javax.swing.JTabbedPane comp,
                       java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureHistoryField

public static void configureHistoryField(java.lang.String id,
                         Configuration config,
                         HistoryField comp,
                         java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureCollapsiblePanel

public static void configureCollapsiblePanel(java.lang.String id,
                             Configuration config,
                             CollapsiblePanel comp,
                             java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureSlider

public static void configureSlider(java.lang.String id,
                   Configuration config,
                   javax.swing.JSlider comp,
                   java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureTableNavigation

public static void configureTableNavigation(java.lang.String id,
                            Configuration config,
                            TableNavigation comp,
                            java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

configureTextArea

public static void configureTextArea(java.lang.String id,
                     Configuration config,
                     javax.swing.JTextArea comp,
                     java.lang.String name)

Restores values from persistent data stores.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

store

public static void store(java.lang.String id,
         Configuration config,
         java.awt.Component comp,
         java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.IllegalArgumentException - If the component is not currently supported

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeCheckBox

public static void storeCheckBox(java.lang.String id,
                 Configuration config,
                 javax.swing.JCheckBox comp,
                 java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeCheckBoxMenuItem

public static void storeCheckBoxMenuItem(java.lang.String id,
                         Configuration config,
                         javax.swing.JCheckBoxMenuItem comp,
                         java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeRadioButton

public static void storeRadioButton(java.lang.String id,
                    Configuration config,
                    javax.swing.JRadioButton comp,
                    java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeToggleButton

public static void storeToggleButton(java.lang.String id,
                     Configuration config,
                     javax.swing.JToggleButton comp,
                     java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeTextField

public static void storeTextField(java.lang.String id,
                  Configuration config,
                  javax.swing.JTextField comp,
                  java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeComboBoxIndex

public static void storeComboBoxIndex(java.lang.String id,
                      Configuration config,
                      javax.swing.JComboBox comp,
                      java.lang.String name)

Stores the current configuration values persistently (selection by index).

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeComboBoxObject

public static void storeComboBoxObject(java.lang.String id,
                       Configuration config,
                       javax.swing.JComboBox comp,
                       java.lang.String name)

Stores the current configuration values persistently (selection by item object).

Use this variant only if the combo box is loaded with ComboBoxItem objects. The String representation of the selected object is used here.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeSplitPane

public static void storeSplitPane(java.lang.String id,
                  Configuration config,
                  javax.swing.JSplitPane comp,
                  java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeTable

public static void storeTable(java.lang.String id,
              Configuration config,
              javax.swing.JTable comp,
              java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeDialog

public static void storeDialog(java.lang.String id,
               Configuration config,
               javax.swing.JDialog comp,
               java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeFrame

public static void storeFrame(java.lang.String id,
              Configuration config,
              javax.swing.JFrame comp,
              java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeTabbedPane

public static void storeTabbedPane(java.lang.String id,
                   Configuration config,
                   javax.swing.JTabbedPane comp,
                   java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeHistoryField

public static void storeHistoryField(java.lang.String id,
                     Configuration config,
                     HistoryField comp,
                     java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeCollapsiblePanel

public static void storeCollapsiblePanel(java.lang.String id,
                         Configuration config,
                         CollapsiblePanel comp,
                         java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeSlider

public static void storeSlider(java.lang.String id,
               Configuration config,
               javax.swing.JSlider comp,
               java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeTableNavigation

public static void storeTableNavigation(java.lang.String id,
                        Configuration config,
                        TableNavigation comp,
                        java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

storeTextArea

public static void storeTextArea(java.lang.String id,
                 Configuration config,
                 javax.swing.JTextArea comp,
                 java.lang.String name)

Stores the current configuration values persistently.

Parameters:

id - The unique identifier for the instance (optional)

config - The configuration

comp - The component to be configured

name - The component name

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

removeArtifacts

public static void removeArtifacts(Configuration config,
                   java.lang.String prefix,
                   int index)

Removes artifact entries from the given configuration.

For instance let the configuration contain the following datasets:

OptionsDialog:expanded=3
OptionsDialog:expanded.1=Files
OptionsDialog:expanded.2=Nodes
OptionsDialog:expanded.3=Horses

If only the first variable is kept then the last two entries need to be removed. The index passed to this method is 2 then to start artifact removal. The variables are checked as long as the next index does exist.

Parameters:

config - The configuration

prefix - The variable prefix including the unit identifier

index - The first index to check (1-based)

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6

removeArtifacts

public static void removeArtifacts(Configuration config,
                   int index,
                   java.lang.String pattern)

Removes artifact entries from the given configuration.

For instance let the configuration contain the following datasets:

OptionsDialog:expanded=3
OptionsDialog:expanded.1.name=Files
OptionsDialog:expanded.2.name=Nodes
OptionsDialog:expanded.3.name=Horses

If only the first variable is kept then the last two entries need to be removed. The index passed to this method is 2 then to start artifact removal. The variables are checked as long as the next index does exist. Here, the index may be checked at an arbitrary position within the variable name, not only at the end of the text. For the example above you could use the pattern "OptionsDialog:expanded.%index%.name" to remove the artifact indexes.

Parameters:

config - The configuration

index - The first index to check (1-based)

pattern - The variable pattern, placeholder %index% is replaced

Throws:

java.lang.NullPointerException - If parameters are null

Since:

1.6