org.basex.index.query
Class IndexEntries

java.lang.Object
  extended by org.basex.index.query.IndexEntries
All Implemented Interfaces:
IndexToken

public final class IndexEntries
extends java.lang.Object
implements IndexToken

This class contains information for returning index entries.

Author:
BaseX Team 2005-12, BSD License, Christian Gruen

Field Summary
 boolean descending
          Ascending/descending traversal.
 boolean prefix
          Prefix/traversal flag.
 
Constructor Summary
IndexEntries(byte[] tok, boolean asc, IndexType it)
          Constructor for traversing entries.
IndexEntries(byte[] tok, IndexType it)
          Constructor for prefix search.
 
Method Summary
 byte[] get()
          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[] tok,
                    IndexType it)
Constructor for prefix search.

Parameters:
tok - token
it - index type

IndexEntries

public IndexEntries(byte[] tok,
                    boolean asc,
                    IndexType it)
Constructor for traversing entries.

Parameters:
tok - token to start with
asc - return results in ascending order
it - index type
Method Detail

type

public IndexType type()
Description copied from interface: IndexToken
Returns the index type.

Specified by:
type in interface IndexToken
Returns:
type

get

public byte[] get()
Description copied from interface: IndexToken
Returns the current token.

Specified by:
get in interface IndexToken
Returns:
token