com.bigdata.btree.filter

Class TupleUpdater<E>

java.lang.Object

cutthecrap.utils.striterators.FilterBase

com.bigdata.btree.filter.TupleFilter<E>

com.bigdata.btree.filter.TupleUpdater<E>

Type Parameters:

E -

All Implemented Interfaces:

ITupleFilter<E>, IFilter, IPropertySet, Serializable, Cloneable

Direct Known Subclasses:

FileVersionDeleter

public abstract class TupleUpdater<E>
extends TupleFilter<E>

Filter allows mutation of the visited ITuples.

Version:

$Id$

Author:

Bryan Thompson

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected class	TupleUpdater.Updaterator

Nested classes/interfaces inherited from class com.bigdata.btree.filter.TupleFilter

TupleFilter.TupleFilterator<E>

Constructor Summary

Constructors

Constructor and Description
TupleUpdater()

Method Summary

Methods

Modifier and Type	Method and Description
ITupleIterator<E>	filterOnce(Iterator src, Object context) Wrap the source iterator with this filter.
protected abstract void	update(IIndex ndx, ITuple<E> tuple) You may implement this method to update the state of the visited tuple in the backing index.

Methods inherited from class com.bigdata.btree.filter.TupleFilter

isValid

Methods inherited from class cutthecrap.utils.striterators.FilterBase

addFilter, filter, getProperty, getRequiredProperty, setProperty, toString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface cutthecrap.utils.striterators.IFilter

filter

Methods inherited from interface cutthecrap.utils.striterators.IPropertySet

getProperty

Constructor Detail

TupleUpdater

public TupleUpdater()

Method Detail

filterOnce

public ITupleIterator<E> filterOnce(Iterator src,
                           Object context)

Description copied from class: FilterBase

Wrap the source iterator with this filter.

Specified by:

filterOnce in interface ITupleFilter<E>

Overrides:

filterOnce in class TupleFilter<E>

Parameters:

src - The source iterator.

context - The iterator evaluation context.

Returns:

The wrapped iterator.

update

protected abstract void update(IIndex ndx,
          ITuple<E> tuple)

You may implement this method to update the state of the visited tuple in the backing index.

Note: If you modify tuple then that modification will be visitible to the consumer of the iterator.

Parameters:

ndx - The index on which the ITupleCursor is reading.

tuple - The tuple that is being visited.