com.bigdata.btree.proc

Class BatchRemove

java.lang.Object

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

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

com.bigdata.btree.proc.BatchRemove

All Implemented Interfaces:

IIndexProcedure<Object>, IKeyArrayIndexProcedure<Object>, IParallelizableIndexProcedure<Object>, IReadOnly, Externalizable, Serializable

public class BatchRemove
extends AbstractKeyArrayIndexProcedure<Object>
implements IParallelizableIndexProcedure<Object>

Batch removal of one or more tuples, optionally returning their existing values, the #of tuples that were deleted, or a mask indicating which tuples were deleted (polymorphic return type).

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	BatchRemove.BatchRemoveConstructor Factory for BatchRemove 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
	BatchRemove() De-serialization ctor.
protected	BatchRemove(IRabaCoder keySer, IRabaCoder valSer, int fromIndex, int toIndex, byte[][] keys, boolean assertFound, com.bigdata.btree.proc.BatchRemove.ReturnWhatEnum returnWhat) Batch remove operation.

Method Summary

Methods

Modifier and Type	Method and Description
Object	applyOnce(IIndex ndx, IRaba keys, IRaba vals) Applies the operation.
boolean	getAssertFound() True iff the procedure will verify that each supplied key was in fact found in the index.
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<Object,Object>	newAggregator() Returns an appropriate aggregator depending on returnWhat.
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

BatchRemove

public BatchRemove()

De-serialization ctor.

BatchRemove

protected BatchRemove(IRabaCoder keySer,
           IRabaCoder valSer,
           int fromIndex,
           int toIndex,
           byte[][] keys,
           boolean assertFound,
           com.bigdata.btree.proc.BatchRemove.ReturnWhatEnum returnWhat)

Batch remove operation.

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.

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

See Also:

BatchRemove.BatchRemoveConstructor

Method Detail

getAssertFound

public boolean getAssertFound()

True iff the procedure will verify that each supplied key was in fact found in the index.

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

Applies the operation.

Specified by:

applyOnce in class AbstractKeyArrayIndexProcedure<Object>

Parameters:

ndx -

Returns:

The old values as a ResultBuffer iff they were requested.

Throws:

AssertionError - if getAssertFound() is true and a given key was not found in the index.

newAggregator

protected IResultHandler<Object,Object> newAggregator()

Returns an appropriate aggregator depending on returnWhat.

Specified by:

newAggregator in class AbstractKeyArrayIndexProcedure<Object>

Returns:

The IResultHandler -or- null

See Also:

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

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<Object>

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<Object>

Throws:

IOException