edu.jhu.ece.iacl.jist.pipeline
Class JistPreferences

java.lang.Object
  edu.jhu.ece.iacl.jist.pipeline.JistPreferences

public class JistPreferences
extends java.lang.Object

MAPS preferences.

Author:

Blake Lucas (bclucas@jhu.edu)

Nested Class Summary

static class	JistPreferences.NamingConvention The Enum NamingConvention.
static interface	JistPreferences.PreferenceListener Listens for changes in preferences.

Field Summary

protected int	debugLevel Debug Level
static java.lang.String[]	debugLevels The debug level location.
protected int	defaultMaxProcesses Default maximum number of simultaneous processes.
protected int	defaultMemory Default maximum heap size.
protected java.util.Vector<java.io.File>	fileHistory history of recent layout files.
static float	JIST_VERSION_ID Numeric revision for algorithm compatibility
protected java.lang.String	jre location of java executable.
protected java.io.File	lastDirectory last directory inspected.
static int	lgFontSize
protected java.util.LinkedList<JistPreferences.PreferenceListener>	listeners Listeners that react to changes in preferences.
protected int	maxHistorySize maximum number of files to display in history.
static int	mdFontSize
protected JistPreferences.NamingConvention	namingConvention namingConvention.
protected java.lang.String	preferredextension Preferred output extension for CubicVolumeReaderWriter.
static int	smFontSize
protected boolean	useGridEngine Use Grid Engine.

Constructor Summary

JistPreferences()
Default constructor.

Method Summary

void	addFileToHistory(java.io.File f) Add file to history.
void	addListener(JistPreferences.PreferenceListener listener) Add listener.
static java.io.File	askForJavaExecutable(java.io.File oldDir) Open file chooser to select directory.
static JistPreferences	fromXML(java.lang.String str) Reconstruct algorithm from string.
int	getDebugLevel() Gets the preferred level for debug output: 0 = Error messages only 1 = Major events and warnings ...
static java.lang.String	getDefaultLayoutExtension() Gets the default layout extension.
int	getDefaultMaxProcesses() Get default maximum number of processes.
int	getDefaultMemory() Get default maximum heap size.
static java.lang.String	getDefaultModuleExtension() Gets the default module extension.
static java.lang.String	getDefaultPreferencesFileName() Gets the default preferences file name.
java.util.Vector<java.io.File>	getFileHistory() Get list of recently accessed files.
java.lang.String	getJre() Get JRE executable.
java.io.File	getLastDirectory() Get last directory entered.
int	getLgFontSize()
int	getMaxHistorySize() Get maximum history size.
int	getMdFontSize()
JistPreferences.NamingConvention	getNamingConvention() Gets the naming convention.
static JistPreferences	getPreferences() Singleton method to get User Interface.
java.lang.String	getPreferredExtension() Get preferred extension (for CubicVolumeReaderWriter).
int	getSmFontSize()
static boolean	hasPreferences() Returns true if MAPS has preferences already.
boolean	isUseGridEngine() Checks if is use grid engine.
static void	loadPreferences() Load existing modules and add them to the tree.
static void	loadPreferences(boolean silentFailure) Load existing modules and add them to the tree.
static JistPreferences	read(java.io.File f) Read preferences from file.
void	removeListener(JistPreferences.PreferenceListener listener) Remove listener.
static boolean	savePreferences() Save preferences along library path as getDefaultPreferencesFileName().
void	setDebugLevel(int selected)
void	setDefaultMaxProcesses(int defaultMaxProcesses) Set default maximum number of processes.
void	setDefaultMemory(int defaultMemory) Set default maximum heap size.
void	setJre(java.lang.String jre) Set JRE executable.
void	setLastDirectory(java.io.File lastDirectory) Set last directory entered.
void	setLgFontSize(int selected)
void	setMdFontSize(int selected)
void	setNamingConvention(JistPreferences.NamingConvention namingConvention) Sets the naming convention.
static void	setPreferences(JistPreferences prefs) Set singleton reference to preferences.
void	setPreferredExtension(java.lang.String prefext) Set the preferred extension (for CubicVolumeReaderWriter).
void	setSmFontSize(int selected)
void	setUseGridEngine(boolean useGridEngine) Sets the use grid engine.
java.lang.String	toXML() Serialize class as XML.
boolean	write(java.io.File f) Write algorithm to file.

Methods inherited from class java.lang.Object

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

Field Detail

JIST_VERSION_ID

public static final float JIST_VERSION_ID

Numeric revision for algorithm compatibility

See Also:

Constant Field Values

defaultMemory

protected int defaultMemory

Default maximum heap size.

defaultMaxProcesses

protected int defaultMaxProcesses

Default maximum number of simultaneous processes.

fileHistory

protected java.util.Vector<java.io.File> fileHistory

history of recent layout files.

lastDirectory

protected java.io.File lastDirectory

last directory inspected.

maxHistorySize

protected int maxHistorySize

maximum number of files to display in history.

jre

protected java.lang.String jre

location of java executable.

preferredextension

protected java.lang.String preferredextension

Preferred output extension for CubicVolumeReaderWriter.

useGridEngine

protected boolean useGridEngine

Use Grid Engine.

namingConvention

protected JistPreferences.NamingConvention namingConvention

namingConvention.

debugLevel

protected int debugLevel

Debug Level

smFontSize

public static int smFontSize

mdFontSize

public static int mdFontSize

lgFontSize

public static int lgFontSize

listeners

protected transient java.util.LinkedList<JistPreferences.PreferenceListener> listeners

Listeners that react to changes in preferences.

debugLevels

public static final java.lang.String[] debugLevels

The debug level location.

Constructor Detail

JistPreferences

public JistPreferences()

Default constructor.

Method Detail

getDefaultLayoutExtension

public static java.lang.String getDefaultLayoutExtension()

Gets the default layout extension.

Returns:

the default layout extension

getDefaultModuleExtension

public static java.lang.String getDefaultModuleExtension()

Gets the default module extension.

Returns:

the default module extension

getDefaultPreferencesFileName

public static java.lang.String getDefaultPreferencesFileName()

Gets the default preferences file name.

Returns:

the default preferences file name

askForJavaExecutable

public static java.io.File askForJavaExecutable(java.io.File oldDir)

Open file chooser to select directory.

Parameters:

oldDir - the old directory

Returns:

absolute path of the file

fromXML

public static JistPreferences fromXML(java.lang.String str)

Reconstruct algorithm from string.

Parameters:

str - the string

Returns:

the maps preferences

getPreferences

public static JistPreferences getPreferences()

Singleton method to get User Interface.

Returns:

userInterface

hasPreferences

public static boolean hasPreferences()

Returns true if MAPS has preferences already.

Returns:

true if preferences exist

loadPreferences

public static void loadPreferences()

Load existing modules and add them to the tree.

loadPreferences

public static void loadPreferences(boolean silentFailure)

Load existing modules and add them to the tree.

read

public static JistPreferences read(java.io.File f)

Read preferences from file.

Parameters:

f - the file

Returns:

the maps preferences

savePreferences

public static boolean savePreferences()

Save preferences along library path as getDefaultPreferencesFileName().

Returns:

true if preferences saved correctly

setPreferences

public static void setPreferences(JistPreferences prefs)

Set singleton reference to preferences.

Parameters:

prefs - preferences

getNamingConvention

public JistPreferences.NamingConvention getNamingConvention()

Gets the naming convention.

Returns:

the naming convention

setNamingConvention

public void setNamingConvention(JistPreferences.NamingConvention namingConvention)

Sets the naming convention.

Parameters:

namingConvention - the new naming convention

isUseGridEngine

public boolean isUseGridEngine()

Checks if is use grid engine.

Returns:

true, if is use grid engine

setUseGridEngine

public void setUseGridEngine(boolean useGridEngine)

Sets the use grid engine.

Parameters:

useGridEngine - the new use grid engine

addFileToHistory

public void addFileToHistory(java.io.File f)

Add file to history.

Parameters:

f - file

addListener

public void addListener(JistPreferences.PreferenceListener listener)

Add listener.

Parameters:

listener - the listener

getDefaultMaxProcesses

public int getDefaultMaxProcesses()

Get default maximum number of processes.

Returns:

the default max processes

getDefaultMemory

public int getDefaultMemory()

Get default maximum heap size.

Returns:

heap size in MB

getFileHistory

public java.util.Vector<java.io.File> getFileHistory()

Get list of recently accessed files.

Returns:

the file history

getJre

public java.lang.String getJre()

Get JRE executable.

Returns:

the jre

getPreferredExtension

public java.lang.String getPreferredExtension()

Get preferred extension (for CubicVolumeReaderWriter).

Returns:

the preferred extension

getLastDirectory

public java.io.File getLastDirectory()

Get last directory entered.

Returns:

last directory

getMaxHistorySize

public int getMaxHistorySize()

Get maximum history size.

Returns:

maximum history size

removeListener

public void removeListener(JistPreferences.PreferenceListener listener)

Remove listener.

Parameters:

listener - the listener

setDefaultMaxProcesses

public void setDefaultMaxProcesses(int defaultMaxProcesses)

Set default maximum number of processes.

Parameters:

defaultMaxProcesses - maximum number of processes

setDefaultMemory

public void setDefaultMemory(int defaultMemory)

Set default maximum heap size.

Parameters:

defaultMemory - heap size in MB

setJre

public void setJre(java.lang.String jre)

Set JRE executable.

Parameters:

jre - the jre

setPreferredExtension

public void setPreferredExtension(java.lang.String prefext)

Set the preferred extension (for CubicVolumeReaderWriter).

Parameters:

prefext - the preferred extension

setLastDirectory

public void setLastDirectory(java.io.File lastDirectory)

Set last directory entered.

Parameters:

lastDirectory - the last directory

toXML

public java.lang.String toXML()

Serialize class as XML.

Returns:

the string

write

public boolean write(java.io.File f)

Write algorithm to file.

Parameters:

f - output file

Returns:

true, if write

getDebugLevel

public int getDebugLevel()

Gets the preferred level for debug output: 0 = Error messages only 1 = Major events and warnings ... 6 = All routine messages. THE FOLLOW MODES MAY IMPACT PERFORMANCE. USE WITH CAUTION! 7 - Intense debug 1 8 - Intense debug 2 9 - Intense debug 3

Returns:

debugLevel (int)

setDebugLevel

public void setDebugLevel(int selected)

getSmFontSize

public int getSmFontSize()

getMdFontSize

public int getMdFontSize()

getLgFontSize

public int getLgFontSize()

setSmFontSize

public void setSmFontSize(int selected)

setMdFontSize

public void setMdFontSize(int selected)

setLgFontSize

public void setLgFontSize(int selected)