com.yahoo.search.predicate

Class PredicateIndex

java.lang.Object

com.yahoo.search.predicate.PredicateIndex

@Beta
public class PredicateIndex
extends Object

An index of Predicate objects.

Use a PredicateQuery to find the ids of documents that have matching Predicates. Create an instance of PredicateIndex using the PredicateIndexBuilder.

To build a PredicateQuery you add features and rangeFeatures with a 64-bit bitmap specifying which subqueries they appear in.

To perform a search, create a PredicateIndex.Searcher and call its PredicateIndex.Searcher.search(PredicateQuery) method, which returns a stream of Hit objects, each of which contains a document id and a 64-bit bitmap specifying which subqueries the hit is for.

Note that the PredicateIndex is thread-safe, but a PredicateIndex.Searcher is not. Each thread must use its own searcher.

Author:

Magnar Nedland, bjorncs

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
class	PredicateIndex.Searcher

Field Summary

Fields

Modifier and Type	Field and Description
private com.yahoo.search.predicate.index.SimpleIndex	boundsIndex
private Config	config
private com.yahoo.search.predicate.index.conjunction.ConjunctionIndex	conjunctionIndex
private com.yahoo.search.predicate.index.SimpleIndex	conjunctionIntervalIndex
private com.yahoo.search.predicate.index.PredicateRangeTermExpander	expander
private int	highestIntervalEnd
private int[]	internalToExternalIdMapping
private short[]	intervalEnds
private com.yahoo.search.predicate.index.SimpleIndex	intervalIndex
private com.yahoo.search.predicate.index.PredicateIntervalStore	intervalStore
private byte[]	minFeatureIndex
private AtomicReference<com.yahoo.search.predicate.index.CachedPostingListCounter>	postingListCounter
private static int	SERIALIZATION_FORMAT_VERSION
private int[]	zeroConstraintDocuments

Constructor Summary

Constructors

Constructor and Description

PredicateIndex(Config config, int[] internalToExternalIdMapping, byte[] minFeatureIndex, short[] intervalEnds, int highestIntervalEnd, com.yahoo.search.predicate.index.SimpleIndex intervalIndex, com.yahoo.search.predicate.index.SimpleIndex boundsIndex, com.yahoo.search.predicate.index.SimpleIndex conjunctionIntervalIndex, com.yahoo.search.predicate.index.PredicateIntervalStore intervalStore, com.yahoo.search.predicate.index.conjunction.ConjunctionIndex conjunctionIndex, int[] zeroConstraintDocuments) Package private as the index should be constructed using PredicateIndexBuilder.

Method Summary

Modifier and Type	Method and Description
static PredicateIndex	fromInputStream(DataInputStream in)
void	rebuildPostingListCache()
PredicateIndex.Searcher	searcher() Create a new searcher.
void	writeToOutputStream(DataOutputStream out)

Methods inherited from class java.lang.Object

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

Field Detail

SERIALIZATION_FORMAT_VERSION

private static final int SERIALIZATION_FORMAT_VERSION

See Also:

Constant Field Values

expander

private final com.yahoo.search.predicate.index.PredicateRangeTermExpander expander

internalToExternalIdMapping

private final int[] internalToExternalIdMapping

minFeatureIndex

private final byte[] minFeatureIndex

intervalEnds

private final short[] intervalEnds

highestIntervalEnd

private final int highestIntervalEnd

intervalIndex

private final com.yahoo.search.predicate.index.SimpleIndex intervalIndex

boundsIndex

private final com.yahoo.search.predicate.index.SimpleIndex boundsIndex

conjunctionIntervalIndex

private final com.yahoo.search.predicate.index.SimpleIndex conjunctionIntervalIndex

intervalStore

private final com.yahoo.search.predicate.index.PredicateIntervalStore intervalStore

conjunctionIndex

private final com.yahoo.search.predicate.index.conjunction.ConjunctionIndex conjunctionIndex

zeroConstraintDocuments

private final int[] zeroConstraintDocuments

config

private final Config config

postingListCounter

private final AtomicReference<com.yahoo.search.predicate.index.CachedPostingListCounter> postingListCounter

Constructor Detail

PredicateIndex

PredicateIndex(Config config,
               int[] internalToExternalIdMapping,
               byte[] minFeatureIndex,
               short[] intervalEnds,
               int highestIntervalEnd,
               com.yahoo.search.predicate.index.SimpleIndex intervalIndex,
               com.yahoo.search.predicate.index.SimpleIndex boundsIndex,
               com.yahoo.search.predicate.index.SimpleIndex conjunctionIntervalIndex,
               com.yahoo.search.predicate.index.PredicateIntervalStore intervalStore,
               com.yahoo.search.predicate.index.conjunction.ConjunctionIndex conjunctionIndex,
               int[] zeroConstraintDocuments)

Package private as the index should be constructed using PredicateIndexBuilder.

Method Detail

rebuildPostingListCache

public void rebuildPostingListCache()

searcher

public PredicateIndex.Searcher searcher()

Create a new searcher.

writeToOutputStream

public void writeToOutputStream(DataOutputStream out)
                         throws IOException

Throws:

IOException

fromInputStream

public static PredicateIndex fromInputStream(DataInputStream in)
                                      throws IOException

Throws:

IOException