org.eclipse.incquery.runtime.api.scope

## Interface IEngineContext

-     public interface IEngineContext

  The context of the engine is instantiated by the scope, and provides information and services regarding the model the towards the engine.
  Author:
    Bergmann Gabor

- - ### Nested Class Summary

    Nested Classes
    Modifier and Type | Interface and Description
    --- | ---
    `static interface` | `IEngineContext.IQueryBackendInitializer`

  - ### Method Summary

    All Methods Instance Methods Abstract Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `dispose()` Disposes this context object.
    `IBaseIndex` | `getBaseIndex()` Returns the base index.
    `void` | `initializeBackends(IEngineContext.IQueryBackendInitializer initializer)` Invokes the given initializer code with a runtime context for pattern matching.

- - ### Method Detail

    - #### getBaseIndex

          IBaseIndex getBaseIndex()
                           throws IncQueryException

      Returns the base index.
      Throws:
        `IncQueryException`

    - #### initializeBackends

          void initializeBackends(IEngineContext.IQueryBackendInitializer initializer)
                           throws IncQueryException

      Invokes the given initializer code with a runtime context for pattern matching. If the base index has not yet been initialized, it will be only loaded with content after the callback.
      Throws:
        `IncQueryException`

    - #### dispose

          void dispose()

      Disposes this context object. Resources in the index may now be freed up. No more methods should be called after this one.
      Throws:
        `java.lang.IllegalStateException` - if there are any active listeners to the underlying index