Interface IBmEmfIndexManager


  • public interface IBmEmfIndexManager
    Unified EMF index manager for all active projects in the workspace.
    • Method Detail

      • addEmfIndexProvider

        IBmEmfIndexProvider addEmfIndexProvider​(IBmModel model,
                                                org.eclipse.core.resources.IProject project)
        Add a new index provider for the given BM model and project.
        Parameters:
        model - The model to add provider to. May not be null
        project - The project to associate provider with. May not be null
        Returns:
        The newly created provider instance. May not be null
      • addEmfIndexProvider

        IBmEmfIndexProvider addEmfIndexProvider​(IBmModel model)
        Add a new index provider for the given BM model. After registration the EMF index is available only for non-IProject referencing subsystems
        Parameters:
        model - The model to add provider to. May not be null
        Returns:
        The newly created provider instance. May not be null
      • addOverlayEmfIndexProvider

        IBmEmfIndexProvider addOverlayEmfIndexProvider​(IBmModel model,
                                                       IBmModel masterModel,
                                                       org.eclipse.core.resources.IProject masterProject,
                                                       String overlayId)
        Add a new overlay index provider for the given BM model.
        Parameters:
        model - The model to add provider to. May not be null
        masterModel - The master model the overlay is created for. May not be null
        masterProject - The master project the overlay is created for. May not be null
        overlayId - The unique identifier of the overlay. May not be null
        Returns:
        The newly created provider instance. May not be null
      • getEmfIndexProvider

        IBmEmfIndexProvider getEmfIndexProvider​(org.eclipse.core.resources.IProject project)
        Gets a specific EMF index provider bound to the provided project.
        Parameters:
        project - The project to get provider for.
        Returns:
        The BM Emf Index provider.
      • getEmfIndexProvider

        IBmEmfIndexProvider getEmfIndexProvider​(IBmModel model)
        Gets a specific EMF index provider bound to the provided BM model.
        Parameters:
        project - The model to get provider for.
        Returns:
        The BM Emf Index provider.
      • getRegisteredProviders

        List<IBmEmfIndexProvider> getRegisteredProviders()
        Gets the list of all registered EMF index providers.
        Returns:
        The list of EMF index providers being registered at the moment.
      • removeEmfIndexProvider

        void removeEmfIndexProvider​(org.eclipse.core.resources.IProject project)
        Removes an existing provider from the manager control.
        Parameters:
        project - The project to remove provider for.
      • removeOverlayEmfIndexProvider

        void removeOverlayEmfIndexProvider​(org.eclipse.core.resources.IProject masterProject,
                                           String overlayId)
        Removes EMF index provider
        Parameters:
        masterProject - The master project the overlay is created for. May not be null
        overlayId - The unique identifier of the overlay. May not be null
      • getStateChangeEventBroker

        org.eclipse.xtext.ui.notification.IStateChangeEventBroker getStateChangeEventBroker()
        Gets actual IStateChangeEventBroker
        Returns:
        actual IStateChangeEventBroker, or null if IStateChangeEventBroker wasn't initialized