com.bigdata.btree.proc

Class BatchPutIfAbsent

java.lang.Object

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

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

com.bigdata.btree.proc.BatchPutIfAbsent

All Implemented Interfaces:

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

public class BatchPutIfAbsent
extends AbstractKeyArrayIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBuffer>
implements IParallelizableIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBuffer>

Batch conditional insert operation (putIfAbsent).

Author:

Bryan Thompson

See Also:

(putIfAbsent), Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchPutIfAbsent.BatchPutIfAbsentConstructor Factory for BatchPutIfAbsent 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
	BatchPutIfAbsent() De-serialization ctor.
protected	BatchPutIfAbsent(IRabaCoder keysCoder, IRabaCoder valsCoder, int fromIndex, int toIndex, byte[][] keys, byte[][] vals, boolean returnOldValues) Create a batch insert operation.

Method Summary

Methods

Modifier and Type	Method and Description
AbstractKeyArrayIndexProcedure.ResultBuffer	applyOnce(IIndex ndx, IRaba keys, IRaba vals) Applies the operator using ISimpleBTree.putIfAbsent(byte[], byte[])
boolean	getReturnOldValues() True iff the old values stored under the keys will be returned by AbstractKeyArrayIndexProcedure.apply(IIndex).
boolean	isReadOnly() Return true iff the procedure asserts that it will not write on the index.
protected IResultHandler<AbstractKeyArrayIndexProcedure.ResultBuffer,AbstractKeyArrayIndexProcedure.ResultBuffer>	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).
protected void	readMetadata(ObjectInput in) Reads metadata written by AbstractKeyArrayIndexProcedure.writeMetadata(ObjectOutput).
protected void	writeMetadata(ObjectOutput out) Writes metadata (not the keys or values, but just other metadata used by the procedure).

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

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

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

BatchPutIfAbsent

public BatchPutIfAbsent()

De-serialization ctor.

BatchPutIfAbsent

protected BatchPutIfAbsent(IRabaCoder keysCoder,
                IRabaCoder valsCoder,
                int fromIndex,
                int toIndex,
                byte[][] keys,
                byte[][] vals,
                boolean returnOldValues)

Create a batch insert operation.

Batch insert operation of N tuples presented in sorted order. This operation can be very efficient if the tuples are presented sorted by key order.

Parameters:

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

vals - An array of values corresponding to those keys. Null elements are allowed.

returnOldValues - When true the old values for those keys will be returned by AbstractKeyArrayIndexProcedure.apply(IIndex).

See Also:

BatchInsert.BatchInsertConstructor

Method Detail

getReturnOldValues

public boolean getReturnOldValues()

True iff the old values stored under the keys will be returned by AbstractKeyArrayIndexProcedure.apply(IIndex).

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.ResultBuffer applyOnce(IIndex ndx,
                                                    IRaba keys,
                                                    IRaba vals)

Applies the operator using ISimpleBTree.putIfAbsent(byte[], byte[])

Specified by:

applyOnce in class AbstractKeyArrayIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBuffer>

Parameters:

ndx -

Returns:

Either null if the old values were not requested or a AbstractKeyArrayIndexProcedure.ResultBuffer containing the old values.

readMetadata

protected void readMetadata(ObjectInput in)
                     throws IOException,
                            ClassNotFoundException

Description copied from class: AbstractKeyArrayIndexProcedure

Reads metadata written by AbstractKeyArrayIndexProcedure.writeMetadata(ObjectOutput).

Overrides:

readMetadata in class AbstractKeyArrayIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBuffer>

Throws:

IOException

ClassNotFoundException

writeMetadata

protected void writeMetadata(ObjectOutput out)
                      throws IOException

Description copied from class: AbstractKeyArrayIndexProcedure

Writes metadata (not the keys or values, but just other metadata used by the procedure).

The default implementation writes out the AbstractKeyArrayIndexProcedure.getKeysCoder() and the AbstractKeyArrayIndexProcedure.getValuesCoder().

Overrides:

writeMetadata in class AbstractKeyArrayIndexProcedure<AbstractKeyArrayIndexProcedure.ResultBuffer>

Throws:

IOException

newAggregator

protected IResultHandler<AbstractKeyArrayIndexProcedure.ResultBuffer,AbstractKeyArrayIndexProcedure.ResultBuffer> 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.ResultBuffer>

Returns:

The IResultHandler -or- null

See Also:

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