edu.cmu.sphinx.util.props

Interface Configurable

All Known Subinterfaces:

AcousticModel, AcousticScorer, ActiveListManager, AudioFileProcessListener, ControlFile, DataProcessor, DataProducer, Dictionary, LanguageModel, Learner, Linguist, Loader, Monitor, Pruner, ResultListener, ResultProducer, Saver, ScoreNormalizer, SearchManager, StateListener, TrainManager

All Known Implementing Classes:

AbstractDecoder, AbstractFeatureExtractor, AbstractVoiceActivityDetector, AccuracyTracker, ActiveListFactory, AFlatLinguist, AlignerGrammar, AllphoneLinguist, AudioContinuityTester, AudioFileDataSource, AutoCepstrum, BackgroundModelNormalizer, BaseDataProcessor, BatchAGC, BatchCMN, BatchForcedAlignerGrammar, BatchForcedAlignerRecognizer, BatchModeRecognizer, BatchNISTRecognizer, BatchVarNorm, BaumWelchLearner, BestPathAccuracyTracker, ClassBasedLanguageModel, ClassMap, ClassPresentingDictionary, ConcatAudioFileDataSource, ConcatFeatureExtractor, ConcatFileDataSource, ConfigMonitor, ConfigurableAdapter, DataBlocker, DataBufferProcessor, DataConverter, DataDumper, Decoder, DeltasFeatureExtractor, Denoise, DiscreteCosineTransform, DiscreteCosineTransform2, DiscreteFourierTransform, Dither, DynamicFlatLinguist, DynamicTrigramModel, EnergyFilter, EnergyPlotter, FeatureTransform, FlatInitializerLearner, FlatLinguist, ForcedAlignerGrammar, FrameDecoder, FrameDropper, FrontEnd, FrontEndSplitter, FSTGrammar, GainControlProcessor, GDLDumper, Grammar, GrXMLGrammar, HTKLoader, InterpolatedLanguageModel, JSGFGrammar, KaldiDeltasFeatureExtractor, KaldiDiscreteCosineTransform, KaldiLoader, KeywordOptimizerLargeNGramModel, KeywordOptimizerModel, LargeNGramModel, LargeTrigramModel, LatticeGrammar, LexTreeLinguist, Lifter, LinguistDumper, LinguistProcessor, LinguistStats, LiveCMN, LiveModeRecognizer, LMGrammar, MappingDictionary, MaxScoreNormalizer, MelFrequencyFilterBank, MelFrequencyFilterBank2, MemoryTracker, Microphone, ModelInitializerLoader, NetworkLanguageModel, NgramTrieModel, NullPruner, PartitionActiveListFactory, PLPCepstrumProducer, PLPFrequencyFilterBank, Preemphasizer, RaisedCosineWindower, Recognizer, RecognizerMonitor, RejectionTracker, S3FeatureExtractor, SimpleAcousticScorer, SimpleActiveListFactory, SimpleActiveListManager, SimpleBreadthFirstSearchManager, SimpleControlFile, SimpleNGramModel, SimplePruner, SimpleTrainManager, SimpleWordListGrammar, SortingActiveListFactory, SpeechClassifier, SpeechMarker, SpeedTracker, Sphinx3Loader, Sphinx3Saver, StreamCepstrumSource, StreamDataSource, StreamHTKCepstrum, TextDictionary, ThreadedAcousticScorer, TiedStateAcousticModel, TokenHeapSearchManager, TokenSearchManager, Trainer, TrainerAcousticModel, TrainerDictionary, TrivialAcousticModel, UnitManager, VUMeterMonitor, WavWriter, WordActiveListFactory, WordPruningBreadthFirstLookaheadSearchManager, WordPruningBreadthFirstSearchManager

public interface Configurable

Defines the interface that must be implemented by any configurable component in Sphinx-4. The life cycle of a component is as follows:

• Class Parsing The class file is parsed in order to determine all its configurable properties. These are defined using public static final String fields which are annotated with one of the following annotations:
  • S4Integer
  • S4Double
  • S4Boolean
  • S4Component
  • S4ComponentList
  Further informations about property-specific fields can be found in the javadoc of the property-annotation-definitions. Only names of annotated properties will be allowed by the configuration system later on.
• Construction - The (empty) component constructor is called in order to instantiate the component. Typically the constructor does little, if any work, since the component has not been configured yet.
• Configuration - Shortly after instantiation, the component's newProperties method is called. This method is called with a PropertySheet containing the properties (usually taken from an external configuration file). The component should extract the properties from the property sheet. If some properties defined for a component does not fulfill the property definition given by the annotation (type, range, etc.) a PropertyException is thrown. Typically, once a component gets its configuration data via the newData method, the component will initialize itself.

  Note: In most cases newProperties is called only once as a result of system configuration during startup. But nevertheless it is possible (and sometimes necessary) to reconfigure a component while it's running. Therefore, a well behaved component should react properly to multiple newProperties calls.

Connecting to other components

Components often need to interact with other components in the system. One of the design goals of Sphinx-4 is that it allows for very flexible hook up of components in the system. Therefore, it is *not* considered good S4 style to hardcode which subcomponents a particular subcomponent is interacting with. Instead, the component should use the configuration manager to provide the hook up to another component.

For example, if a component needs to interact with a Linguist. Instead of explicitly setting which linguist is to be used via a constructor or via a setLinguist call, the component should instead define a configuration property for the linguist. This would be done like so: \@S4Component(type=Linguist.class) public static String PROP_LINGUIST = "linguist";

The linguist is made available in the newProperties method, like so:

public void newProperties(PropertySheet propertySheet) { linguist = (Linguist) propertySheet.getComponent(PROP_LINGUIST); } This getComponent call will find the proper linguist based upon the configuration data. Thus, if the configuration for this component had the 'linguist' defined to be 'dynamicLexTreeLinguist', then the configuration manager will look up and return a linguist with that name, creating and configuring it as necessary. Of course, the dynamicLexTreeLinguist itself may have a number of sub-components that will be created and configured as a result. If the component doesn't exist (but was defined to mandatory) and no configuration information is found in the config file for it, or if it is of the wrong type, a PropertyException will be thrown.

Method Summary

Modifier and Type	Method and Description
void	newProperties(PropertySheet ps) This method is called when this configurable component needs to be reconfigured.

Method Detail

newProperties

void newProperties(PropertySheet ps)
            throws PropertyException

This method is called when this configurable component needs to be reconfigured.

Parameters:

ps - a property sheet holding the new data

Throws:

PropertyException - if there is a problem with the properties.