Package gda.util.userOptions

Interface UserOptionsService

All Superinterfaces:

Configurable, Findable

All Known Implementing Classes:

UserOptionsManager

public interface UserOptionsService
extends Findable, Configurable

Service Interface for maintaining run-time options with a set of current values stored in the specified location, typically the current visit. A set of default (template) values are maintained in the beamline configuration. Each UserOption is referenced in the service-provided Map by a key. Properties are used to specify the template folder location and the default options filename

Field Summary

Fields

Modifier and Type	Field	Description
static final String	PROP_OPTIONS_FILENAME
static final String	PROP_TEMPLATE_DIRECTORY

Method Summary

Modifier and Type	Method	Description
UserOptionsMap	createOptionsMapFromTemplate()	Create a UserOptionsMap from the configuration template, using default values in template
UserOptionsMap	getOptions(String directory, String filename)	Fetches UserOptionsMap from specified file
UserOptionsMap	getOptionsCurrent()	Fetches UserOptionsMap from current visit folder
Boolean	hasTemplate()	Indicates that a template is available
UserOptionsMap	resetOptions(String directory, String filename)	Replaces UserOptionsMap from specified file with the default template values
UserOptionsMap	saveOptions(String directory, String filename, UserOptionsMap options)	Saves the UserOptionsMap to the specified file
UserOptionsMap	saveOptionsCurrent(UserOptionsMap options)	Saves the UserOptionsMap to the current visit directory

Methods inherited from interface gda.factory.Configurable

configure, isConfigureAtStartup, isConfigured, reconfigure

Methods inherited from interface gda.factory.Findable

getName, setName

Field Details

PROP_OPTIONS_FILENAME

static final String PROP_OPTIONS_FILENAME

See Also:

• Constant Field Values

PROP_TEMPLATE_DIRECTORY

static final String PROP_TEMPLATE_DIRECTORY

See Also:

• Constant Field Values

Method Details

createOptionsMapFromTemplate

UserOptionsMap createOptionsMapFromTemplate()
                                     throws org.apache.commons.configuration.ConfigurationException,
IOException

Create a UserOptionsMap from the configuration template, using default values in template

Returns:

UserOptionsMap using default template values

Throws:

org.apache.commons.configuration.ConfigurationException

IOException

getOptionsCurrent

UserOptionsMap getOptionsCurrent()
                          throws org.apache.commons.configuration.ConfigurationException,
IOException

Fetches UserOptionsMap from current visit folder

Returns:

UserOptionsMap with values from options file in visit folder

Throws:

org.apache.commons.configuration.ConfigurationException

IOException

getOptions

UserOptionsMap getOptions(String directory,
 String filename)
                   throws org.apache.commons.configuration.ConfigurationException,
IOException

Fetches UserOptionsMap from specified file

Parameters:

directory - location of options file name

filename - for options file

Returns:

UserOptionsMap with template defaults updated by specified file

Throws:

org.apache.commons.configuration.ConfigurationException

IOException

hasTemplate

Boolean hasTemplate()

Indicates that a template is available

Returns:

true if service is configured and template exists

resetOptions

UserOptionsMap resetOptions(String directory,
 String filename)
                     throws org.apache.commons.configuration.ConfigurationException,
IOException

Replaces UserOptionsMap from specified file with the default template values

Parameters:

directory - location of options file name

filename - for options file

Returns:

UserOptionsMap using default template values

Throws:

org.apache.commons.configuration.ConfigurationException

IOException

saveOptions

UserOptionsMap saveOptions(String directory,
 String filename,
 UserOptionsMap options)
                    throws org.apache.commons.configuration.ConfigurationException,
IOException

Saves the UserOptionsMap to the specified file

Parameters:

directory - location of options file name

filename - for options file

options - map of options to save

Returns:

UserOptionsMap

Throws:

org.apache.commons.configuration.ConfigurationException

IOException

saveOptionsCurrent

UserOptionsMap saveOptionsCurrent(UserOptionsMap options)
                           throws org.apache.commons.configuration.ConfigurationException,
IOException

Saves the UserOptionsMap to the current visit directory

Parameters:

options - map of options to save

Returns:

UserOptionsMap

Throws:

org.apache.commons.configuration.ConfigurationException

IOException