com.healthmarketscience.jackcess
Class IndexPageCache

java.lang.Object
  com.healthmarketscience.jackcess.IndexPageCache

public class IndexPageCache
extends java.lang.Object

Manager of the index pages for a BigIndex.

Author:

James Ahlborn

Nested Class Summary

static class

IndexPageCache.CacheDataPage IndexPageCache implementation of an Index Index.DataPage.

Constructor Summary

IndexPageCache(BigIndex index)

Method Summary

IndexPageCache.CacheDataPage	findCacheDataPage(Index.Entry e) Finds the index page on which the given entry does or should reside.
IndexPageCache.CacheDataPage	getCacheDataPage(java.lang.Integer pageNumber) Returns a CacheDataPage for the given page number, may be null if the given page number is invalid.
BigIndex	getIndex()
PageChannel	getPageChannel()
void	setRootPageNumber(int pageNumber) Sets the root page for this index, must be called before normal usage.
java.lang.String	toString()
void	write() Writes any outstanding changes for this index to the file.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

IndexPageCache

public IndexPageCache(BigIndex index)

Method Detail

getIndex

public BigIndex getIndex()

getPageChannel

public PageChannel getPageChannel()

setRootPageNumber

public void setRootPageNumber(int pageNumber)
                       throws java.io.IOException

Sets the root page for this index, must be called before normal usage.

Parameters:

pageNumber - the root page number

Throws:

java.io.IOException

write

public void write()
           throws java.io.IOException

Writes any outstanding changes for this index to the file.

Throws:

java.io.IOException

getCacheDataPage

public IndexPageCache.CacheDataPage getCacheDataPage(java.lang.Integer pageNumber)
                                              throws java.io.IOException

Returns a CacheDataPage for the given page number, may be null if the given page number is invalid. Loads the given page if necessary.

Throws:

java.io.IOException

findCacheDataPage

public IndexPageCache.CacheDataPage findCacheDataPage(Index.Entry e)
                                               throws java.io.IOException

Finds the index page on which the given entry does or should reside.

Parameters:

e - the entry to find

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object