Xindice API
version 1.2m1

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

java.lang.Object
  extended byorg.apache.xindice.core.filer.Paged.PageHeader
All Implemented Interfaces:
Streamable
Direct Known Subclasses:
BTree.BTreePageHeader, HashFiler.HashPageHeader
Enclosing class:
Paged

protected abstract static class Paged.PageHeader
extends Object
implements Streamable

Paged file page's header


Constructor Summary
Paged.PageHeader()
           
Paged.PageHeader(DataInput dis)
           
 
Method Summary
 int getDataLen()
          The length of the Data
 int getKeyHash()
          The hashed value of the Key for quick comparisons
 short getKeyLen()
          The length of the Key
 long getNextPage()
          The next page for this Record (if overflowed)
 int getRecordLen()
          The length of the Record's value
 byte getStatus()
          The status of this page (UNUSED, RECORD, DELETED, etc...)
 boolean isDirty()
           
 void read(DataInput dis)
          read reads the object state from the stream.
 void setDataLen(int dataLen)
          The length of the Data
 void setDirty()
           
 void setKey(Key key)
           
 void setKeyHash(int keyHash)
          The hashed value of the Key for quick comparisons
 void setKeyLen(short keyLen)
          The length of the Key
 void setNextPage(long nextPage)
          The next page for this Record (if overflowed)
 void setRecordLen(int recordLen)
          The length of the Record's value
 void setStatus(byte status)
          The status of this page (UNUSED, RECORD, DELETED, etc...)
 void write(DataOutput dos)
          write writes the object state to the stream.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

Paged.PageHeader

public Paged.PageHeader()

Paged.PageHeader

public Paged.PageHeader(DataInput dis)
                 throws IOException
Method Detail

read

public void read(DataInput dis)
          throws IOException
Description copied from interface: Streamable
read reads the object state from the stream.

Specified by:
read in interface Streamable
Parameters:
dis - The DataInputStream
Throws:
IOException - if an IOException occurs

write

public void write(DataOutput dos)
           throws IOException
Description copied from interface: Streamable
write writes the object state to the stream.

Specified by:
write in interface Streamable
Parameters:
dos - The DataOutputStream
Throws:
IOException - if an IOException occurs

isDirty

public final boolean isDirty()

setDirty

public final void setDirty()

setStatus

public final void setStatus(byte status)
The status of this page (UNUSED, RECORD, DELETED, etc...)


getStatus

public final byte getStatus()
The status of this page (UNUSED, RECORD, DELETED, etc...)


setKey

public final void setKey(Key key)

setKeyLen

public final void setKeyLen(short keyLen)
The length of the Key


getKeyLen

public final short getKeyLen()
The length of the Key


setKeyHash

public final void setKeyHash(int keyHash)
The hashed value of the Key for quick comparisons


getKeyHash

public final int getKeyHash()
The hashed value of the Key for quick comparisons


setDataLen

public final void setDataLen(int dataLen)
The length of the Data


getDataLen

public final int getDataLen()
The length of the Data


setRecordLen

public void setRecordLen(int recordLen)
The length of the Record's value


getRecordLen

public final int getRecordLen()
The length of the Record's value


setNextPage

public final void setNextPage(long nextPage)
The next page for this Record (if overflowed)


getNextPage

public final long getNextPage()
The next page for this Record (if overflowed)


Xindice API
version 1.2m1

Copyright (c) 1999-2007 The Apache Software Foundation. All Rights Reserved.