com.bigdata.btree.proc

Class AbstractKeyRangeIndexProcedure<T>

java.lang.Object

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

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

All Implemented Interfaces:

IIndexProcedure<T>, IKeyRangeIndexProcedure<T>, IReadOnly, Externalizable, Serializable

Direct Known Subclasses:

RangeCountProcedure

public abstract class AbstractKeyRangeIndexProcedure<T>
extends AbstractIndexProcedure<T>
implements IKeyRangeIndexProcedure<T>, Externalizable

Author:

Bryan Thompson

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected byte[]	fromKey
protected byte[]	toKey

Constructor Summary

Constructors

Constructor and Description
AbstractKeyRangeIndexProcedure() De-serialization ctor.
AbstractKeyRangeIndexProcedure(byte[] fromKey, byte[] toKey)

Method Summary

Methods

Modifier and Type	Method and Description
static byte[]	constrainFromKey(byte[] fromKey, ISeparatorKeys pmd) Constrain the fromKey to lie within the index partition.
static byte[]	constrainToKey(byte[] toKey, ISeparatorKeys pmd) Constrain the toKey to lie within the index partition.
byte[]	getFromKey() Return the lowest key that will be visited (inclusive).
byte[]	getToKey() Return the first key that will not be visited (exclusive).
void	readExternal(ObjectInput in)
protected void	readKeys(ObjectInput in)
void	writeExternal(ObjectOutput out)
protected void	writeKeys(ObjectOutput out)

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

Methods inherited from interface com.bigdata.journal.IReadOnly

isReadOnly

Field Detail

fromKey

protected byte[] fromKey

toKey

protected byte[] toKey

Constructor Detail

AbstractKeyRangeIndexProcedure

public AbstractKeyRangeIndexProcedure()

De-serialization ctor.

AbstractKeyRangeIndexProcedure

public AbstractKeyRangeIndexProcedure(byte[] fromKey,
                              byte[] toKey)

Method Detail

getFromKey

public byte[] getFromKey()

Description copied from interface: IKeyRangeIndexProcedure

Return the lowest key that will be visited (inclusive). When null there is no lower bound.

Specified by:

getFromKey in interface IKeyRangeIndexProcedure<T>

getToKey

public byte[] getToKey()

Description copied from interface: IKeyRangeIndexProcedure

Return the first key that will not be visited (exclusive). When null there is no upper bound.

Specified by:

getToKey in interface IKeyRangeIndexProcedure<T>

readExternal

public void readExternal(ObjectInput in)
                  throws IOException,
                         ClassNotFoundException

Specified by:

readExternal in interface Externalizable

Throws:

IOException

ClassNotFoundException

writeExternal

public void writeExternal(ObjectOutput out)
                   throws IOException

Specified by:

writeExternal in interface Externalizable

Throws:

IOException

readKeys

protected void readKeys(ObjectInput in)
                 throws IOException,
                        ClassNotFoundException

Throws:

IOException

ClassNotFoundException

writeKeys

protected void writeKeys(ObjectOutput out)
                  throws IOException

Throws:

IOException

constrainFromKey

public static byte[] constrainFromKey(byte[] fromKey,
                      ISeparatorKeys pmd)

Constrain the fromKey to lie within the index partition.

Parameters:

fromKey - The fromKey.

pmd - The index partition metadata (MAY be null).

Returns:

The fromKey -or- the leftSeparator key of the index partition IFF pmd is non-null AND the fromKey is LT the leftSeparator key.

constrainToKey

public static byte[] constrainToKey(byte[] toKey,
                    ISeparatorKeys pmd)

Constrain the toKey to lie within the index partition.

Parameters:

toKey - The toKey.

pmd - The index partition metadata (MAY be null).

Returns:

The toKey -or- the rightSeparator key of the index partition IFF pmd is non-null AND the toKey is GT the rightSeparator key.