Interface IIndexer


  • public interface IIndexer
    The main service providing methods for indexing text content.
    • Method Detail

      • addToIndex

        void addToIndex​(IBmObject bmObject)
                 throws org.eclipse.core.runtime.CoreException
        Adds the given objects' text data to the index.
        Parameters:
        bmObject - the object, cannot be null
        Throws:
        org.eclipse.core.runtime.CoreException - in case there are problems with writing the index.
      • updateInIndex

        void updateInIndex​(IBmObject bmObject)
                    throws org.eclipse.core.runtime.CoreException
        Updates the index in accordance with the object's state.
        Parameters:
        bmObject - the object, cannot be null
        Throws:
        org.eclipse.core.runtime.CoreException - in case there are problems with writing the index.
      • removeFromIndex

        void removeFromIndex​(IBmObject bmObject)
                      throws org.eclipse.core.runtime.CoreException
        Removes the given object's text data from the index.
        Parameters:
        bmObject - the object, cannot be null
        Throws:
        org.eclipse.core.runtime.CoreException - in case there are problems with writing the index.
      • removeFromIndex

        void removeFromIndex​(IBmObject bmObject,
                             org.eclipse.emf.ecore.EStructuralFeature feature)
        Remove the value text data of given object-feature from the index.
        Parameters:
        bmObject - the object, cannot be null
        feature - the feature, cannot be null
      • removeFromIndex

        void removeFromIndex​(String projectName,
                             long bmId,
                             Collection<org.eclipse.emf.ecore.EStructuralFeature> features)
        Remove the value text data of given project, object id-feature from the index.
        Parameters:
        projectName - actual project name for delete object, cannot be null
        bmId - the id object
        features - the indexed features of object, cannot be null
      • removeFromIndex

        void removeFromIndex​(org.eclipse.core.resources.IProject project)
        Removes all indexed date for project
        Parameters:
        project - the project for deleting index, cannot be null
      • waitForIndexCommit

        void waitForIndexCommit()
        Waits while changes in index will be commited
      • indexLocalString

        void indexLocalString​(IBmObject bmObject,
                              org.eclipse.emf.ecore.EStructuralFeature feature,
                              org.eclipse.emf.common.util.EMap<String,​String> values,
                              SearchFor searchFor,
                              SearchIn searchIn,
                              SearchScope searchScope,
                              boolean update)
                       throws IOException
        Index object local strings
        Parameters:
        bmObject - the context object, cannot be null
        feature - the feature of local strings, cannot be null
        values - the local string values, cannot be null
        searchFor - the SearchFor index group identifier, cannot be null
        searchIn - the SearchIn index group identifier, cannot be null
        searchScope - the SearchScope index group identifier, cannot be null
        update - flag of adding or updating index data
        Throws:
        IOException - if there is a low-level IO error
      • indexMultiLineString

        void indexMultiLineString​(IBmObject bmObject,
                                  org.eclipse.emf.ecore.EStructuralFeature feature,
                                  BufferedReader content,
                                  SearchFor searchFor,
                                  SearchIn searchIn,
                                  SearchScope searchScope,
                                  boolean update)
                           throws IOException
        Index object multiline strings
        Parameters:
        bmObject - the context object, cannot be null
        feature - the feature of multiline strings, cannot be null
        content - the multiline string values, cannot be null
        searchFor - the SearchFor index group identifier, cannot be null
        searchIn - the SearchIn index group identifier, cannot be null
        searchScope - the SearchScope index group identifier, cannot be null
        update - flag of adding or updating index data
        Throws:
        IOException - if there is a low-level IO error
      • indexSingleLineString

        void indexSingleLineString​(IBmObject bmObject,
                                   org.eclipse.emf.ecore.EStructuralFeature feature,
                                   String content,
                                   SearchFor searchFor,
                                   SearchIn searchIn,
                                   SearchScope searchScope,
                                   boolean update)
                            throws IOException
        Index object strings
        Parameters:
        bmObject - the context object, cannot be null
        feature - the feature of multiline strings, cannot be null
        content - the multiline string values, cannot be null
        searchFor - the SearchFor index group identifier, cannot be null
        searchIn - the SearchIn index group identifier, cannot be null
        searchScope - the SearchScope index group identifier, cannot be null
        update - flag of adding or updating index data
        Throws:
        IOException - if there is a low-level IO error