Package org.basex.index.query

Class IndexEntries

java.lang.Object

org.basex.index.query.IndexEntries

All Implemented Interfaces:

IndexSearch

public final class IndexEntries
extends Object
implements IndexSearch

This class contains information for returning index entries.

Author:

BaseX Team 2005-24, BSD License, Christian Gruen

Field Summary

Fields

Modifier and Type	Field	Description
boolean	descending	Ascending/descending traversal.
boolean	prefix	Prefix/traversal flag.

Constructor Summary

Constructors

Constructor	Description
IndexEntries(byte[] prefix, boolean asc, IndexType type)	Constructor for traversing entries.
IndexEntries(byte[] text, IndexType type)	Constructor for prefix search.

Method Summary

Modifier and Type	Method	Description
byte[]	token()	Returns the current token.
IndexType	type()	Returns the index type.

Methods inherited from class java.lang.Object

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

Field Detail

descending

public boolean descending

Ascending/descending traversal.

prefix

public boolean prefix

Prefix/traversal flag.

Constructor Detail

IndexEntries

public IndexEntries(byte[] text,
                    IndexType type)

Constructor for prefix search.

Parameters:

text - token

type - index type

IndexEntries

public IndexEntries(byte[] prefix,
                    boolean asc,
                    IndexType type)

Constructor for traversing entries.

Parameters:

prefix - token to start with

asc - return results in ascending order

type - index type

Method Detail

type

public IndexType type()

Description copied from interface: IndexSearch

Returns the index type.

Specified by:

type in interface IndexSearch

Returns:

type

token

public byte[] token()

Description copied from interface: IndexSearch

Returns the current token.

Specified by:

token in interface IndexSearch

Returns:

token