org.apache.xindice.core.filer
Class Paged.FileHeader

java.lang.Object
  |
  +--org.apache.xindice.core.filer.Paged.FileHeader

Enclosing class:

Paged

public abstract class Paged.FileHeader

extends java.lang.Object

FileHeader

Constructor Summary

Paged.FileHeader()

Paged.FileHeader(boolean read)

Paged.FileHeader(long pageCount)

Paged.FileHeader(long pageCount, int pageSize)

Method Summary

void	decRecordCount() Decrement the number of records being managed by the file
long	getFirstFreePage() The first free page in unused secondary space
short	getHeaderSize() The size of the FileHeader.
long	getLastFreePage() The last free page in unused secondary space
short	getMaxKeySize() The maximum number of bytes a key can be.
long	getPageCount() The number of pages in primary storage
byte	getPageHeaderSize() The size of a page header.
int	getPageSize() The size of a page.
long	getRecordCount() The number of records being managed by the file (not pages)
long	getTotalCount() The number of total pages in the file
int	getWorkSize()
void	incRecordCount() Increment the number of records being managed by the file
boolean	isDirty()
void	read()
void	read(java.io.RandomAccessFile raf)
void	setDirty()
void	setFirstFreePage(long firstFreePage) The first free page in unused secondary space
void	setHeaderSize(short headerSize) The size of the FileHeader.
void	setLastFreePage(long lastFreePage) The last free page in unused secondary space
void	setMaxKeySize(short maxKeySize) The maximum number of bytes a key can be.
void	setPageCount(long pageCount) The number of pages in primary storage
void	setPageHeaderSize(byte pageHeaderSize) The size of a page header.
void	setPageSize(int pageSize) The size of a page.
void	setRecordCount(long recordCount) The number of records being managed by the file (not pages)
void	setTotalCount(long totalCount) The number of total pages in the file
void	write()
void	write(java.io.RandomAccessFile raf)

Methods inherited from class java.lang.Object

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

Constructor Detail

Paged.FileHeader

public Paged.FileHeader()

Paged.FileHeader

public Paged.FileHeader(long pageCount)

Paged.FileHeader

public Paged.FileHeader(long pageCount,
                        int pageSize)

Paged.FileHeader

public Paged.FileHeader(boolean read)
                 throws java.io.IOException

Method Detail

read

public final void read()
                throws java.io.IOException

read

public void read(java.io.RandomAccessFile raf)
          throws java.io.IOException

write

public final void write()
                 throws java.io.IOException

write

public void write(java.io.RandomAccessFile raf)
           throws java.io.IOException

setDirty

public final void setDirty()

isDirty

public final boolean isDirty()

setHeaderSize

public final void setHeaderSize(short headerSize)

The size of the FileHeader. Usually 1 OS Page

getHeaderSize

public final short getHeaderSize()

The size of the FileHeader. Usually 1 OS Page

setPageSize

public final void setPageSize(int pageSize)

The size of a page. Usually a multiple of a FS block

getPageSize

public final int getPageSize()

The size of a page. Usually a multiple of a FS block

setPageCount

public final void setPageCount(long pageCount)

The number of pages in primary storage

getPageCount

public final long getPageCount()

The number of pages in primary storage

setTotalCount

public final void setTotalCount(long totalCount)

The number of total pages in the file

getTotalCount

public final long getTotalCount()

The number of total pages in the file

setFirstFreePage

public final void setFirstFreePage(long firstFreePage)

The first free page in unused secondary space

getFirstFreePage

public final long getFirstFreePage()

The first free page in unused secondary space

setLastFreePage

public final void setLastFreePage(long lastFreePage)

The last free page in unused secondary space

getLastFreePage

public final long getLastFreePage()

The last free page in unused secondary space

setPageHeaderSize

public final void setPageHeaderSize(byte pageHeaderSize)

The size of a page header. 64 is sufficient

getPageHeaderSize

public final byte getPageHeaderSize()

The size of a page header. 64 is sufficient

setMaxKeySize

public final void setMaxKeySize(short maxKeySize)

The maximum number of bytes a key can be. 256 is good

getMaxKeySize

public final short getMaxKeySize()

The maximum number of bytes a key can be. 256 is good

setRecordCount

public final void setRecordCount(long recordCount)

The number of records being managed by the file (not pages)

incRecordCount

public final void incRecordCount()

Increment the number of records being managed by the file

decRecordCount

public final void decRecordCount()

Decrement the number of records being managed by the file

getRecordCount

public final long getRecordCount()

The number of records being managed by the file (not pages)

getWorkSize

public final int getWorkSize()