Package org.basex.index.query

Class FTIndexIterator

java.lang.Object

org.basex.index.query.FTIndexIterator

All Implemented Interfaces:

IndexIterator

public abstract class FTIndexIterator
extends Object
implements IndexIterator

This interface provides methods for returning index results.

Author:

BaseX Team 2005-21, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field	Description
static final FTIndexIterator	FTEMPTY	Empty iterator.

Fields inherited from interface org.basex.index.query.IndexIterator

EMPTY

Constructor Summary

Constructors

Constructor	Description
FTIndexIterator()

Method Summary

Modifier and Type	Method	Description
static FTIndexIterator	intersect(FTIndexIterator i1, FTIndexIterator i2, int dis)	Merges two index array iterators.
abstract FTMatches	matches()	Returns the next match.
abstract void	pos(int p)	Sets the position of the token in the query.
static FTIndexIterator	union(FTIndexIterator i1, FTIndexIterator i2)	Merges two index array iterators.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.basex.index.query.IndexIterator

more, pre, size

Field Details

FTEMPTY

public static final FTIndexIterator FTEMPTY

Empty iterator.

Constructor Details

FTIndexIterator

public FTIndexIterator()

Method Details

matches

public abstract FTMatches matches()

Returns the next match.

Returns:

next match (can be null)

pos

public abstract void pos(int p)

Sets the position of the token in the query.

Parameters:

p - query position

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