emolib.statistic
Class Statistic

java.lang.Object
  extended by emolib.util.proc.TextDataProcessor
      extended by emolib.statistic.Statistic
All Implemented Interfaces:
Configurable, DataProcessor
Direct Known Subclasses:
ArithmeticMean

public abstract class Statistic
extends TextDataProcessor

The Statistic abstract class defines the general class to perform the statistical calculations.

At this point, the emotional words should already have their correspondent emotional dimensions. The purpose of this class is to compute a determined statistic and use it as an estimator of a population parameter which is not directly observable. These parameters should be available for all the levels of the data structure (sentence and paragraph levels).

Author:
Alexandre Trilla (atrilla@salle.url.edu)

Constructor Summary
Statistic()
          Main constructor of the Statistic processor.
 
Method Summary
abstract  void applyStatistics(TextData inputTextDataObject)
          Method to perform the statistical process.
 Data getData()
          Obtains the TextData from the previous module, processes it and makes it available to the rest of the text processing chain.
 void initialize()
          Method to initialize the Statistic.
 void newProperties(PropertySheet ps)
          This method is called when this configurable component has new data.
 void register(java.lang.String name, Registry registry)
          Register my properties.
 
Methods inherited from class emolib.util.proc.TextDataProcessor
flush, getName, getPredecessor, setPredecessor, toString
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Statistic

public Statistic()
Main constructor of the Statistic processor.

Method Detail

register

public void register(java.lang.String name,
                     Registry registry)
              throws PropertyException
Description copied from interface: Configurable
Register my properties. This method is called once early in the time of the component, shortly after the component is constructed. This component should register any configuration properties that it needs to register. If this configurable extends another configurable, super.register should also be called

Specified by:
register in interface Configurable
Overrides:
register in class TextDataProcessor
Parameters:
name - the name of the component
registry - the registry for this component
Throws:
PropertyException

newProperties

public void newProperties(PropertySheet ps)
                   throws PropertyException
Description copied from interface: Configurable
This method is called when this configurable component has new data. The component should first validate the data. If it is bad the component should return false. If the data is good, the component should record the the data internally and return true.

Specified by:
newProperties in interface Configurable
Overrides:
newProperties in class TextDataProcessor
Parameters:
ps - a property sheet holding the new data
Throws:
PropertyException - if there is a problem with the properties.

getData

public Data getData()
             throws DataProcessingException
Obtains the TextData from the previous module, processes it and makes it available to the rest of the text processing chain.

Specified by:
getData in interface DataProcessor
Specified by:
getData in class TextDataProcessor
Returns:
The next available Data object, returns null if no Data object is available.
Throws:
DataProcessingException - If there is a processing error.

initialize

public void initialize()
Method to initialize the Statistic.

Specified by:
initialize in interface DataProcessor
Overrides:
initialize in class TextDataProcessor

applyStatistics

public abstract void applyStatistics(TextData inputTextDataObject)
Method to perform the statistical process.

Parameters:
inputTextDataObject - The TextData object to process.