|
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
com.dbxml.db.common.btree.BTree
com.dbxml.db.common.btree.BTreeFiler
BTreeFiler is a Filer implementation based on the BTree class.
Nested Class Summary |
Nested classes inherited from class com.dbxml.db.common.btree.Paged |
Paged.FileHeader, Paged.Page, Paged.PageHeader |
Constructor Summary | |
BTreeFiler()
|
|
BTreeFiler(boolean transactionSupported)
|
|
BTreeFiler(java.io.File f)
|
|
BTreeFiler(java.io.File f,
boolean transactionSupport)
|
Method Summary | |
boolean |
create()
create creates a new Filer and any associated resources for the new Filer, such as disk files, etc. |
Paged.FileHeader |
createFileHeader()
createFileHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a FileHeader. |
Paged.FileHeader |
createFileHeader(boolean read)
createFileHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a FileHeader. |
Paged.FileHeader |
createFileHeader(long pageCount)
createFileHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a FileHeader. |
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. |
Paged.PageHeader |
createPageHeader()
createPageHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a PageHeader. |
boolean |
deleteRecord(Transaction tx,
Key key)
deleteRecord removes a Record from the Filer based on the specified Key. |
java.lang.String |
getName()
getName returns the name of this Filer. |
long |
getRecordCount(Transaction tx)
getRecordCount returns the number of Records in the Filer. |
RecordMetaData |
getRecordMetaData(Transaction tx,
Key key)
getRecordMetaData returns metadata about the Record identified by the provided Key. |
RecordSet |
getRecordSet(Transaction tx)
getRecordSet returns a RecordSet object for the current Filer. |
Record |
readRecord(Transaction tx,
Key key)
readRecord returns a Record from the Filer based on the specified Key. |
void |
setCollection(Collection collection)
setCollection tells the Filer who its parent is. |
void |
setLocation(java.lang.String location)
|
boolean |
writeRecord(Transaction tx,
Key key,
Value value)
writeRecord writes a Value to the Filer based on the specified Key. |
Methods inherited from class com.dbxml.db.common.btree.BTree |
addValue, findValue, open, query, removeValue |
Methods inherited from class com.dbxml.db.common.btree.Paged |
addPageFilter, close, deleteArrayValue, drop, exists, flush, getConfig, getFileHeader, getTransactionLog, insertArrayValue, isOpened, listPageFilters, removePageFilter, setConfig |
Methods inherited from class java.lang.Object |
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.dbxml.db.core.filer.Filer |
close, drop, exists, flush, getTransactionLog, isOpened, open |
Methods inherited from interface com.dbxml.util.Configurable |
getConfig, setConfig |
Constructor Detail |
public BTreeFiler(boolean transactionSupported)
public BTreeFiler(java.io.File f, boolean transactionSupport)
public BTreeFiler(java.io.File f)
public BTreeFiler()
Method Detail |
public void setLocation(java.lang.String location)
public java.lang.String getName()
Filer
getName
in interface Filer
public boolean create() throws DBException
Filer
create
in interface Filer
create
in class BTree
DBException
public void setCollection(Collection collection)
Filer
setCollection
in interface Filer
collection
- The owner Collectionpublic RecordMetaData getRecordMetaData(Transaction tx, Key key) throws DBException
Filer
getRecordMetaData
in interface Filer
tx
- The controlling Transactionkey
- The Record's Key
DBException
public Record readRecord(Transaction tx, Key key) throws DBException
Filer
readRecord
in interface Filer
tx
- The controlling Transactionkey
- The Record's Key
DBException
public boolean writeRecord(Transaction tx, Key key, Value value) throws DBException
Filer
writeRecord
in interface Filer
tx
- The controlling Transactionkey
- The Record's Keyvalue
- The Record's Value
DBException
public boolean deleteRecord(Transaction tx, Key key) throws DBException
Filer
deleteRecord
in interface Filer
tx
- The controlling Transactionkey
- The Record's Key
DBException
public long getRecordCount(Transaction tx) throws DBException
Filer
getRecordCount
in interface Filer
tx
- The controlling Transaction
DBException
public RecordSet getRecordSet(Transaction tx) throws DBException
Filer
getRecordSet
in interface Filer
tx
- The controlling Transaction
DBException
public Paged.FileHeader createFileHeader()
Paged
createFileHeader
in class BTree
public Paged.FileHeader createFileHeader(boolean read) throws java.io.IOException
Paged
createFileHeader
in class BTree
java.io.IOException
public Paged.FileHeader createFileHeader(long pageCount)
Paged
createFileHeader
in class BTree
public Paged.FileHeader createFileHeader(long pageCount, int pageSize)
Paged
createFileHeader
in class BTree
public Paged.PageHeader createPageHeader()
Paged
createPageHeader
in class BTree
|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |