org.basex.index.value

Class DiskValues

java.lang.Object

org.basex.index.value.DiskValues

All Implemented Interfaces:

Index

Direct Known Subclasses:

UpdatableDiskValues

public class DiskValues
extends java.lang.Object
implements Index

This class provides access to attribute values and text contents stored on disk. The data structure is described in the ValueBuilder class.

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor and Description
DiskValues(Data d, boolean txt) Constructor, initializing the index structure.

Method Summary

Methods

Modifier and Type	Method and Description
void	close() Closes the index.
int	count(IndexToken it) Returns the (approximate/estimated) number of hits for the specified token.
void	delete(TokenObjMap<IntList> m) Delete records from the index.
EntryIterator	entries(byte[] prefix) Returns all entries that start with the specified prefix.
void	flush() Flushes the buffered data.
void	index(TokenObjMap<IntList> m) Add entries to the index.
byte[]	info() Returns information on the index structure.
IndexIterator	iter(IndexToken tok) Returns an iterator for the index results.
void	replace(byte[] o, byte[] n, int id) Remove record from the index.

Methods inherited from class java.lang.Object

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

Constructor Detail

DiskValues

public DiskValues(Data d,
          boolean txt)
           throws java.io.IOException

Constructor, initializing the index structure.

Parameters:

d - data reference

txt - value type (texts/attributes)

Throws:

java.io.IOException - I/O Exception

Method Detail

info

public byte[] info()

Description copied from interface: Index

Returns information on the index structure.

Specified by:

info in interface Index

Returns:

info

iter

public IndexIterator iter(IndexToken tok)

Description copied from interface: Index

Returns an iterator for the index results.

Specified by:

iter in interface Index

Parameters:

tok - token to be found

Returns:

sorted pre values for the token

count

public int count(IndexToken it)

Description copied from interface: Index

Returns the (approximate/estimated) number of hits for the specified token.

Specified by:

count in interface Index

Parameters:

it - token to be found

Returns:

number of hits

entries

public EntryIterator entries(byte[] prefix)

Description copied from interface: Index

Returns all entries that start with the specified prefix.

Specified by:

entries in interface Index

Parameters:

prefix - prefix

Returns:

entries

flush

public void flush()
           throws java.io.IOException

Flushes the buffered data.

Throws:

java.io.IOException - I/O exception

close

public void close()
           throws java.io.IOException

Description copied from interface: Index

Closes the index.

Specified by:

close in interface Index

Throws:

java.io.IOException - I/O exception

index

public void index(TokenObjMap<IntList> m)

Add entries to the index.

Parameters:

m - a set of pairs

delete

public void delete(TokenObjMap<IntList> m)

Delete records from the index.

Parameters:

m - a set of pairs

replace

public void replace(byte[] o,
           byte[] n,
           int id)

Remove record from the index.

Parameters:

o - old record key

n - new record key

id - record id