com.healthmarketscience.jackcess
Class UsageMap

java.lang.Object
  com.healthmarketscience.jackcess.UsageMap

public class UsageMap
extends java.lang.Object

Describes which database pages a particular table uses

Author:

Tim McCune

Nested Class Summary

class

UsageMap.PageCursor Utility class to traverse over the pages in the UsageMap.

Field Summary

static byte	MAP_TYPE_INLINE Inline map type
static byte	MAP_TYPE_REFERENCE Reference map type, for maps that are too large to fit inline

Method Summary

void	addPageNumber(int pageNumber) Add a page number to this usage map
boolean	containsPageNumber(int pageNumber) Determines if the given page number is contained in this map.
UsageMap.PageCursor	cursor()
Database	getDatabase()
JetFormat	getFormat()
PageChannel	getPageChannel()
static UsageMap	read(Database database, int pageNum, int rowNum, boolean assumeOutOfRangeBitsOn)
void	removePageNumber(int pageNumber) Remove a page number from this usage map
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

MAP_TYPE_INLINE

public static final byte MAP_TYPE_INLINE

Inline map type

See Also:

Constant Field Values

MAP_TYPE_REFERENCE

public static final byte MAP_TYPE_REFERENCE

Reference map type, for maps that are too large to fit inline

See Also:

Constant Field Values

Method Detail

getDatabase

public Database getDatabase()

getFormat

public JetFormat getFormat()

getPageChannel

public PageChannel getPageChannel()

read

public static UsageMap read(Database database,
                            int pageNum,
                            int rowNum,
                            boolean assumeOutOfRangeBitsOn)
                     throws java.io.IOException

Parameters:

database - database that contains this usage map

pageNum - Page number that this usage map is contained in

rowNum - Number of the row on the page that contains this usage map

Returns:

Either an InlineUsageMap or a ReferenceUsageMap, depending on which type of map is found

Throws:

java.io.IOException

cursor

public UsageMap.PageCursor cursor()

containsPageNumber

public boolean containsPageNumber(int pageNumber)

Determines if the given page number is contained in this map.

addPageNumber

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

Add a page number to this usage map

Throws:

java.io.IOException

removePageNumber

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

Remove a page number from this usage map

Throws:

java.io.IOException

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object