org.apache.lucene.search.join

## Class BitDocIdSetCachingWrapperFilter

- java.lang.Object
- - org.apache.lucene.search.Query
  - - org.apache.lucene.search.Filter
    - - org.apache.lucene.search.join.BitDocIdSetFilter
      - - org.apache.lucene.search.join.BitDocIdSetCachingWrapperFilter

- All Implemented Interfaces:
    Cloneable, BitSetProducer

  Deprecated.
  Use `QueryBitSetProducer` instead

      @Deprecated
      public class BitDocIdSetCachingWrapperFilter
      extends BitDocIdSetFilter

  `Filter` wrapper that implements `BitDocIdSetFilter`.

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `BitDocIdSetCachingWrapperFilter(Filter filter)` Deprecated. Wraps another filter's result and caches it into bitsets.

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `boolean` | `equals(Object o)` Deprecated.
    `BitDocIdSet` | `getDocIdSet(LeafReaderContext context)` Deprecated. Same as `BitDocIdSetFilter.getDocIdSet(LeafReaderContext, Bits)` but does not take acceptDocs into account and guarantees to return a `BitDocIdSet`.
    `Filter` | `getFilter()` Deprecated. Gets the contained filter.
    `int` | `hashCode()` Deprecated.
    `String` | `toString(String field)` Deprecated.

    - ### Methods inherited from class org.apache.lucene.search.join.BitDocIdSetFilter

      `getBitSet, getDocIdSet`

    - ### Methods inherited from class org.apache.lucene.search.Filter

      `rewrite`

    - ### Methods inherited from class org.apache.lucene.search.Query

      `clone, createWeight, getBoost, setBoost, toString`

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

      `finalize, getClass, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### BitDocIdSetCachingWrapperFilter

          public BitDocIdSetCachingWrapperFilter(Filter filter)

      Deprecated.
      Wraps another filter's result and caches it into bitsets.
      Parameters:
        `filter` - Filter to cache results of

  - ### Method Detail

    - #### getFilter

          public Filter getFilter()

      Deprecated.
      Gets the contained filter.
      Returns:
        the contained filter.

    - #### getDocIdSet

          public BitDocIdSet getDocIdSet(LeafReaderContext context)
                                  throws IOException

      Deprecated.
      Description copied from class: `BitDocIdSetFilter`
      Same as `BitDocIdSetFilter.getDocIdSet(LeafReaderContext, Bits)` but does not take acceptDocs into account and guarantees to return a `BitDocIdSet`.
      Specified by:
        `getDocIdSet` in class `BitDocIdSetFilter`
      Throws:
        `IOException`

    - #### toString

          public String toString(String field)

      Deprecated.
      Specified by:
        `toString` in class `Query`

    - #### equals

          public boolean equals(Object o)

      Deprecated.
      Overrides:
        `equals` in class `Query`

    - #### hashCode

          public int hashCode()

      Deprecated.
      Overrides:
        `hashCode` in class `Query`

Copyright © 2000-2017 Apache Software Foundation. All Rights Reserved.