Class LocalSearchBackend

  • All Implemented Interfaces:
    IQueryBackend

    public abstract class LocalSearchBackend
    extends java.lang.Object
    implements IQueryBackend
    No Extend:
    This class is not intended to be subclassed by clients.
    • Constructor Detail

    • Method Detail

      • flushUpdates

        public void flushUpdates()
        Description copied from interface: IQueryBackend
        Propagates all pending updates in this query backend. The implementation of this method is optional, and it can be ignored entirely if the backend does not delay updates.
        Specified by:
        flushUpdates in interface IQueryBackend
      • getResultProviderRequestor

        public ResultProviderRequestor getResultProviderRequestor​(PQuery query,
                                                                  QueryEvaluationHint userHints)
        Returns a requestor that this backend uses while processing pattern calls from this query.
        Since:
        2.1
        No Reference:
        This method is not intended to be referenced by clients.
      • isCaching

        public boolean isCaching()
        Specified by:
        isCaching in interface IQueryBackend
        Returns:
        true iff this backend is incremental, i.e. it caches the results of queries for quick retrieval, and can provide update notifications on result set changes.
      • getQueryAnalyzer

        public QueryAnalyzer getQueryAnalyzer()
        Since:
        1.5
      • getAdapters

        public java.util.List<ILocalSearchAdapter> getAdapters()
        Return a copy of the current adapters
        Since:
        1.7
      • getCache

        public ICache getCache()
        Returns the internal cache of the backend
        Since:
        1.7
        No Reference:
        This method is not intended to be referenced by clients.
      • recomputePlans

        public void recomputePlans​(PQuery... queries)
        Updates the previously stored search plans for one or more given queries, computing a new set of plans if necessary. The new plans created are the same that would be created by executing prepare on the given query definitions.
        Since:
        2.0
      • recomputePlans

        public void recomputePlans​(java.util.Collection<PQuery> queries)
        Updates the previously stored search plans for one or more given queries, computing a new set of plans if necessary The new plans created are the same that would be created by executing prepare on the given query definitions.
        Since:
        2.0
      • recomputePlans

        public void recomputePlans()
        Updates the previously stored search plans for one or more given queries, computing a new set of plans if necessary The new plans created are the same that would be created by executing prepare on the given query definitions.
        Since:
        2.0
      • getSearchPlan

        public IPlanDescriptor getSearchPlan​(PQuery query,
                                             java.util.Set<PParameter> adornment)
        Returns a search plan for a given query and adornment if such plan is already calculated.
        Returns:
        a previously calculated search plan for the given query and adornment, or null if no such plan exists
        Since:
        2.0