Skip navigation links

oracle.ide.index.file
Interface FileTable

public interface FileTable

Provides a file table for inverted index implementations. A file table is a snapshot of the state of the files at a given point in time. Each snapshot is assigned a version number. This makes it easy to determine what files have changed since the version of the file table that was last indexed.

Each file in the file table is assigned a file ID. Index data can be mapped to a list of these file IDs. For example, a keyword index could map each keyword to the list of file IDs that keyword appears in.

Whenever a file is modified, its file ID is increased. When the modified file is re-indexed, new index data is mapped to the new file ID. The old file ID becomes stale. This prevents the index from having to go through all of the index data to find references to the changed file. Instead, stale file IDs can be cleaned out of the index at a later time.

Field Summary

static long

VERSION_START The first version of a file table.

Method Summary

int[]	getFilesChangedSince(long version) Get the file IDs for files that have changed since the given version of the file table.
java.net.URL	getFileURL(int id) Get the URL corresponding to the given file ID.
long	getTimestamp(int id) Get the timestamp of the file with the given ID.
long	getVersion() Get the current version of this file table.
boolean	isValid(int id) Determine whether a file ID is valid.
void	release() Release this file table.

Field Detail

VERSION_START

static final long VERSION_START

The first version of a file table.

See Also:

Constant Field Values

Method Detail

getVersion

long getVersion()

Get the current version of this file table.

Returns:

the current version of the file table

isValid

boolean isValid(int id)

Determine whether a file ID is valid.

Parameters:

id - the file ID

Returns:

true if the file ID is valid, false if not

getFileURL

java.net.URL getFileURL(int id)

Get the URL corresponding to the given file ID.

Parameters:

id - the file ID

Returns:

the URL for this file ID

getTimestamp

long getTimestamp(int id)

Get the timestamp of the file with the given ID.

Parameters:

id - the file ID

Returns:

the timestamp of the file

getFilesChangedSince

int[] getFilesChangedSince(long version)

Get the file IDs for files that have changed since the given version of the file table.

Parameters:

version - the file table version

Returns:

the file IDs of the files that have changed

release

void release()

Release this file table. This allows any file system resources used by this file table to be released when the table is no longer in use.

Skip navigation links