com.bigdata.btree.proc

Class BatchContains

java.lang.Object

com.bigdata.btree.proc.AbstractIndexProcedure<T>

com.bigdata.btree.proc.AbstractKeyArrayIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBitBuffer>

com.bigdata.btree.proc.BatchContains

All Implemented Interfaces:

IIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBitBuffer>, IKeyArrayIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBitBuffer>, IParallelizableIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBitBuffer>, IReadOnly, Externalizable, Serializable

public class BatchContains
extends AbstractKeyArrayIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBitBuffer>
implements IParallelizableIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBitBuffer>

Batch existence test operation. Existence tests SHOULD be used in place of lookup tests to determine key existence if null values are allowed in an index (lookup will return a null for both a null value and the absence of a key in the index).

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchContains.BatchContainsConstructor Factory for BatchContains procedures.

Nested classes/interfaces inherited from class com.bigdata.btree.proc.AbstractKeyArrayIndexProcedure

AbstractKeyArrayIndexProcedure.ResultBitBuffer, AbstractKeyArrayIndexProcedure.ResultBitBufferCounter, AbstractKeyArrayIndexProcedure.ResultBitBufferHandler, AbstractKeyArrayIndexProcedure.ResultBuffer, AbstractKeyArrayIndexProcedure.ResultBufferHandler

Constructor Summary

Constructors

Modifier	Constructor and Description
	BatchContains() De-serialization ctor.
protected	BatchContains(IRabaCoder keysCoder, int fromIndex, int toIndex, byte[][] keys) Create a batch existence test operation.

Method Summary

Methods

Modifier and Type	Method and Description
AbstractKeyArrayIndexProcedure.ResultBitBuffer	applyOnce(IIndex ndx, IRaba keys, IRaba vals) Applies the operation using ISimpleBTree.contains(byte[]).
boolean	isReadOnly() Return true iff the procedure asserts that it will not write on the index.
protected IResultHandler<AbstractKeyArrayIndexProcedure.ResultBitBuffer,AbstractKeyArrayIndexProcedure.ResultBitBuffer>	newAggregator() Return an IResultHandler that will be used to combine the results if the index procedure is parallelized against a local index (including a scale-out shard).

Methods inherited from class com.bigdata.btree.proc.AbstractKeyArrayIndexProcedure

apply, getKeys, getKeysCoder, getValues, getValuesCoder, readExternal, readMetadata, writeExternal, writeMetadata

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.bigdata.btree.proc.IIndexProcedure

apply

Constructor Detail

BatchContains

public BatchContains()

De-serialization ctor.

BatchContains

protected BatchContains(IRabaCoder keysCoder,
             int fromIndex,
             int toIndex,
             byte[][] keys)

Create a batch existence test operation.

Parameters:

keys - A series of keys. Each key is an variable length unsigned byte[]. The keys MUST be presented in sorted order.

See Also:

BatchContains.BatchContainsConstructor

Method Detail

isReadOnly

public final boolean isReadOnly()

Description copied from interface: IReadOnly

Return true iff the procedure asserts that it will not write on the index. When true, the procedure may be run against a view of the index that is read-only or which allows concurrent processes to read on the same index object. When false the procedure will be run against a mutable view of the index (assuming that the procedure is executed in a context that has access to a mutable index view).

Specified by:

isReadOnly in interface IReadOnly

applyOnce

public AbstractKeyArrayIndexProcedure.ResultBitBuffer applyOnce(IIndex ndx,
                                                       IRaba keys,
                                                       IRaba vals)

Applies the operation using ISimpleBTree.contains(byte[]).

Specified by:

applyOnce in class AbstractKeyArrayIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBitBuffer>

Parameters:

ndx -

Returns:

A AbstractKeyArrayIndexProcedure.ResultBitBuffer.

newAggregator

protected IResultHandler<AbstractKeyArrayIndexProcedure.ResultBitBuffer,AbstractKeyArrayIndexProcedure.ResultBitBuffer> newAggregator()

Description copied from class: AbstractKeyArrayIndexProcedure

Return an IResultHandler that will be used to combine the results if the index procedure is parallelized against a local index (including a scale-out shard). If a null is returned, then the index procedure WILL NOT be parallelized against the local index. To parallelize index procedures that do not return anything against a local index, just use NopAggregator. A non-null value will permit both index local parallelization of the index procedure and (in scale-out) parallelization of the index procedure across the shards as well. In order to be parallelized, the index procedure must also be marked as IParallelizableIndexProcedure.

Specified by:

newAggregator in class AbstractKeyArrayIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBitBuffer>

Returns:

The IResultHandler -or- null

See Also:

NopAggregator, IParallelizableIndexProcedure, (Schedule more IOs when loading data)