|
Xindice API version 1.2m1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Object org.apache.xindice.core.filer.Paged org.apache.xindice.core.filer.BTree org.apache.xindice.core.filer.BTreeFiler
BTreeFiler is a Filer implementation based on the BTree class.
BTreeFiler has folowing configuration attributes:
Nested Class Summary |
Nested classes inherited from class org.apache.xindice.core.filer.BTree |
BTree.BTreeFileHeader, BTree.BTreePageHeader, BTree.BTreeRootInfo |
Nested classes inherited from class org.apache.xindice.core.filer.Paged |
Paged.FileHeader, Paged.Page, Paged.PageHeader, Paged.PageKey |
Field Summary | |
protected static byte |
RECORD
Record page status |
Fields inherited from class org.apache.xindice.core.filer.BTree |
BRANCH, LEAF, STREAM |
Fields inherited from class org.apache.xindice.core.filer.Paged |
CONFIG_DESCRIPTORS_MAX, CONFIG_KEYSIZE_MAX, CONFIG_PAGECOUNT, CONFIG_PAGESIZE, DELETED, NO_PAGE, OVERFLOW, UNUSED |
Constructor Summary | |
BTreeFiler()
|
Method Summary | |
protected Paged.FileHeader |
createFileHeader()
createFileHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a FileHeader. |
protected Paged.PageHeader |
createPageHeader()
createPageHeader must be implemented by a Paged implementation in order to create an appropriate subclass instance of a PageHeader. |
boolean |
deleteRecord(Key key)
deleteRecord removes a Record from the Filer based on the specified Key. |
String |
getName()
getName retrieves the contextually important name of the object |
long |
getRecordCount()
getRecordCount returns the number of Records in the Filer. |
RecordSet |
getRecordSet()
getRecordSet returns a RecordSet object for the current Filer. |
Record |
readRecord(Key key)
readRecord returns a Record from the Filer based on the specified Key. |
Record |
readRecord(Key key,
boolean metaOnly)
readRecord returns a Record from the Filer based on the specified Key containing filer meta information and value. |
void |
setLocation(File root,
String location)
setLocation tells the Filer where to store its data. |
Record |
writeRecord(Key key,
Value value)
writeRecord writes a Value to the Filer based on the specified Key. |
Methods inherited from class org.apache.xindice.core.filer.BTree |
addKey, addValue, addValue, close, create, createBTreeRoot, createBTreeRoot, findBTreeRoot, findBTreeRoot, findValue, findValue, getRootNode, getRootNode, open, query, query, removeValue, removeValue, setRootNode, setRootNode |
Methods inherited from class org.apache.xindice.core.filer.Paged |
checkOpened, closeDescriptor, deleteArrayInt, deleteArrayLong, deleteArrayShort, deleteArrayValue, drop, exists, flush, getConfig, getDescriptor, getFile, getFileHeader, getFreePage, getPage, insertArrayInt, insertArrayLong, insertArrayShort, insertArrayValue, isOpened, putDescriptor, readValue, readValue, setConfig, setFile, unlinkPages, unlinkPages, writeValue, writeValue |
Methods inherited from class java.lang.Object |
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface org.apache.xindice.core.filer.Filer |
flush |
Methods inherited from interface org.apache.xindice.core.DBObject |
close, create, drop, exists, isOpened, open |
Methods inherited from interface org.apache.xindice.util.Configurable |
getConfig, setConfig |
Field Detail |
protected static final byte RECORD
Constructor Detail |
public BTreeFiler()
Method Detail |
public void setLocation(File root, String location)
Filer
setLocation
in interface Filer
root
- The root under which to store datalocation
- The name to use for storing datapublic String getName()
Named
getName
in interface Named
public Record readRecord(Key key) throws DBException
Filer
readRecord
in interface Filer
key
- The Record's Key
DBException
public Record readRecord(Key key, boolean metaOnly) throws DBException
Filer
readRecord
in interface Filer
key
- The Record's KeymetaOnly
- if true, resulting record contains only meta information
DBException
public Record writeRecord(Key key, Value value) throws DBException
Filer
writeRecord
in interface Filer
key
- The Record's Keyvalue
- The Record's Value
DBException
public boolean deleteRecord(Key key) throws DBException
Filer
deleteRecord
in interface Filer
key
- The Record's Key
DBException
public long getRecordCount() throws DBException
Filer
getRecordCount
in interface Filer
DBException
public RecordSet getRecordSet() throws DBException
Filer
getRecordSet
in interface Filer
DBException
protected Paged.FileHeader createFileHeader()
Paged
createFileHeader
in class BTree
protected Paged.PageHeader createPageHeader()
Paged
createPageHeader
in class BTree
|
Xindice API version 1.2m1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |