org.basex.index

Class Resources

java.lang.Object

org.basex.index.Resources

All Implemented Interfaces:

Index

public final class Resources
extends java.lang.Object
implements Index

This index organizes the resources of a database (XML documents and raw files).

Author:

BaseX Team 2005-12, BSD License, Christian Gruen

Constructor Summary

Constructors

Constructor and Description
Resources(Data d) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
TokenList	binaries(java.lang.String path) Returns the database paths to all binary files that match the specified path.
TokenBoolMap	children(byte[] path, boolean dir) Returns the child resources for the given path.
void	close() Closes the index.
int	count(IndexToken token) Returns the (approximate/estimated) number of hits for the specified token.
void	delete(int pre, int size) Deletes the specified entry and updates subsequent nodes.
int	doc(java.lang.String path) Returns the pre value of the node that matches the specified path, or -1.
int	doc(java.lang.String path, boolean sort) Returns the pre value of the document node matching the specified path.
IntList	docs() Returns the pre values of all document nodes.
IntList	docs(java.lang.String path) Returns the pre values of all document nodes matching the specified path.
EntryIterator	entries(byte[] prefix) Returns all entries that start with the specified prefix.
byte[]	info() Returns information on the index structure.
void	init() Initializes the index.
void	insert(int pre, Data d) Adds entries to the index and updates subsequent nodes.
boolean	isDir(byte[] path) Determines whether the given path is the path to a directory.
IndexIterator	iter(IndexToken token) Returns an iterator for the index results.
void	read(DataInput in) Reads information on database resources from disk.
void	rename(int pre, byte[] value) Updates the index after a document has been renamed.
void	replace(int pre, int size, Data d) Replaces entries in the index.
void	write(DataOutput out) Writes information on database resources to disk.

Methods inherited from class java.lang.Object

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

Constructor Detail

Resources

public Resources(Data d)

Constructor.

Parameters:

d - data reference

Method Detail

read

public void read(DataInput in)
          throws java.io.IOException

Reads information on database resources from disk.

Parameters:

in - input stream

Throws:

java.io.IOException - I/O exception

write

public void write(DataOutput out)
           throws java.io.IOException

Writes information on database resources to disk.

Parameters:

out - output stream

Throws:

java.io.IOException - I/O exception

docs

public IntList docs()

Returns the pre values of all document nodes. A single dummy node is returned if the database is empty.

Returns:

document nodes

init

public void init()

Initializes the index.

insert

public void insert(int pre,
          Data d)

Adds entries to the index and updates subsequent nodes.

Parameters:

pre - insertion position

d - data reference to be inserted

delete

public void delete(int pre,
          int size)

Deletes the specified entry and updates subsequent nodes.

Parameters:

pre - pre value

size - number of deleted nodes

rename

public void rename(int pre,
          byte[] value)

Updates the index after a document has been renamed.

Parameters:

pre - pre value of updated document

value - new name

replace

public void replace(int pre,
           int size,
           Data d)

Replaces entries in the index.

Parameters:

pre - insertion position

size - number of deleted nodes

d - data reference to be copied

docs

public IntList docs(java.lang.String path)

Returns the pre values of all document nodes matching the specified path. Exact || prefix match!

Parameters:

path - input path

Returns:

root nodes

doc

public int doc(java.lang.String path)

Returns the pre value of the node that matches the specified path, or -1.

Parameters:

path - input path

Returns:

pre value

doc

public int doc(java.lang.String path,
      boolean sort)

Returns the pre value of the document node matching the specified path. Exact match! Document paths can be sorted for faster future access or sorting can be disabled as it slows down bulk inserts/deletes/replaces.

Parameters:

path - input path

sort - sort paths before access

Returns:

root nodes

binaries

public TokenList binaries(java.lang.String path)

Returns the database paths to all binary files that match the specified path.

Parameters:

path - input path

Returns:

root nodes

isDir

public boolean isDir(byte[] path)

Determines whether the given path is the path to a directory.

Parameters:

path - given path (must be normalized, means one leading but no trailing slash.

Returns:

path to a directory or not

children

public TokenBoolMap children(byte[] path,
                    boolean dir)

Returns the child resources for the given path.

Parameters:

path - path

dir - returns directories

Returns:

paths; values of documents will be false

close

public void close()

Description copied from interface: Index

Closes the index.

Specified by:

close in interface Index

iter

public IndexIterator iter(IndexToken token)

Description copied from interface: Index

Returns an iterator for the index results.

Specified by:

iter in interface Index

Parameters:

token - token to be found

Returns:

sorted pre values for the token

count

public int count(IndexToken token)

Description copied from interface: Index

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

Specified by:

count in interface Index

Parameters:

token - token to be found

Returns:

number of hits

info

public byte[] info()

Description copied from interface: Index

Returns information on the index structure.

Specified by:

info in interface Index

Returns:

info

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