propertysheet.java

It is the Speech recognition software. It is platform independent. To execute the source code,

/*
 * 
 * Copyright 1999-2004 Carnegie Mellon University.  
 * Portions Copyright 2004 Sun Microsystems, Inc.  
 * Portions Copyright 2004 Mitsubishi Electric Research Laboratories.
 * All Rights Reserved.  Use is subject to license terms.
 * 
 * See the file "license.terms" for information on usage and
 * redistribution of this file, and for a DISCLAIMER OF ALL 
 * WARRANTIES.
 *
 */
package edu.cmu.sphinx.util.props;
import java.util.List;
import java.util.logging.Logger;
import java.io.PrintStream;
import java.net.URL;
/**
 * A property sheet defines a collection of properties for a single component
 * in the system.
 */
public interface PropertySheet {
    /**
     * Sets the given property to the given name
     * 
     * @param name
     *            the simple property name
     * @param value
     *            the value for the property
     * 
     *  
     */
    void setString(String name, String value) throws PropertyException;
    /**
     * Sets the given property to the given name
     * 
     * @param name
     *            the simple property name
     * @param value
     *            the value for the property
     */
    void setInt(String name, int value) throws PropertyException;
    /**
     * Sets the given property to the given name
     * 
     * @param name
     *            the simple property name
     * @param value
     *            the value for the property
     */
    void setFloat(String name, float value) throws PropertyException;
    /**
     * Gets the value associated with this name
     * 
     * @param name
     *            the name
     * @param defaultValue
     *            the default value for the property
     * @return the value
     */
    String getString(String name, String defaultValue) throws PropertyException;

    /**
     * Sets the raw property to the given name
     * 
     * @param key
     *            the simple property name
     * @param val
     *            the value for the property
     */
    public void setRaw(String key, Object val) throws PropertyException ;
    /**
     * Gets the value associated with this name
     * 
     * @param name
     *            the name
     * @param defaultValue
     *            the default value for the property
     * @return the value
     * @throws PropertyException
     *             if the named property is not of this type
     */
    int getInt(String name, int defaultValue) throws PropertyException;
    /**
     * Gets the value associated with this name
     * 
     * @param name
     *            the name
     * @param defaultValue
     *            the default value
     * @return the value
     * @throws PropertyException
     *             if the named property is not of this type
     */
    float getFloat(String name, float defaultValue) throws PropertyException;
    /**
     * Gets the value associated with this name
     * 
     * @param name
     *            the name
     * @param defaultValue
     *            the default value
     * @return the value
     * @throws PropertyException
     *             if the named property is not of this type
     */
    double getDouble(String name, double defaultValue) throws PropertyException;
    /**
     * Gets the value associated with this name
     * 
     * @param name
     *            the name
     * @param defaultValue
     *            the default value
     * @return the value
     * @throws PropertyException
     *             if the named property is not of this type
     */
    boolean getBoolean(String name, boolean defaultValue)
            throws PropertyException;


    /**
     * Gets a resource associated with the given parameter name
     *
     * @param name the parameter name
     * @return the resource associated with the name or NULL if it
     * doesn't exist.
     * @throws PropertyException
     *             if the resource cannot be found
     */
    URL getResource(String name) throws PropertyException;

    /**
     * Gets a component associated with the given parameter name
     * 
     * @param name
     *            the parameter name
     * @param type
     *            the desired component type
     * @return the component associated with the name
     * @throws PropertyException
     *             if the component does not exist or is of the wrong type.
     *  
     */
    Configurable getComponent(String name, Class type) throws PropertyException;
    /**
     * Gets a list of components associated with the given parameter name
     * 
     * @param name
     *            the parameter name
     * @param type
     *            the desired component type
     * @return the component associated with the name
     * @throws PropertyException
     *             if the component does not exist or is of the wrong type.
     *  
     */
    List getComponentList(String name, Class type) throws PropertyException;
    /**
     * Gets the list of strings associated with this name
     * 
     * @param name
     *            the name
     * 
     * @return an array (possibly empty) of configurable strings
     * @throws PropertyException
     *             if the named property is not of this type
     */
    List getStrings(String name) throws PropertyException;
    /**
     * Retrieves the names of all the properties currently defined for this
     * property sheet
     * 
     * @return the array of names
     */
    String[] getNames();
    /**
     * Gets the raw value associated with this name
     * 
     * @param name
     *            the name
     * @return the value as an object (it could be a String or a String[]
     *         depending upon the property type)
     */
    Object getRaw(String name) throws PropertyException;

    /**
     * Gets the raw value associated with this name, no global symbol
     * replacement is performed.
     * 
     * @param name
     *            the name
     * @return the value as an object (it could be a String or a String[]
     *         depending upon the property type)
     */
    public Object getRawNoReplacment(String name);
    /**
     * Gets the owning property manager
     * 
     * @return the property manager
     */
    ConfigurationManager getPropertyManager() throws PropertyException;
    
    
    /**
     * Returns a logger to use for this configurable component.
     * The logger can be configured with the property: 'logLevel' -
     * The default logLevel value is define by the global property 
     * 'defaultLogLevel' (which defaults to WARNING).
     * @return the logger for this component
     * @throws PropertyException if an error occurs
     */
    Logger getLogger() throws PropertyException;

    /**
     * Dumps this sheet to the given stream
     *
     * @param out the print stream to dump the sheet on
     */
    public void dump(PrintStream out);
}