Package com.caplin.transformer.module

Interface TransformerAccessor

public interface TransformerAccessor

Allows a Transformer module access to the main interfaces it requires to interact with the Transformer core.

  • Method Details

    • getDataCache

      DataCache getDataCache()

      Returns an object that allows the Transformer module to access the data cached within the Transformer's core.

      Returns:
      The DataCache object.

    • getDataProviderRegistrar

      DataProviderRegistrar getDataProviderRegistrar()

      Returns an object that allows the Transformer module to register and deregister itself with the Transformer core as a provider of data.

      Returns:
      The DataProviderRegistrar object.

    • getPipelineRegistrar

      PipelineRegistrar getPipelineRegistrar()

      Returns an object that allows the Transforme module to register methods for availability in pipelines

      Returns:
      The PipelineRegistrar object.

    • getUDPAccessor

      UDPAccessor getUDPAccessor()

      Returns an object that allows the Transformer module to access the Transformer core's UDP command interface. The module will be able to register and deregister listeners for UDP commands, and send its own UDP commands.

      Returns:
      The UDPAccessor object.

    • getSubscriber

      Subscriber getSubscriber()

      Returns an object that allows the Transformer module to subscribe to and unsubcribe from data.

      Returns:
      The Subscriber object.

    • getFieldManager

      FieldManager getFieldManager()

      Returns an instance of FieldManager, which represents all the fields that have been configured within the Transformer.

      Returns:
      The FieldManager object.

    • getLoggerName

      String getLoggerName()

      Returns the name of the Logger that will write messages out to the Transformer module's log file.

      Returns:
      The name of the Logger.

    • getLogger

      Logger getLogger()

      Returns the Logger that has the name getLoggerName().

      Returns:
      The Logger with the name getLoggerName().

    • expandFilename

      String expandFilename(String filename)

      Returns a fully qualified filename based on % substitution fields.

      The possible substitution fields are:

      • %a - the application name.
      • %n - the application name.
      • %r - the application root.
      Parameters:
      filename - The filename, including % substitution fields, to expand.
      Returns:
      The expanded filename.
      Throws:
      NullPointerException - If the filename is null.

    • getConfigProvider

      ConfigProvider getConfigProvider()

      Returns the config provider object which can be used to get certain Transformer configuration options that have been set

      Returns:
      The ConfigProvider object.