org.basex.index.ft

Class FTIndexIterator

java.lang.Object

org.basex.index.IndexIterator

org.basex.index.ft.FTIndexIterator

public abstract class FTIndexIterator
extends IndexIterator

This interface provides methods for returning index results.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary

Fields inherited from class org.basex.index.IndexIterator

EMPTY

Constructor Summary

Constructors

Constructor and Description
FTIndexIterator()

Method Summary

Methods

Modifier and Type	Method and Description
static FTIndexIterator	intersect(FTIndexIterator i1, FTIndexIterator i2, int dis) Merges two index array iterators.
abstract FTMatches	matches() Returns the next match.
void	tokenNum(byte tn) Sets the unique token number.
static FTIndexIterator	union(FTIndexIterator i1, FTIndexIterator i2) Merges two index array iterators.

Methods inherited from class org.basex.index.IndexIterator

more, next, score, size

Methods inherited from class java.lang.Object

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

Constructor Detail

FTIndexIterator

public FTIndexIterator()

Method Detail

matches

public abstract FTMatches matches()

Returns the next match.

Returns:

next match

tokenNum

public void tokenNum(byte tn)

Sets the unique token number. Used for visualization.

Parameters:

tn - number of tokens

union

public static FTIndexIterator union(FTIndexIterator i1,
                    FTIndexIterator i2)

Merges two index array iterators.

Parameters:

i1 - first index array iterator to merge

i2 - second index array iterator to merge

Returns:

IndexArrayIterator

intersect

public static FTIndexIterator intersect(FTIndexIterator i1,
                        FTIndexIterator i2,
                        int dis)

Merges two index array iterators.

Parameters:

i1 - first index array iterator to merge

i2 - second index array iterator to merge

dis - word distance. Ignored if 0

Returns:

IndexArrayIterator