org.eclipse.viatra.query.runtime.localsearch.matcher.integration

## Class LocalSearchHints

- java.lang.Object
- - org.eclipse.viatra.query.runtime.localsearch.matcher.integration.LocalSearchHints

- All Implemented Interfaces:
    IMatcherCapability

      public final class LocalSearchHints
      extends java.lang.Object
      implements IMatcherCapability

  Type safe builder and extractor for Local search specific hints
  Since:
    1.4

- - ### Method Summary

    All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
    Modifier and Type | Method and Description
    --- | ---
    `QueryEvaluationHint` | `build()`
    `boolean` | `canBeSubstitute(IMatcherCapability capability)` Returns true if matchers of this capability can be used as a substitute for a matcher implementing the given capability
    `static LocalSearchHints` | `customizeAdornmentProvider(IAdornmentProvider adornmentProvider)`
    `static LocalSearchHints` | `customizeAllowInverse(boolean allowInverse)`
    `static LocalSearchHints` | `customizeCostFunction(ICostFunction costFunction)`
    `static LocalSearchHints` | `customizeFlattenCallPredicate(IFlattenCallPredicate predicate)`
    `static LocalSearchHints` | `customizeRowCount(int rowCount)`
    `static LocalSearchHints` | `customizeTraceCollector(IRewriterTraceCollector traceCollector)`
    `static LocalSearchHints` | `customizeUseBase(boolean useBase)`
    `IAdornmentProvider` | `getAdornmentProvider()`
    `ICostFunction` | `getCostFunction()`
    `static LocalSearchHints` | `getDefault()` Default settings which are considered the most safe, providing a reasonable performance for most of the cases.
    `static LocalSearchHints` | `getDefaultFlatten()` With this setting, the patterns are flattened before planning.
    `static LocalSearchHints` | `getDefaultNoBase()` Settings to be used when the base index is not available.
    `static LocalSearchHints` | `getDefaultOverriddenBy(QueryEvaluationHint overridingHint)` Return the default settings overridden by the given hints
    `IFlattenCallPredicate` | `getFlattenCallPredicate()`
    `java.lang.Integer` | `getRowCount()`
    `IRewriterTraceCollector` | `getTraceCollector()`
    `java.lang.Boolean` | `isAllowInverse()` Deprecated. allow inverse was deprecated in 1.4; its uses are ignored
    `boolean` | `isUseBase()`
    `static LocalSearchHints` | `parse(QueryEvaluationHint hint)`
    `LocalSearchHints` | `setAdornmentProvider(IAdornmentProvider adornmentProvider)`
    `LocalSearchHints` | `setAllowInverse(boolean allowInverse)` Deprecated. allow inverse was deprecated in 1.4; its uses are ignored
    `LocalSearchHints` | `setCostFunction(ICostFunction costFunction)`
    `LocalSearchHints` | `setFlattenCallPredicate(IFlattenCallPredicate flattenCallPredicate)`
    `LocalSearchHints` | `setRowCount(int rowCount)`
    `LocalSearchHints` | `setTraceCollector(IRewriterTraceCollector traceCollector)`
    `LocalSearchHints` | `setUseBase(boolean useBase)`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

- - ### Method Detail

    - #### getDefaultOverriddenBy

          public static LocalSearchHints getDefaultOverriddenBy(QueryEvaluationHint overridingHint)

      Return the default settings overridden by the given hints

    - #### getDefault

          public static LocalSearchHints getDefault()

      Default settings which are considered the most safe, providing a reasonable performance for most of the cases. Assumes the availability of the base indexer.

    - #### getDefaultFlatten

          public static LocalSearchHints getDefaultFlatten()

      With this setting, the patterns are flattened before planning. This may cause performance gain in most of the cases compared to the `getDefault()` settings, However this should be used with care for patterns containing calls with several bodies.

    - #### getDefaultNoBase

          public static LocalSearchHints getDefaultNoBase()

      Settings to be used when the base index is not available.

    - #### parse

          public static LocalSearchHints parse(QueryEvaluationHint hint)

    - #### build

          public QueryEvaluationHint build()

    - #### isUseBase

          public boolean isUseBase()

    - #### isAllowInverse

          @Deprecated
          public java.lang.Boolean isAllowInverse()

      Deprecated. allow inverse was deprecated in 1.4; its uses are ignored

    - #### getCostFunction

          public ICostFunction getCostFunction()

    - #### getFlattenCallPredicate

          public IFlattenCallPredicate getFlattenCallPredicate()

    - #### getRowCount

          public java.lang.Integer getRowCount()

    - #### getAdornmentProvider

          public IAdornmentProvider getAdornmentProvider()

      Since:
        1.5

    - #### getTraceCollector

          public IRewriterTraceCollector getTraceCollector()

      Since:
        1.6

    - #### setAllowInverse

          @Deprecated
          public LocalSearchHints setAllowInverse(boolean allowInverse)

      Deprecated. allow inverse was deprecated in 1.4; its uses are ignored

    - #### setUseBase

          public LocalSearchHints setUseBase(boolean useBase)

    - #### setRowCount

          public LocalSearchHints setRowCount(int rowCount)

    - #### setCostFunction

          public LocalSearchHints setCostFunction(ICostFunction costFunction)

    - #### setFlattenCallPredicate

          public LocalSearchHints setFlattenCallPredicate(IFlattenCallPredicate flattenCallPredicate)

    - #### setTraceCollector

          public LocalSearchHints setTraceCollector(IRewriterTraceCollector traceCollector)

      Since:
        1.6

    - #### setAdornmentProvider

          public LocalSearchHints setAdornmentProvider(IAdornmentProvider adornmentProvider)

      Since:
        1.5

    - #### customizeUseBase

          public static LocalSearchHints customizeUseBase(boolean useBase)

    - #### customizeAllowInverse

          public static LocalSearchHints customizeAllowInverse(boolean allowInverse)

    - #### customizeRowCount

          public static LocalSearchHints customizeRowCount(int rowCount)

    - #### customizeCostFunction

          public static LocalSearchHints customizeCostFunction(ICostFunction costFunction)

    - #### customizeFlattenCallPredicate

          public static LocalSearchHints customizeFlattenCallPredicate(IFlattenCallPredicate predicate)

    - #### customizeAdornmentProvider

          public static LocalSearchHints customizeAdornmentProvider(IAdornmentProvider adornmentProvider)

      Since:
        1.5

    - #### customizeTraceCollector

          public static LocalSearchHints customizeTraceCollector(IRewriterTraceCollector traceCollector)

      Since:
        1.6

    - #### canBeSubstitute

          public boolean canBeSubstitute(IMatcherCapability capability)

      Description copied from interface: `IMatcherCapability`
      Returns true if matchers of this capability can be used as a substitute for a matcher implementing the given capability
      Specified by:
        `canBeSubstitute` in interface `IMatcherCapability`