Package org.corpus_tools.pepper.core

Interface ModuleResolver

    • Method Detail

      • getComponentContext

        org.osgi.service.component.ComponentContext getComponentContext()
        Returns the ComponentContext of the OSGi environment the bundle was started in.
        Returns:

      • activate

        void activate​(org.osgi.service.component.ComponentContext componentContext)
        Sets the ComponentContext of the OSGi environment the bundle was started in.
        Parameters:
        componentContext -

      • getStatus

        String getStatus()
        Returns a status description as String. The returned String contains the number of all available PepperModule objects in a readable format.
        Returns:
        String representation of all PepperModule objects available by this PepperModuleResolver object.

      • addPepperImporterComponentFactory

        void addPepperImporterComponentFactory​(org.osgi.service.component.ComponentFactory pepperImporterComponentFactory)
        This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperImporterComponentFactory to this object. All ComponentFactory objects are stored in an internal object #pepperImporterComponentFactories

      • removePepperImporterComponentFactory

        void removePepperImporterComponentFactory​(org.osgi.service.component.ComponentFactory pepperImporterComponentFactory)
        TODO make docu

      • getPepperImporterComponentFactories

        List<org.osgi.service.component.ComponentFactory> getPepperImporterComponentFactories()
        TODO make docu

      • addPepperManipulatorComponentFactory

        void addPepperManipulatorComponentFactory​(org.osgi.service.component.ComponentFactory pepperManipulatorComponentFactory)
        This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperManipulatorComponentFactory to this object. All ComponentFactory objects are stored in an internal object #pepperManipulatorComponentFactories.

      • removePepperManipulatorComponentFactory

        void removePepperManipulatorComponentFactory​(org.osgi.service.component.ComponentFactory pepperManipulatorComponentFactory)
        TODO make docu

      • getPepperManipulatorComponentFactories

        List<org.osgi.service.component.ComponentFactory> getPepperManipulatorComponentFactories()
        TODO make docu

      • addPepperExporterComponentFactory

        void addPepperExporterComponentFactory​(org.osgi.service.component.ComponentFactory pepperExporterComponentFactory)
        This method is called by OSGi framework and adds all registered ComponentFactory objects having the name PepperExporterComponentFactory to this object. All ComponentFactory objects are stored in the internal object list #pepperExporterComponentFactories.
        Parameters:
        pepperExporterComponentFactory - ComponentFactory object to be stored in internal list

      • removePepperExporterComponentFactory

        void removePepperExporterComponentFactory​(org.osgi.service.component.ComponentFactory pepperExporterComponentFactory)
        TODO make some docu

      • getPepperExporterComponentFactories

        List<org.osgi.service.component.ComponentFactory> getPepperExporterComponentFactories()
        TODO make docu

      • setConfiguration

        void setConfiguration​(PepperConfiguration pepperConfiguration)
        Sets the configuration object for this object.
        Parameters:
        pepperConfiguration -

      • getConfiguration

        PepperConfiguration getConfiguration()
        Returns the configuration object for this converter object. If no PepperConfiguration object was set, an automatic detection of configuration file will be started.
        Returns:
        configuration object

      • getPepperImporters

        List<PepperImporter> getPepperImporters()
        Creates an instance of PepperImporter for each listed ComponentFactory in list #pepperImporterComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.
        Returns:
        a list of PepperImporter objects.

      • getPepperManipulators

        List<PepperManipulator> getPepperManipulators()
        Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.
        Returns:
        a list of PepperManipulator objects.

      • getPepperExporters

        List<PepperExporter> getPepperExporters()
        Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.
        Returns:
        a list of PepperExporter objects.

      • getPepperModule

        PepperModule getPepperModule​(StepDesc stepDesc)
        Returns a PepperModule object matching to the given StepDesc. A new instance of the specific PepperImporter class is created and returned. No references to the returned object will be stored in this PepperModuleResolver object. When calling #getPepperModule(ImporterParams) a new instance of PepperModule is created.
        Parameters:
        pepperImporterParams - specifies the PepperModule object to be found
        Returns:
        a new instance of PepperModule matching the given StepDesc

      • getPepperImporter

        PepperImporter getPepperImporter​(StepDesc stepDesc)
        Returns a PepperImporter object matching to the given ImporterParams. A new instance of the specific PepperImporter class is created and returned. No references to the returned object will be stored in this PepperModuleResolver object. When calling #getPepperImporter(ImporterParams) a new instance of PepperImporter is created.
        Parameters:
        pepperImporterParams - specifies the PepperImporter object to be found
        Returns:
        a new instance of PepperImporter matching the given ImporterParams

      • getPepperManipulator

        PepperManipulator getPepperManipulator​(StepDesc stepDesc)
        Creates an instance of PepperManipulator for each listed ComponentFactory in list #pepperManipulatorComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.
        Returns:
        a list of PepperManipulator objects.

      • getPepperExporter

        PepperExporter getPepperExporter​(StepDesc stepDesc)
        Creates an instance of PepperExporter for each listed ComponentFactory in list #pepperExporterComponentFactories and returns that list. This PepperModuleResolver instance does not store any link to the created object, so it can be used and removed as the caller like. Thus each call creates a new list containing new objects.
        Returns:
        a list of PepperExporter objects.