|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.dbxml.db.common.btree.Paged
Paged is a paged file foundation that is used by both the BTree class and the ValueIndexer. It provides flexible paged I/O and page caching functionality.
Nested Class Summary | |
class |
Paged.FileHeader
FileHeader |
class |
Paged.Page
Page |
class |
Paged.PageHeader
PageHeader |
Constructor Summary | |
Paged()
|
|
Paged(java.io.File file)
|
Method Summary | |
static void |
addPageFilter(PageFilter pageFilter)
setPageFilter adds a PageFilter to the PageFilter chain. |
boolean |
close()
|
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. |
static Value[] |
deleteArrayValue(Value[] vals,
int idx)
|
boolean |
drop()
|
boolean |
exists()
|
void |
flush(Transaction tx)
|
Configuration |
getConfig()
getConfig retrieves the configuration information for the Configurable object instance. |
Paged.FileHeader |
getFileHeader()
getFileHeader returns the FileHeader |
TransactionLog |
getTransactionLog()
|
static Value[] |
insertArrayValue(Value[] vals,
Value val,
int idx)
|
boolean |
isOpened()
|
static PageFilter[] |
listPageFilters()
listPageFilters returns a list of the PageFilters in the PageFilter chain. |
boolean |
open()
|
static void |
removePageFilter(PageFilter pageFilter)
removePageFilter removes the PageFilter from the PageFilter chain. |
void |
setConfig(Configuration config)
setConfig sets the configuration information for the Configurable object instance. |
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)
Method Detail |
public void setConfig(Configuration config) throws dbXMLException
Configurable
setConfig
in interface Configurable
config
- The configuration Node
dbXMLException
public Configuration getConfig()
Configurable
getConfig
in interface Configurable
public static final void addPageFilter(PageFilter pageFilter)
pageFilter
- The PageFilterpublic static final void removePageFilter(PageFilter pageFilter)
pageFilter
- The PageFilterpublic static final PageFilter[] listPageFilters()
public Paged.FileHeader getFileHeader()
public boolean exists()
public boolean create() throws DBException
DBException
public boolean open() throws DBException
DBException
public boolean close() throws DBException
DBException
public boolean isOpened()
public boolean drop() throws DBException
DBException
public void flush(Transaction tx) throws DBException
DBException
public TransactionLog getTransactionLog()
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 static Value[] insertArrayValue(Value[] vals, Value val, int idx)
public static Value[] deleteArrayValue(Value[] vals, int idx)
|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |