edu.cmu.sphinx.util.props

Class PropertySheet

java.lang.Object

edu.cmu.sphinx.util.props.PropertySheet

All Implemented Interfaces:

java.lang.Cloneable

public class PropertySheet
extends java.lang.Object
implements java.lang.Cloneable

A property sheet which defines a collection of properties for a single component in the system.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	COMP_LOG_LEVEL

Constructor Summary

Constructors

Constructor and Description
PropertySheet(java.lang.Class<? extends Configurable> confClass, java.lang.String name, ConfigurationManager cm, RawPropertyData rpd)
PropertySheet(Configurable configurable, java.lang.String name, RawPropertyData rpd, ConfigurationManager ConfigurationManager)

Method Summary

Modifier and Type	Method and Description
protected PropertySheet	clone()
boolean	equals(java.lang.Object obj) Returns true if two property sheet define the same object in terms of configuration.
java.lang.Boolean	getBoolean(java.lang.String name) Gets the value associated with this name
Configurable	getComponent(java.lang.String name) Gets a component associated with the given parameter name.
java.lang.Class<? extends Configurable>	getComponentClass(java.lang.String propName) Returns the class of of a registered component property without instantiating it.
<T> java.util.List<T>	getComponentList(java.lang.String name, java.lang.Class<T> tclass) Gets a list of components associated with the given parameter name
java.lang.Class<? extends Configurable>	getConfigurableClass()
double	getDouble(java.lang.String name) Gets the value associated with this name
float	getFloat(java.lang.String name) Gets the value associated with this name
java.lang.String	getInstanceName()
int	getInt(java.lang.String name) Gets the value associated with this name
java.util.logging.Logger	getLogger() Returns a logger to use for this configurable component.
Configurable	getOwner()
S4PropWrapper	getProperty(java.lang.String name, java.lang.Class<?> propertyClass) Returns the property names name which is still wrapped into the annotation instance.
java.lang.Object	getRaw(java.lang.String name) Gets the raw value associated with this name
java.lang.Object	getRawNoReplacement(java.lang.String name) Gets the raw value associated with this name, no global symbol replacement is performed.
java.util.Collection<java.lang.String>	getRegisteredProperties()
java.util.List<java.net.URL>	getResourceList(java.lang.String name) Parses the string with multiple URL's separated by ;.
java.lang.String	getString(java.lang.String name) Gets the value associated with this name
java.util.List<java.lang.String>	getStringList(java.lang.String name) Gets a list of float numbers associated with the given parameter name
PropertyType	getType(java.lang.String propName) Returns the type of the given property.
java.util.Collection<java.lang.String>	getUndefinedMandatoryProps()
int	hashCode()
boolean	isInstanciated()
void	setBoolean(java.lang.String name, java.lang.Boolean value) Sets the given property to the given name
void	setCM(ConfigurationManager cm)
void	setComponent(java.lang.String name, java.lang.String cmName, Configurable value) Sets the given property to the given name
void	setComponentList(java.lang.String name, java.util.List<java.lang.String> valueNames, java.util.List<Configurable> value) Sets the given property to the given name
void	setDouble(java.lang.String name, double value) Sets the given property to the given name
void	setInstanceName(java.lang.String newInstanceName)
void	setInt(java.lang.String name, int value) Sets the given property to the given name
void	setString(java.lang.String name, java.lang.String value) Sets the given property to the given name
java.lang.String	toString()
boolean	validate() Validates a configuration, by ensuring that only valid property-names have been used to configure the component.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Field Detail

COMP_LOG_LEVEL

public static final java.lang.String COMP_LOG_LEVEL

See Also:

Constant Field Values

Constructor Detail

PropertySheet

public PropertySheet(Configurable configurable,
                     java.lang.String name,
                     RawPropertyData rpd,
                     ConfigurationManager ConfigurationManager)

PropertySheet

public PropertySheet(java.lang.Class<? extends Configurable> confClass,
                     java.lang.String name,
                     ConfigurationManager cm,
                     RawPropertyData rpd)

Method Detail

getProperty

public S4PropWrapper getProperty(java.lang.String name,
                                 java.lang.Class<?> propertyClass)
                          throws PropertyException

Returns the property names name which is still wrapped into the annotation instance.

Parameters:

name - the name of the property

propertyClass - the class of the property

Returns:

the wrapper around property

Throws:

PropertyException - if there is no such property

getString

public java.lang.String getString(java.lang.String name)
                           throws PropertyException

Gets the value associated with this name

Parameters:

name - the name

Returns:

the value

Throws:

PropertyException

getInt

public int getInt(java.lang.String name)
           throws PropertyException

Gets the value associated with this name

Parameters:

name - the name

Returns:

the value

Throws:

PropertyException - if the named property is not of this type

getFloat

public float getFloat(java.lang.String name)
               throws PropertyException

Gets the value associated with this name

Parameters:

name - the name

Returns:

the value

Throws:

PropertyException - if the named property is not of this type

getDouble

public double getDouble(java.lang.String name)
                 throws PropertyException

Gets the value associated with this name

Parameters:

name - the name

Returns:

the value

Throws:

PropertyException - if the named property is not of this type

getBoolean

public java.lang.Boolean getBoolean(java.lang.String name)
                             throws PropertyException

Gets the value associated with this name

Parameters:

name - the name

Returns:

the value

Throws:

PropertyException - if the named property is not of this type

getComponent

public Configurable getComponent(java.lang.String name)
                          throws PropertyException

Gets a component associated with the given parameter name. First search the component in property table, then try to get component by name from the manager, then creates component with default properties.

Parameters:

name - the parameter name

Returns:

the component associated with the name

Throws:

PropertyException - if the component does not exist or is of the wrong type.

getComponentClass

public java.lang.Class<? extends Configurable> getComponentClass(java.lang.String propName)

Returns the class of of a registered component property without instantiating it.

Parameters:

propName - the name of the property

Returns:

class of the component corresponding to that property

getStringList

public java.util.List<java.lang.String> getStringList(java.lang.String name)
                                               throws InternalConfigurationException

Gets a list of float numbers associated with the given parameter name

Parameters:

name - the parameter name

Returns:

a list of floats associated with the name.

Throws:

InternalConfigurationException - if parameters are not double values.

getComponentList

public <T> java.util.List<T> getComponentList(java.lang.String name,
                                              java.lang.Class<T> tclass)
                                       throws InternalConfigurationException

Gets a list of components associated with the given parameter name

Type Parameters:

T - parent component

Parameters:

name - the parameter name

tclass - the class of the list elements

Returns:

the component associated with the name

Throws:

PropertyException - if the component does not exist or is of the wrong type.

InternalConfigurationException

getResourceList

public java.util.List<java.net.URL> getResourceList(java.lang.String name)

Parses the string with multiple URL's separated by ;. Return the list of resources to load

Parameters:

name - list with URL's

Returns:

list of resources

getInstanceName

public java.lang.String getInstanceName()

setInstanceName

public void setInstanceName(java.lang.String newInstanceName)

isInstanciated

public boolean isInstanciated()

Returns:

true if the owner of this property sheet is already instantiated.

getOwner

public Configurable getOwner()

Returns:

the owner of this property sheet. In most cases this will be the configurable instance which was instrumented by this property sheet.

getUndefinedMandatoryProps

public java.util.Collection<java.lang.String> getUndefinedMandatoryProps()

Returns:

the set of all component properties which were tagged as mandatory but which are not set (or no default value is given).

getConfigurableClass

public java.lang.Class<? extends Configurable> getConfigurableClass()

Returns:

the class of the owner configurable of this property sheet.

setString

public void setString(java.lang.String name,
                      java.lang.String value)
               throws PropertyException

Sets the given property to the given name

Parameters:

name - the simple property name

value - to set

Throws:

PropertyException - if error occurred

setInt

public void setInt(java.lang.String name,
                   int value)
            throws PropertyException

Sets the given property to the given name

Parameters:

name - the simple property name

value - the value for the property

Throws:

PropertyException

setDouble

public void setDouble(java.lang.String name,
                      double value)
               throws PropertyException

Sets the given property to the given name

Parameters:

name - the simple property name

value - the value for the property

Throws:

PropertyException

setBoolean

public void setBoolean(java.lang.String name,
                       java.lang.Boolean value)
                throws PropertyException

Sets the given property to the given name

Parameters:

name - the simple property name

value - the value for the property

Throws:

PropertyException

setComponent

public void setComponent(java.lang.String name,
                         java.lang.String cmName,
                         Configurable value)
                  throws PropertyException

Sets the given property to the given name

Parameters:

name - the simple property name

cmName - the name of the configurable within the configuration manager (required for serialization only)

value - the value for the property

Throws:

PropertyException

setComponentList

public void setComponentList(java.lang.String name,
                             java.util.List<java.lang.String> valueNames,
                             java.util.List<Configurable> value)
                      throws PropertyException

Sets the given property to the given name

Parameters:

name - the simple property name

valueNames - the list of names of the configurables within the configuration manager (required for serialization only)

value - the value for the property

Throws:

PropertyException

getRaw

public java.lang.Object getRaw(java.lang.String name)

Gets the raw value associated with this name

Parameters:

name - the name

Returns:

the value as an object (it could be a String or a String[] depending upon the property type)

getRawNoReplacement

public java.lang.Object getRawNoReplacement(java.lang.String name)

Gets the raw value associated with this name, no global symbol replacement is performed.

Parameters:

name - the name

Returns:

the value as an object (it could be a String or a String[] depending upon the property type)

getType

public PropertyType getType(java.lang.String propName)

Returns the type of the given property.

Parameters:

propName - the name of the property

Returns:

the type of the property

getLogger

public java.util.logging.Logger getLogger()

Returns a logger to use for this configurable component. The logger can be configured with the property: 'logLevel' - The default logLevel value is defined (within the xml configuration file by the global property 'defaultLogLevel' (which defaults to WARNING).

implementation note: the logger became configured within the constructor of the parenting configuration manager.

Returns:

the logger for this component

Throws:

PropertyException - if an error occurs

getRegisteredProperties

public java.util.Collection<java.lang.String> getRegisteredProperties()

Returns:

the names of registered properties of this PropertySheet object.

setCM

public void setCM(ConfigurationManager cm)

equals

public boolean equals(java.lang.Object obj)

Returns true if two property sheet define the same object in terms of configuration. The owner (and the parent configuration manager) are not expected to be the same.

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object

clone

protected PropertySheet clone()
                       throws java.lang.CloneNotSupportedException

Overrides:

clone in class java.lang.Object

Throws:

java.lang.CloneNotSupportedException

validate

public boolean validate()

Validates a configuration, by ensuring that only valid property-names have been used to configure the component.

Returns:

if property is validated