|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.storage.btree.Paged
public abstract class Paged
Paged is a paged file foundation that is used by the BTree class and its subclasses.
Nested Class Summary | |
---|---|
class |
Paged.FileHeader
FileHeader |
class |
Paged.Page
Page |
static class |
Paged.PageHeader
|
Field Summary | |
---|---|
static int |
LENGTH_FIRST_FREE_PAGE
|
static int |
LENGTH_HEADER_SIZE
|
static int |
LENGTH_LAST_FREE_PAGE
|
static int |
LENGTH_MAX_KEY_SIZE
|
static int |
LENGTH_PAGE_COUNT
|
static int |
LENGTH_PAGE_HEADER_SIZE
|
static int |
LENGTH_PAGE_SIZE
|
static int |
LENGTH_RECORD_COUNT
|
static int |
LENGTH_TOTAL_COUNT
|
static int |
LENGTH_VERSION_ID
|
static int |
OFFSET_FIRST_FREE_PAGE
|
static int |
OFFSET_HEADER_SIZE
|
static int |
OFFSET_LAST_FREE_PAGE
|
static int |
OFFSET_MAX_KEY_SIZE
|
static int |
OFFSET_PAGE_COUNT
|
static int |
OFFSET_PAGE_HEADER_SIZE
|
static int |
OFFSET_PAGE_SIZE
|
static int |
OFFSET_RECORD_COUNT
|
static int |
OFFSET_REMAINDER
|
static int |
OFFSET_TOTAL_COUNT
|
static int |
OFFSET_VERSION_ID
|
Constructor Summary | |
---|---|
Paged(BrokerPool pool)
|
Method Summary | |
---|---|
void |
backupToStream(OutputStream os)
Backup the entire contents of the underlying file to an output stream. |
boolean |
close()
Close the underlying files. |
void |
closeAndRemove()
Completely close down the instance and all underlying resources and caches. |
boolean |
create()
|
abstract Paged.FileHeader |
createFileHeader(int pageSize)
createFileHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a FileHeader. |
abstract Paged.PageHeader |
createPageHeader()
createPageHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a PageHeader. |
boolean |
exists()
|
boolean |
flush()
|
File |
getFile()
getFile returns the file object for this Paged. |
Paged.FileHeader |
getFileHeader()
getFileHeader returns the FileHeader |
abstract short |
getFileVersion()
|
static int |
getPageSize()
|
static String |
hexDump(byte[] data)
|
boolean |
isOpened()
Gets the opened attribute of the Paged object |
boolean |
isReadOnly()
|
boolean |
open(short expectedVersion)
|
void |
printFreeSpaceList()
Debug |
static void |
setPageSize(int pageSize)
|
Methods inherited from class java.lang.Object |
---|
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Field Detail |
---|
public static int LENGTH_VERSION_ID
public static int LENGTH_HEADER_SIZE
public static int LENGTH_PAGE_COUNT
public static int LENGTH_PAGE_SIZE
public static int LENGTH_TOTAL_COUNT
public static int LENGTH_FIRST_FREE_PAGE
public static int LENGTH_LAST_FREE_PAGE
public static int LENGTH_PAGE_HEADER_SIZE
public static int LENGTH_MAX_KEY_SIZE
public static int LENGTH_RECORD_COUNT
public static int OFFSET_VERSION_ID
public static int OFFSET_HEADER_SIZE
public static int OFFSET_PAGE_SIZE
public static int OFFSET_PAGE_COUNT
public static int OFFSET_TOTAL_COUNT
public static int OFFSET_FIRST_FREE_PAGE
public static int OFFSET_LAST_FREE_PAGE
public static int OFFSET_PAGE_HEADER_SIZE
public static int OFFSET_MAX_KEY_SIZE
public static int OFFSET_RECORD_COUNT
public static int OFFSET_REMAINDER
Constructor Detail |
---|
public Paged(BrokerPool pool)
Method Detail |
---|
public abstract short getFileVersion()
public static final void setPageSize(int pageSize)
public static final int getPageSize()
public final boolean isReadOnly()
public boolean close() throws DBException
DBException
public boolean create() throws DBException
DBException
public abstract Paged.FileHeader createFileHeader(int pageSize)
public abstract Paged.PageHeader createPageHeader()
public boolean exists()
public boolean flush() throws DBException
DBException
public void backupToStream(OutputStream os) throws IOException
os
-
IOException
public final File getFile()
public Paged.FileHeader getFileHeader()
public void closeAndRemove()
public boolean isOpened()
public boolean open(short expectedVersion) throws DBException
DBException
public void printFreeSpaceList() throws IOException
IOException
- Description of the Exceptionpublic static String hexDump(byte[] data)
|
|||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |