Package com.nt.udc.aggregator

Class AggregatorModule

java.lang.Object
com.nt.udc.aggregator.AggregatorModule
Direct Known Subclasses:
AggrCalcFields, AggrConfig, AggrKeyFactory, AggrShifter, AggrTable, AggrUtilityFields, GPRSAggregatorModule, TableFlush, TimeGrouper, TimerFlush, VOIPAggregatorModule
public abstract class AggregatorModule extends Object
This class defines some common elements about a given aggregator "plug-in" feature. The intent is to modularize parts of the aggregator such that they are not interdependant, and need to be in the same aggregator. This allows for many aggregators, using only the modules that are necessary.

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    protected ConfigIfc
    config
     
    protected LoggerIfc
    logger
     

  • Constructor Summary

    Constructors
    Constructor
    Description
    AggregatorModule(ConfigIfc config, LoggerIfc logger)
    Creates the module with a config object and a logger object.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected abstract void
    getConfigData()
    This method should obtain the necessary information from the config class, in order to configure the module.
    abstract int[]
    recordInitFields()
    This method should return those field ID's that should be included in a new record.
    abstract void
    shutdown()
    This method should handle shutting down the routines that have been started by this class.

    Methods inherited from class java.lang.Object

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

  • Field Details

  • Constructor Details

    • AggregatorModule

      public AggregatorModule(ConfigIfc config, LoggerIfc logger)
      Creates the module with a config object and a logger object.
      Parameters:
      config - Holds the node configuration settings
      logger - Handles logging status messages to the user

  • Method Details

    • getConfigData

      protected abstract void getConfigData()
      This method should obtain the necessary information from the config class, in order to configure the module.

    • recordInitFields

      public abstract int[] recordInitFields()
      This method should return those field ID's that should be included in a new record.
      Returns:
      Field ID's to include in a new record that is inserted into the table.

    • shutdown

      public abstract void shutdown()
      This method should handle shutting down the routines that have been started by this class.