|
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.HashFiler
HashFiler is a Filer implementation based on the Paged class. By
extending Paged, HashFiler inherits the ability to maintain Record
metadata such as creation and modification time. It also provides
quite a bit more flexibility in its ability to retreive blocks of
data and allocate Record space.
HashFile has folowing configuration attributes:
Nested Class Summary | |
protected class |
HashFiler.HashPageHeader
HashPageHeader |
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.Paged |
CONFIG_DESCRIPTORS_MAX, CONFIG_KEYSIZE_MAX, CONFIG_PAGECOUNT, CONFIG_PAGESIZE, DELETED, NO_PAGE, OVERFLOW, UNUSED |
Constructor Summary | |
HashFiler()
|
Method Summary | |
Paged.FileHeader |
createFileHeader()
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(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 |
setConfig(Configuration config)
setConfig sets the configuration information for the Configurable object instance. |
void |
setLocation(File root,
String location)
setLocation tells the Filer where to store its data. |
protected void |
unlinkPages(Paged.Page page)
Mark pages in primary store as 'DELETED', and let Paged handle all overflow pages. |
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.Paged |
checkOpened, close, closeDescriptor, create, deleteArrayInt, deleteArrayLong, deleteArrayShort, deleteArrayValue, drop, exists, flush, getConfig, getDescriptor, getFile, getFileHeader, getFreePage, getPage, insertArrayInt, insertArrayLong, insertArrayShort, insertArrayValue, isOpened, open, putDescriptor, readValue, readValue, setFile, 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 |
Field Detail |
protected static final byte RECORD
Constructor Detail |
public HashFiler()
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 void setConfig(Configuration config)
Configurable
setConfig
in interface Configurable
setConfig
in class Paged
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
protected void unlinkPages(Paged.Page page) throws IOException
unlinkPages
in class Paged
page
- The starting Page to unlink
IOException
- if an Exception occurspublic 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
public Paged.FileHeader createFileHeader()
Paged
createFileHeader
in class Paged
public Paged.PageHeader createPageHeader()
Paged
createPageHeader
in class Paged
|
Xindice API version 1.2m1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |