|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.exist.storage.btree.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
|
Constructor Summary | |
Paged()
|
|
Paged(java.io.File file)
|
Method Summary | |
void |
backupToStream(java.io.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()
createFileHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a FileHeader. |
abstract Paged.FileHeader |
createFileHeader(boolean read)
createFileHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a FileHeader. |
abstract Paged.FileHeader |
createFileHeader(long pageCount)
createFileHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a FileHeader. |
abstract Paged.FileHeader |
createFileHeader(long pageCount,
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()
|
java.io.File |
getFile()
getFile returns the file object for this Paged. |
Paged.FileHeader |
getFileHeader()
getFileHeader returns the FileHeader |
short |
getFileVersion()
|
static int |
getPageSize()
|
static java.lang.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 |
Constructor Detail |
public Paged()
public Paged(java.io.File file) throws DBException
Method Detail |
public 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()
public abstract Paged.FileHeader createFileHeader(boolean read) throws java.io.IOException
read
- If true, reads the FileHeader from disk
java.io.IOException
- if an exception occurspublic abstract Paged.FileHeader createFileHeader(long pageCount)
pageCount
- The number of pages to allocate for primary storage
public abstract Paged.FileHeader createFileHeader(long pageCount, int pageSize)
pageCount
- The number of pages to allocate for primary storagepageSize
- The size of a Page (should be a multiple of a FS block)
public abstract Paged.PageHeader createPageHeader()
public boolean exists()
public boolean flush() throws DBException
DBException
public void backupToStream(java.io.OutputStream os) throws java.io.IOException
os
-
java.io.IOException
public final java.io.File getFile()
public Paged.FileHeader getFileHeader()
public void closeAndRemove()
public boolean isOpened()
public boolean open(short expectedVersion) throws DBException
DBException
public void printFreeSpaceList() throws java.io.IOException
java.io.IOException
- Description of the Exceptionpublic static java.lang.String hexDump(byte[] data)
|
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |