edu.cmu.sphinx.util.props

Class ConfigurationManagerUtils

java.lang.Object

edu.cmu.sphinx.util.props.ConfigurationManagerUtils

public final class ConfigurationManagerUtils
extends java.lang.Object

Some static utility methods which ease the handling of system configurations.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CM_FILE_SUFFIX The default file suffix of configuration files.
static java.lang.String	GLOBAL_COMMON_LOGLEVEL A common property (used by all components) that sets the log level for the component.

Method Summary

Modifier and Type	Method and Description
static void	configureLogger(ConfigurationManager cm) Configure the logger
static void	configureLogger(java.util.logging.Logger logger) Configures a logger to use the sphinx4-log-formatter.
static void	dumpPropStructure(ConfigurationManager cm)
static void	editConfig(ConfigurationManager cm, java.lang.String name)
static java.util.Map<java.lang.String,java.lang.String>	fixDuplicateNames(ConfigurationManager baseCM, ConfigurationManager subCM) This method will automatically rename all components of subCM for which there is component named the same in the baseCM .
static java.lang.String	getLogPrefix(ConfigurationManager cm)
static java.util.Collection<java.lang.String>	getNonInstaniatedComps(ConfigurationManager cm) Returns the not yet instantiated components registered to this configuration manager.
static ConfigurationManager	getPropertyManager(PropertySheet ps) Why do we need this method?
static java.net.URL	getResource(java.lang.String name, PropertySheet ps) Gets a resource associated with the given parameter name given an property sheet.
static java.net.URL	getURL(java.io.File file)
static boolean	isDerivedClass(java.lang.Class<?> derived, java.lang.Class<?> parent)
static boolean	isImplementingInterface(java.lang.Class<?> aClass, java.lang.Class<?> interfaceClass)
static boolean	isSubClass(java.lang.Class<?> aClass, java.lang.Class<?> possibleSuperclass)
static java.util.Map<java.lang.String,java.util.List<PropertySheet>>	listAllsPropNames(ConfigurationManager cm) Returns a map of all component-properties of this config-manager (including their associated property-sheets.
static java.net.URL	resourceToURL(java.lang.String location)
static void	save(ConfigurationManager cm, java.io.File cmLocation)
static void	setClass(PropertySheet ps, java.lang.Class<? extends Configurable> confClass)
static void	setProperty(ConfigurationManager cm, java.lang.String propName, java.lang.String propValue) Attempts to set the value of an arbitrary component-property.
static void	setProperty(ConfigurationManager cm, java.lang.String componentName, java.lang.String propName, java.lang.String propValue)
static void	showConfig(ConfigurationManager cm) Shows the current configuration
static void	showConfig(ConfigurationManager cm, java.lang.String name) Show the configuration for the component with the given name
static java.lang.String	stripGlobalSymbol(java.lang.String symbol) Strips the ${ and } off of a global symbol of the form ${symbol}.
static java.util.List<java.lang.String>	toStringList(java.lang.Object obj)
static java.lang.String	toXML(ConfigurationManager cm) Converts a configuration manager instance into a xml-string .
boolean	validateConfiguration(ConfigurationManager cm) Validates that only annotated property names have been used to setup this instance of edu.cmu.sphinx.util.props.ConfigurationManager.

Methods inherited from class java.lang.Object

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

Field Detail

GLOBAL_COMMON_LOGLEVEL

public static final java.lang.String GLOBAL_COMMON_LOGLEVEL

A common property (used by all components) that sets the log level for the component.

See Also:

Constant Field Values

CM_FILE_SUFFIX

public static final java.lang.String CM_FILE_SUFFIX

The default file suffix of configuration files.

See Also:

Constant Field Values

Method Detail

validateConfiguration

public boolean validateConfiguration(ConfigurationManager cm)

Validates that only annotated property names have been used to setup this instance of edu.cmu.sphinx.util.props.ConfigurationManager.

Parameters:

cm - Configuration manager

Returns:

true if it is a valid configuration.

stripGlobalSymbol

public static java.lang.String stripGlobalSymbol(java.lang.String symbol)

Strips the ${ and } off of a global symbol of the form ${symbol}.

Parameters:

symbol - the symbol to strip

Returns:

the stripped symbol

editConfig

public static void editConfig(ConfigurationManager cm,
                              java.lang.String name)

getLogPrefix

public static java.lang.String getLogPrefix(ConfigurationManager cm)

configureLogger

public static void configureLogger(ConfigurationManager cm)

Configure the logger

Parameters:

cm - Configuration manager

configureLogger

public static void configureLogger(java.util.logging.Logger logger)

Configures a logger to use the sphinx4-log-formatter.

Parameters:

logger - logger to configure

fixDuplicateNames

public static java.util.Map<java.lang.String,java.lang.String> fixDuplicateNames(ConfigurationManager baseCM,
                                                                                 ConfigurationManager subCM)

This method will automatically rename all components of subCM for which there is component named the same in the baseCM .

Note: This is required when merging two system configurations into one.

Parameters:

baseCM - base configuration manager

subCM - other configuration manager

Returns:

A map which maps all renamed component names to their new names.

toXML

public static java.lang.String toXML(ConfigurationManager cm)

Converts a configuration manager instance into a xml-string . Note: This methods will not instantiate configurables.

Parameters:

cm - configuration manager

Returns:

xml representation

save

public static void save(ConfigurationManager cm,
                        java.io.File cmLocation)

showConfig

public static void showConfig(ConfigurationManager cm)

Shows the current configuration

Parameters:

cm - configuration manager

showConfig

public static void showConfig(ConfigurationManager cm,
                              java.lang.String name)

Show the configuration for the component with the given name

Parameters:

cm - configuration manager

name - the component name

getResource

public static java.net.URL getResource(java.lang.String name,
                                       PropertySheet ps)
                                throws PropertyException

Gets a resource associated with the given parameter name given an property sheet.

Parameters:

name - the parameter name

ps - The property sheet which contains the property

Returns:

the resource associated with the name or NULL if it doesn't exist.

Throws:

PropertyException - if the resource cannot be found

resourceToURL

public static java.net.URL resourceToURL(java.lang.String location)
                                  throws java.net.MalformedURLException

Throws:

java.net.MalformedURLException

isDerivedClass

public static boolean isDerivedClass(java.lang.Class<?> derived,
                                     java.lang.Class<?> parent)

Parameters:

derived - derived class

parent - parent class

Returns:

true if aClass is either equal to poosibleParent, a subclass of it, or implements it if possibleParent is an interface.

isImplementingInterface

public static boolean isImplementingInterface(java.lang.Class<?> aClass,
                                              java.lang.Class<?> interfaceClass)

isSubClass

public static boolean isSubClass(java.lang.Class<?> aClass,
                                 java.lang.Class<?> possibleSuperclass)

getPropertyManager

public static ConfigurationManager getPropertyManager(PropertySheet ps)

Why do we need this method? The reason is, that we would like to avoid this method to be part of the PropertySheet-API. In some circumstances it is nevertheless required to get access to the managing ConfigurationManager.

Parameters:

ps - Property sheet

Returns:

the new configuration manager

listAllsPropNames

public static java.util.Map<java.lang.String,java.util.List<PropertySheet>> listAllsPropNames(ConfigurationManager cm)

Returns a map of all component-properties of this config-manager (including their associated property-sheets.

Parameters:

cm - configuration manager

Returns:

map with properties

dumpPropStructure

public static void dumpPropStructure(ConfigurationManager cm)

setProperty

public static void setProperty(ConfigurationManager cm,
                               java.lang.String propName,
                               java.lang.String propValue)

Attempts to set the value of an arbitrary component-property. If the property-name is ambiguous with respect to the given ConfiguratioManager an extended syntax (componentName->propName) can be used to access the property.

Beside component properties it is also possible to modify the class of a configurable, but this is only allowed if the configurable under question has not been instantiated yet. Furthermore the user has to ensure to set all mandatory component properties.

Parameters:

cm - configuration manager

propName - property to set

propValue - value to set

setProperty

public static void setProperty(ConfigurationManager cm,
                               java.lang.String componentName,
                               java.lang.String propName,
                               java.lang.String propValue)

getURL

public static java.net.URL getURL(java.io.File file)

getNonInstaniatedComps

public static java.util.Collection<java.lang.String> getNonInstaniatedComps(ConfigurationManager cm)

Returns the not yet instantiated components registered to this configuration manager.

Parameters:

cm - configuration manager

Returns:

collection of instantiated components

setClass

public static void setClass(PropertySheet ps,
                            java.lang.Class<? extends Configurable> confClass)

toStringList

public static java.util.List<java.lang.String> toStringList(java.lang.Object obj)