edu.cs.ai.kreator.control.config
Class Configuration

java.lang.Object
  edu.cs.ai.kreator.control.config.Configuration

public abstract class Configuration
extends java.lang.Object

This abstract class contains all configuration options of KReator. This class only contains the structure of the KReator configuration, for access to the properties see ConfigurationFacility.

Author:

Matthias, Thimm

Field Summary

static IntegerConfigurationOption	CONSOLE__AUTO_COMPLETE_DELAY Delay until console suggests possible completions of the current command line
static BooleanConfigurationOption	CONSOLE__AUTOLOAD_COMMAND_HISTORY Indicates whether autoloading the command history is enabled.
static BooleanConfigurationOption	CONSOLE__AUTOSAVE_COMMAND_HISTORY Indicates whether autosaving the command history is enabled.
static StringListConfigurationOption	CONSOLE__COMMAND_HISTORY The command history.
static BooleanConfigurationOption	CONSOLE__COMMAND_HISTORY_IS_PROJECT_SPECIFIC Whether command history is saved in project file (project specific) or general configuration
static IntegerConfigurationOption	CONSOLE__MAX_CHARACTERS Number of characters after that the first half of the console will be cleared.
static IntegerConfigurationOption	CONSOLE__MAXLENGTH_COMMAND_HISTORY The maximal length of the command history.
static BooleanConfigurationOption	CONSOLE__VERBOSE_OUTPUT Verbose output for queries, etc.
static StringConfigurationOption	EDITOR__LEXER No idea what thats for.
static IntegerConfigurationOption	EDITOR__LEXER_MAX_TIME If the syntax highlighting takes more than this MAX_TIME the user will be asked, if he wants to use the a more simple lexer.
static IntegerConfigurationOption	EDITOR__LEXER_MIN_TIME No idea what thats for.
static BooleanConfigurationOption	EDITOR__USE_SIMPLE_LEXER If this is set to true the syntax pane will use a very simple lexer for all files.
static BooleanConfigurationOption	GENERAL__AUTODELETE_OUTPUTFILES Delete files, which will be used as output without further confirmation (e.g. knowledge base files, ...)
static BooleanConfigurationOption	GENERAL__AUTOSAVE_LAST_PROJECT Indicates whether autosaving the last opened project is enabled.
static BooleanConfigurationOption	GENERAL__AUTOSAVE_STARTING_DIRECTORY Indicates whether autosaving the starting directory is enabled.
static BooleanConfigurationOption	GENERAL__AUTOSAVE_WORKINGFILES Save files, which will be worked upon without further confirmation (e.g. knowledge base files, script, ...)
static PathConfigurationOption	GENERAL__LAST_PROJECT The project that was open the last time KReator closed.
static LoggingLevelStringSelectionConfigurationOption	GENERAL__LOGGING_LEVEL Logging level.
static BooleanConfigurationOption	GENERAL__REPORT_ABSOLUTE_PATH No idea what thats for.
static PathConfigurationOption	GENERAL__STARTING_DIRECTORY The directory where "open file" dialogs start.
static StringConfigurationOption	LATEX_CONSTANT
static StringConfigurationOption	LATEX_ENVIRONMENT
static StringConfigurationOption	LATEX_PREDICATE
static StringConfigurationOption	LATEX_VARIABLE
static PathListConfigurationOption	PLUGINS__INSTALLED_PLUGINS The plugins currently installed in KReator.
static StringListConfigurationOption	QUERIES__QUERY_HISTORY The query history of the query dialog.
static BooleanConfigurationOption	QUERIES__QUERY_HISTORY_IS_PROJECT_SPECIFIC Whether query history is saved in project file (project specific) or general configuration
static BooleanConfigurationOption	USERINTERFACE__AUTOSAVE_WINDOW_BOUNDS Indicates whether window bounds should be autosaved.
static IntegerConfigurationOption	USERINTERFACE__NUMBER_OF_RECENT_PROJECTS The number of recent projects that should be saved.
static PathListConfigurationOption	USERINTERFACE__RECENT_PROJECTS The list of recent projects (for the "Open recent" menu item).
static BooleanConfigurationOption	USERINTERFACE__SHOW_LOGGING_PANE If this is set to true the logging pane und system text area will be included in the main window.
static IntegerConfigurationOption	USERINTERFACE__SPLITPANE1_POS Pos of projectVsFiles Splitpane.
static IntegerConfigurationOption	USERINTERFACE__SPLITPANE2_POS Pos of prjFilesVsOutlineSplit Splitpane.
static IntegerConfigurationOption	USERINTERFACE__SPLITPANE3_POS Pos of prjFilesOutlVsOutputSplit Splitpane.
static IntegerConfigurationOption	USERINTERFACE__SPLITPANE4_POS Pos of primaryVsOptionalSplit Splitpane.
static IntegerConfigurationOption	USERINTERFACE__SPLITPANE5_POS Pos of consoleVsReportSplit Splitpane
static IntegerConfigurationOption	USERINTERFACE__WINDOW_HEIGHT Height of main KReator window.
static IntegerConfigurationOption	USERINTERFACE__WINDOW_POS_X X-Pos of main KReator window.
static IntegerConfigurationOption	USERINTERFACE__WINDOW_POS_Y Y-Pos of main KReator window.
static IntegerConfigurationOption	USERINTERFACE__WINDOW_WIDTH Width of main KReator window.

Constructor Summary

Configuration()

Method Summary

static java.util.List<ConfigurationCategory>	getConfiguration() This method is invoked by ConfigurationFacility when the configuration is initialized.
static ConfigurationCategory	getConsoleConfig() This method provides the configuration options needed for the "Console" category.
static ConfigurationCategory	getEditorConfig() This method provides the configuration options for the "Editor" category.
static ConfigurationCategory	getLatexConfig() This method provides the configuration options for the "LaTeX" category.
static ConfigurationOption	getOption(java.lang.String pathId) This method retrieves the configuration option for the given path id.
static ConfigurationCategory	getPluginsConfig() This method provides the configuration options needed for the "Plugins" category.
static ConfigurationCategory	getQueriesConfig() This method provides the configuration options needed for the "Queries" category.
static ConfigurationCategory	getUserInterfaceConfig() This method provides the configuration options for the "User Interface" category.

Methods inherited from class java.lang.Object

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

Field Detail

GENERAL__STARTING_DIRECTORY

public static final PathConfigurationOption GENERAL__STARTING_DIRECTORY

The directory where "open file" dialogs start.

GENERAL__AUTOSAVE_STARTING_DIRECTORY

public static final BooleanConfigurationOption GENERAL__AUTOSAVE_STARTING_DIRECTORY

Indicates whether autosaving the starting directory is enabled.

GENERAL__LAST_PROJECT

public static final PathConfigurationOption GENERAL__LAST_PROJECT

The project that was open the last time KReator closed.

GENERAL__AUTOSAVE_LAST_PROJECT

public static final BooleanConfigurationOption GENERAL__AUTOSAVE_LAST_PROJECT

Indicates whether autosaving the last opened project is enabled.

GENERAL__REPORT_ABSOLUTE_PATH

public static final BooleanConfigurationOption GENERAL__REPORT_ABSOLUTE_PATH

No idea what thats for.

GENERAL__LOGGING_LEVEL

public static final LoggingLevelStringSelectionConfigurationOption GENERAL__LOGGING_LEVEL

Logging level.

GENERAL__AUTOSAVE_WORKINGFILES

public static final BooleanConfigurationOption GENERAL__AUTOSAVE_WORKINGFILES

Save files, which will be worked upon without further confirmation (e.g. knowledge base files, script, ...)

GENERAL__AUTODELETE_OUTPUTFILES

public static final BooleanConfigurationOption GENERAL__AUTODELETE_OUTPUTFILES

Delete files, which will be used as output without further confirmation (e.g. knowledge base files, ...)

USERINTERFACE__NUMBER_OF_RECENT_PROJECTS

public static final IntegerConfigurationOption USERINTERFACE__NUMBER_OF_RECENT_PROJECTS

The number of recent projects that should be saved.

USERINTERFACE__RECENT_PROJECTS

public static final PathListConfigurationOption USERINTERFACE__RECENT_PROJECTS

The list of recent projects (for the "Open recent" menu item).

USERINTERFACE__AUTOSAVE_WINDOW_BOUNDS

public static final BooleanConfigurationOption USERINTERFACE__AUTOSAVE_WINDOW_BOUNDS

Indicates whether window bounds should be autosaved.

USERINTERFACE__WINDOW_WIDTH

public static final IntegerConfigurationOption USERINTERFACE__WINDOW_WIDTH

Width of main KReator window.

USERINTERFACE__WINDOW_HEIGHT

public static final IntegerConfigurationOption USERINTERFACE__WINDOW_HEIGHT

Height of main KReator window.

USERINTERFACE__WINDOW_POS_X

public static final IntegerConfigurationOption USERINTERFACE__WINDOW_POS_X

X-Pos of main KReator window.

USERINTERFACE__WINDOW_POS_Y

public static final IntegerConfigurationOption USERINTERFACE__WINDOW_POS_Y

Y-Pos of main KReator window.

USERINTERFACE__SPLITPANE1_POS

public static final IntegerConfigurationOption USERINTERFACE__SPLITPANE1_POS

Pos of projectVsFiles Splitpane.

USERINTERFACE__SPLITPANE2_POS

public static final IntegerConfigurationOption USERINTERFACE__SPLITPANE2_POS

Pos of prjFilesVsOutlineSplit Splitpane.

USERINTERFACE__SPLITPANE3_POS

public static final IntegerConfigurationOption USERINTERFACE__SPLITPANE3_POS

Pos of prjFilesOutlVsOutputSplit Splitpane.

USERINTERFACE__SPLITPANE4_POS

public static final IntegerConfigurationOption USERINTERFACE__SPLITPANE4_POS

Pos of primaryVsOptionalSplit Splitpane.

USERINTERFACE__SPLITPANE5_POS

public static final IntegerConfigurationOption USERINTERFACE__SPLITPANE5_POS

Pos of consoleVsReportSplit Splitpane

USERINTERFACE__SHOW_LOGGING_PANE

public static final BooleanConfigurationOption USERINTERFACE__SHOW_LOGGING_PANE

If this is set to true the logging pane und system text area will be included in the main window.

EDITOR__LEXER

public static final StringConfigurationOption EDITOR__LEXER

No idea what thats for.

EDITOR__USE_SIMPLE_LEXER

public static final BooleanConfigurationOption EDITOR__USE_SIMPLE_LEXER

If this is set to true the syntax pane will use a very simple lexer for all files.

EDITOR__LEXER_MIN_TIME

public static final IntegerConfigurationOption EDITOR__LEXER_MIN_TIME

No idea what thats for.

EDITOR__LEXER_MAX_TIME

public static final IntegerConfigurationOption EDITOR__LEXER_MAX_TIME

If the syntax highlighting takes more than this MAX_TIME the user will be asked, if he wants to use the a more simple lexer.

CONSOLE__AUTOSAVE_COMMAND_HISTORY

public static final BooleanConfigurationOption CONSOLE__AUTOSAVE_COMMAND_HISTORY

Indicates whether autosaving the command history is enabled.

CONSOLE__AUTOLOAD_COMMAND_HISTORY

public static final BooleanConfigurationOption CONSOLE__AUTOLOAD_COMMAND_HISTORY

Indicates whether autoloading the command history is enabled.

CONSOLE__MAXLENGTH_COMMAND_HISTORY

public static final IntegerConfigurationOption CONSOLE__MAXLENGTH_COMMAND_HISTORY

The maximal length of the command history.

CONSOLE__COMMAND_HISTORY_IS_PROJECT_SPECIFIC

public static final BooleanConfigurationOption CONSOLE__COMMAND_HISTORY_IS_PROJECT_SPECIFIC

Whether command history is saved in project file (project specific) or general configuration

CONSOLE__COMMAND_HISTORY

public static final StringListConfigurationOption CONSOLE__COMMAND_HISTORY

The command history.

CONSOLE__VERBOSE_OUTPUT

public static final BooleanConfigurationOption CONSOLE__VERBOSE_OUTPUT

Verbose output for queries, etc.

CONSOLE__AUTO_COMPLETE_DELAY

public static final IntegerConfigurationOption CONSOLE__AUTO_COMPLETE_DELAY

Delay until console suggests possible completions of the current command line

CONSOLE__MAX_CHARACTERS

public static final IntegerConfigurationOption CONSOLE__MAX_CHARACTERS

Number of characters after that the first half of the console will be cleared.

QUERIES__QUERY_HISTORY_IS_PROJECT_SPECIFIC

public static final BooleanConfigurationOption QUERIES__QUERY_HISTORY_IS_PROJECT_SPECIFIC

Whether query history is saved in project file (project specific) or general configuration

QUERIES__QUERY_HISTORY

public static final StringListConfigurationOption QUERIES__QUERY_HISTORY

The query history of the query dialog.

PLUGINS__INSTALLED_PLUGINS

public static final PathListConfigurationOption PLUGINS__INSTALLED_PLUGINS

The plugins currently installed in KReator.

LATEX_ENVIRONMENT

public static final StringConfigurationOption LATEX_ENVIRONMENT

LATEX_PREDICATE

public static final StringConfigurationOption LATEX_PREDICATE

LATEX_VARIABLE

public static final StringConfigurationOption LATEX_VARIABLE

LATEX_CONSTANT

public static final StringConfigurationOption LATEX_CONSTANT

Constructor Detail

Configuration

public Configuration()

Method Detail

getConfiguration

public static java.util.List<ConfigurationCategory> getConfiguration()

This method is invoked by ConfigurationFacility when the configuration is initialized.

Returns:

A list of configuration categories, the whole KReator configuration.

getOption

public static ConfigurationOption getOption(java.lang.String pathId)
                                     throws java.lang.IllegalArgumentException

This method retrieves the configuration option for the given path id.

Parameters:

pathId - a path id for an option.

Returns:

the configuration option for the given path id.

Throws:

java.lang.IllegalArgumentException - if the given path id does not match any configuration option.

getUserInterfaceConfig

public static ConfigurationCategory getUserInterfaceConfig()

This method provides the configuration options for the "User Interface" category.

Returns:

a configuration category.

getLatexConfig

public static ConfigurationCategory getLatexConfig()

This method provides the configuration options for the "LaTeX" category.

Returns:

a configuration category.

getEditorConfig

public static ConfigurationCategory getEditorConfig()

This method provides the configuration options for the "Editor" category.

Returns:

a configuration category.

getConsoleConfig

public static ConfigurationCategory getConsoleConfig()

This method provides the configuration options needed for the "Console" category.

Returns:

a configuration category.

getPluginsConfig

public static ConfigurationCategory getPluginsConfig()

This method provides the configuration options needed for the "Plugins" category.

Returns:

a configuration category.

getQueriesConfig

public static ConfigurationCategory getQueriesConfig()

This method provides the configuration options needed for the "Queries" category.

Returns:

a configuration category.