Package org.apache.lucene.search.join

Class BlockJoinSelector

java.lang.Object
org.apache.lucene.search.join.BlockJoinSelector
public class BlockJoinSelector extends Object
Select a value from a block of documents.
NOTE: This API is for internal purposes only and might change in incompatible ways in the next release.

  • Nested Class Summary

    Nested Classes
    Modifier and Type
    Class
    Description
    static enum 
    BlockJoinSelector.Type
    Type of selection to perform.

  • Method Summary

    Modifier and Type
    Method
    Description
    protected static org.apache.lucene.util.BitSetIterator
    toIter(org.apache.lucene.util.BitSet children)
    creates an iterator for the given bitset
    static org.apache.lucene.index.NumericDocValues
    wrap(org.apache.lucene.index.NumericDocValues values, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.search.DocIdSetIterator children)
    Wraps the provided NumericDocValues, iterating over only child documents, in order to only select one value per parent among its children using the configured selection type.
    static org.apache.lucene.index.NumericDocValues
    wrap(org.apache.lucene.index.NumericDocValues values, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.util.BitSet children)
    Deprecated.
    static org.apache.lucene.index.SortedDocValues
    wrap(org.apache.lucene.index.SortedDocValues values, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.search.DocIdSetIterator children)
    Wraps the provided SortedDocValues in order to only select one value per parent among its children using the configured selection type.
    static org.apache.lucene.index.SortedDocValues
    wrap(org.apache.lucene.index.SortedDocValues values, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.util.BitSet children)
    Deprecated.
    static org.apache.lucene.index.NumericDocValues
    wrap(org.apache.lucene.index.SortedNumericDocValues sortedNumerics, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.search.DocIdSetIterator children)
    Wraps the provided SortedNumericDocValues in order to only select one value per parent among its children using the configured selection type.
    static org.apache.lucene.index.NumericDocValues
    wrap(org.apache.lucene.index.SortedNumericDocValues sortedNumerics, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.util.BitSet children)
    Deprecated.
    static org.apache.lucene.index.SortedDocValues
    wrap(org.apache.lucene.index.SortedSetDocValues sortedSet, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.search.DocIdSetIterator children)
    Wraps the provided SortedSetDocValues in order to only select one value per parent among its children using the configured selection type.
    static org.apache.lucene.util.Bits
    wrap(org.apache.lucene.util.Bits docsWithValue, org.apache.lucene.util.BitSet parents, org.apache.lucene.util.BitSet children)
    Return a Bits instance that returns true if, and only if, any of the children of the given parent document has a value.

    Methods inherited from class java.lang.Object

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

  • Method Details

    • wrap

      public static org.apache.lucene.util.Bits wrap(org.apache.lucene.util.Bits docsWithValue, org.apache.lucene.util.BitSet parents, org.apache.lucene.util.BitSet children)
      Return a Bits instance that returns true if, and only if, any of the children of the given parent document has a value.

    • wrap

      public static org.apache.lucene.index.SortedDocValues wrap(org.apache.lucene.index.SortedSetDocValues sortedSet, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.search.DocIdSetIterator children)
      Wraps the provided SortedSetDocValues in order to only select one value per parent among its children using the configured selection type.

    • wrap

      @Deprecated public static org.apache.lucene.index.SortedDocValues wrap(org.apache.lucene.index.SortedDocValues values, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.util.BitSet children)
      Deprecated.
      Wraps the provided SortedDocValues in order to only select one value per parent among its children using the configured selection type.

    • wrap

      public static org.apache.lucene.index.SortedDocValues wrap(org.apache.lucene.index.SortedDocValues values, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.search.DocIdSetIterator children)
      Wraps the provided SortedDocValues in order to only select one value per parent among its children using the configured selection type.

    • wrap

      @Deprecated public static org.apache.lucene.index.NumericDocValues wrap(org.apache.lucene.index.SortedNumericDocValues sortedNumerics, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.util.BitSet children)
      Deprecated.
      Wraps the provided SortedNumericDocValues in order to only select one value per parent among its children using the configured selection type.

    • toIter

      protected static org.apache.lucene.util.BitSetIterator toIter(org.apache.lucene.util.BitSet children)
      creates an iterator for the given bitset

    • wrap

      public static org.apache.lucene.index.NumericDocValues wrap(org.apache.lucene.index.SortedNumericDocValues sortedNumerics, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.search.DocIdSetIterator children)
      Wraps the provided SortedNumericDocValues in order to only select one value per parent among its children using the configured selection type.

    • wrap

      @Deprecated public static org.apache.lucene.index.NumericDocValues wrap(org.apache.lucene.index.NumericDocValues values, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.util.BitSet children)
      Deprecated.
      Wraps the provided NumericDocValues, iterating over only child documents, in order to only select one value per parent among its children using the configured selection type.

    • wrap

      public static org.apache.lucene.index.NumericDocValues wrap(org.apache.lucene.index.NumericDocValues values, BlockJoinSelector.Type selection, org.apache.lucene.util.BitSet parents, org.apache.lucene.search.DocIdSetIterator children)
      Wraps the provided NumericDocValues, iterating over only child documents, in order to only select one value per parent among its children using the configured selection type.