MiniGUI (ELKI: Environment for DeveLoping KDD-Applications Supported by Index-Structures)

java.lang.Object
- de.lmu.ifi.dbs.elki.application.AbstractApplication
- - de.lmu.ifi.dbs.elki.gui.minigui.MiniGUI

```
@Alias(value={"mini","minigui"})
public class MiniGUI
extends AbstractApplication
```
Minimal GUI built around a table-based parameter editor.

Since:

0.3

Author:

Erich Schubert

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

(package private) class MiniGUI.SettingsComboboxModel
Class to interface between the saved settings list and a JComboBox.
- Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication
  AbstractApplication.Parameterizer

Nested Classes
Modifier and Type	Class and Description
`(package private) class`	`MiniGUI.SettingsComboboxModel` Class to interface between the saved settings list and a JComboBox.

Field Summary

Fields
Modifier and Type	Field and Description
`protected static java.lang.String`	`ACTION_QUIT` Quit action, for mnemonics.
`private java.lang.String`	`APP_PREFIX` Prefix for application package.
`protected javax.swing.JComboBox<java.lang.String>`	`appCombo` Combo box for choosing the application to run.
`private javax.swing.JTextField`	`commandLine` Command line output field.
`(package private) javax.swing.JFrame`	`frame` The frame
`private static Logging`	`LOG` ELKI logger for the GUI.
`private java.lang.Class<? extends AbstractApplication>`	`maincls` Application to configure / run.
`static java.lang.String`	`NEWLINE` Newline used in output.
`protected LogPanel`	`outputArea` Logging output area.
`(package private) javax.swing.JPanel`	`panel` The main panel.
`protected DynamicParameters`	`parameters` Parameter storage.
`protected ParameterTable`	`parameterTable` The parameter table.
`protected javax.swing.JButton`	`runButton` The "run" button.
`static java.lang.String`	`SAVED_SETTINGS_FILENAME` Filename for saved settings.
`protected javax.swing.JComboBox<java.lang.String>`	`savedCombo` Combo box for saved settings.
`protected MiniGUI.SettingsComboboxModel`	`savedSettingsModel` Model to link the combobox with.
`protected SavedSettingsFile`	`store` Settings storage.

Fields inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication
REFERENCE, VERSION

Constructor Summary

Constructors
Constructor and Description

MiniGUI()
Constructor.

Constructors
Constructor and Description
`MiniGUI()` Constructor.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`doSetParameters(java.util.List<java.lang.String> params)` Do the actual setParameters invocation.
`private java.lang.String`	`format(java.lang.Object... params)` Format objects to a command line.
`private void`	`formatTo(java.lang.StringBuilder buf, java.util.List<?> params)` Format a list of strings to a buffer.
`private void`	`formatTo(java.lang.StringBuilder buf, java.lang.String s)` Format a single string for the command line.
`protected void`	`loadLatest()` Auto-load the last task from the history file.
`static void`	`main(java.lang.String[] args)` Main method that just spawns the UI.
`protected void`	`reportErrors(SerializedParameterization config)` Report errors in a single error log record.
`void`	`run()` Runs the application.
`private void`	`setupAppChooser()` Setup the application chooser.
`private void`	`setupCommandLine()` Setup command line field
`private void`	`setupLoadSaveButtons()` Create the load and save buttons.
`private void`	`setupLoggingArea()` Setup logging area
`private void`	`setupParameterTable()` Setup the parameter table
`protected void`	`startTask()` Do a full run of the KDDTask with the specified parameters.
`protected void`	`updateParameterTable()` Serialize the parameter table and run setParameters().

Methods inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication
printErrorMessage, runCLIApplication, usage

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SAVED_SETTINGS_FILENAME
```
public static final java.lang.String SAVED_SETTINGS_FILENAME
```
    Filename for saved settings.
    
    See Also:
    
    Constant Field Values
  - NEWLINE
```
public static final java.lang.String NEWLINE
```
    Newline used in output.
  - LOG
```
private static final Logging LOG
```
    ELKI logger for the GUI.
  - ACTION_QUIT
```
protected static final java.lang.String ACTION_QUIT
```
    Quit action, for mnemonics.
    
    See Also:
    
    Constant Field Values
  - frame
```
javax.swing.JFrame frame
```
    The frame
  - panel
```
javax.swing.JPanel panel
```
    The main panel.
  - outputArea
```
protected LogPanel outputArea
```
    Logging output area.
  - parameterTable
```
protected ParameterTable parameterTable
```
    The parameter table.
  - parameters
```
protected DynamicParameters parameters
```
    Parameter storage.
  - store
```
protected SavedSettingsFile store
```
    Settings storage.
  - appCombo
```
protected javax.swing.JComboBox<java.lang.String> appCombo
```
    Combo box for choosing the application to run.
  - savedCombo
```
protected javax.swing.JComboBox<java.lang.String> savedCombo
```
    Combo box for saved settings.
  - savedSettingsModel
```
protected MiniGUI.SettingsComboboxModel savedSettingsModel
```
    Model to link the combobox with.
  - runButton
```
protected javax.swing.JButton runButton
```
    The "run" button.
  - maincls
```
private java.lang.Class<? extends AbstractApplication> maincls
```
    Application to configure / run.
  - commandLine
```
private javax.swing.JTextField commandLine
```
    Command line output field.
  - APP_PREFIX
```
private java.lang.String APP_PREFIX
```
    Prefix for application package.
- Constructor Detail
  - MiniGUI
```
public MiniGUI()
```
    Constructor.
- Method Detail
  - setupAppChooser
```
private void setupAppChooser()
```
    Setup the application chooser.
  - setupParameterTable
```
private void setupParameterTable()
```
    Setup the parameter table
  - setupLoadSaveButtons
```
private void setupLoadSaveButtons()
```
    Create the load and save buttons.
  - setupCommandLine
```
private void setupCommandLine()
```
    Setup command line field
  - setupLoggingArea
```
private void setupLoggingArea()
```
    Setup logging area
  - updateParameterTable
```
protected void updateParameterTable()
```
    Serialize the parameter table and run setParameters().
  - doSetParameters
```
protected void doSetParameters(java.util.List<java.lang.String> params)
```
    Do the actual setParameters invocation.
    
    Parameters:
    
    params - Parameters
  - format
```
private java.lang.String format(java.lang.Object... params)
```
    Format objects to a command line.
    
    Parameters:
    
    params - Parameters to format (Strings, or list of strings)
    
    Returns:
    
    Formatted string
  - formatTo
```
private void formatTo(java.lang.StringBuilder buf,
                      java.util.List<?> params)
```
    Format a list of strings to a buffer.
    
    Parameters:
    
    buf - Output buffer
    
    params - List of strings
  - formatTo
```
private void formatTo(java.lang.StringBuilder buf,
                      java.lang.String s)
```
    Format a single string for the command line.
    
    Parameters:
    
    buf - Output buffer
    
    s - String
  - loadLatest
```
protected void loadLatest()
```
    Auto-load the last task from the history file.
  - startTask
```
protected void startTask()
```
    Do a full run of the KDDTask with the specified parameters.
  - reportErrors
```
protected void reportErrors(SerializedParameterization config)
```
    Report errors in a single error log record.
    
    Parameters:
    
    config - Parameterization
  - run
```
public void run()
```
    Description copied from class: AbstractApplication
    
    Runs the application.
    
    Specified by:
    
    run in class AbstractApplication
  - main
```
public static void main(java.lang.String[] args)
```
    Main method that just spawns the UI.
    
    Parameters:
    
    args - command line parameters

Class MiniGUI

Nested Class Summary

Nested classes/interfaces inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication

Field Summary

Fields inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication

Constructor Summary

Method Summary

Methods inherited from class de.lmu.ifi.dbs.elki.application.AbstractApplication

Methods inherited from class java.lang.Object

Field Detail

SAVED_SETTINGS_FILENAME

NEWLINE

LOG

ACTION_QUIT

frame

panel

outputArea

parameterTable

parameters

store

appCombo

savedCombo

savedSettingsModel

runButton

maincls

commandLine

APP_PREFIX

Constructor Detail

MiniGUI

Method Detail

setupAppChooser

setupParameterTable

setupLoadSaveButtons

setupCommandLine

setupLoggingArea

updateParameterTable

doSetParameters

format

formatTo

formatTo

loadLatest

startTask

reportErrors

run

main