com.bigdata.rdf.spo

Class SPOIndexWriteProc

java.lang.Object

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

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

com.bigdata.rdf.spo.SPOIndexWriteProc

All Implemented Interfaces:

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

public class SPOIndexWriteProc
extends AbstractKeyArrayIndexProcedure<Object>
implements IParallelizableIndexProcedure<Object>, IMutableRelationIndexWriteProcedure<Object>

Procedure for batch insert on a single statement index (or index partition).

The key for each statement encodes the {s:p:o} of the statement in the order that is appropriate for the index (SPO, POS, OSP, etc). The key is written unchanged on the index.

The value for each statement is a byte that encodes the StatementEnum and also encodes whether or not the "override" flag is set using - see StatementEnum.MASK_OVERRIDE - followed by 8 bytes representing the statement identifier IFF statement identifiers are enabled AND the StatementEnum is StatementEnum.Explicit. The value requires interpretation to determine the byte[] that will be written as the value on the index - see the code for more details.

Note: This needs to be a custom batch operation using a conditional insert so that we do not write on the index when the data would not be changed and to handle the overflow flag and the optional statement identifier correctly.

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	SPOIndexWriteProc.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
	SPOIndexWriteProc() De-serialization constructor.
protected	SPOIndexWriteProc(IRabaCoder keySer, IRabaCoder valSer, int fromIndex, int toIndex, byte[][] keys, byte[][] vals, boolean reportMutation)

Method Summary

Methods

Modifier and Type	Method and Description
Object	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<Object,Object>	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

SPOIndexWriteProc

public SPOIndexWriteProc()

De-serialization constructor.

SPOIndexWriteProc

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

Parameters:

fromIndex -

toIndex -

keys -

vals -

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

Parameters:

ndx - The index.

Returns:

The #of statements actually written on the index as an Long -or- a ResultBitBuffer IFF reportMutations := true.

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

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

newAggregator

protected IResultHandler<Object,Object> 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<Object>

Returns:

The IResultHandler -or- null

See Also:

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