com.bigdata.search

Class TextIndexWriteProc

java.lang.Object

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

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

com.bigdata.search.TextIndexWriteProc

All Implemented Interfaces:

IIndexProcedure<Long>, IKeyArrayIndexProcedure<Long>, IParallelizableIndexProcedure<Long>, IReadOnly, IMutableRelationIndexWriteProcedure<Long>, Externalizable, Serializable

public class TextIndexWriteProc
extends AbstractKeyArrayIndexProcedure<Long>
implements IParallelizableIndexProcedure<Long>, IMutableRelationIndexWriteProcedure<Long>

Writes on the text index.

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TextIndexWriteProc.IndexWriteProcConstructor

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
	TextIndexWriteProc() De-serialization constructor.
protected	TextIndexWriteProc(IRabaCoder keySer, IRabaCoder valSer, int fromIndex, int toIndex, byte[][] keys, byte[][] vals, boolean overwrite)

Method Summary

Methods

Modifier and Type	Method and Description
Long	applyOnce(IIndex ndx, IRaba keys, IRaba vals) Apply the procedure to the specified key range of the index.
boolean	isReadOnly() Return true iff the procedure asserts that it will not write on the index.
protected IResultHandler<Long,Long>	newAggregator() Uses LongAggregator to combine the mutation counts.
protected void	readMetadata(ObjectInput in) Reads metadata written by AbstractKeyArrayIndexProcedure.writeMetadata(ObjectOutput).
protected void	writeMetadata(ObjectOutput out) Extended to write the overwrite flag.

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

TextIndexWriteProc

public TextIndexWriteProc()

De-serialization constructor.

TextIndexWriteProc

protected TextIndexWriteProc(IRabaCoder keySer,
                  IRabaCoder valSer,
                  int fromIndex,
                  int toIndex,
                  byte[][] keys,
                  byte[][] vals,
                  boolean overwrite)

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

Description copied from class: AbstractKeyArrayIndexProcedure

Apply the procedure to the specified key range of the index.

Specified by:

applyOnce in class AbstractKeyArrayIndexProcedure<Long>

Parameters:

ndx - The index.

Returns:

The #of pre-existing tuples that were updated as an Integer.

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

Throws:

IOException

ClassNotFoundException

writeMetadata

protected void writeMetadata(ObjectOutput out)
                      throws IOException

Extended to write the overwrite flag.

Overrides:

writeMetadata in class AbstractKeyArrayIndexProcedure<Long>

Throws:

IOException

newAggregator

protected IResultHandler<Long,Long> newAggregator()

Uses LongAggregator to combine the mutation counts.

Specified by:

newAggregator in class AbstractKeyArrayIndexProcedure<Long>

Returns:

The IResultHandler -or- null

See Also:

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