|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Filer is the low-level file management interface for dbXML. A Filer object is implemented in order to provide a data source to the dbXML Collection class. Filers are developed to perform transparent storage and retrieval to and from heterogenous data sources (such as FTP, HTTP, RDBMS, etc...)
Method Summary | |
boolean |
close()
close closes the Filer |
boolean |
create()
create creates a new Filer and any associated resources for the new Filer, such as disk files, etc. |
boolean |
deleteRecord(Transaction tx,
Key key)
deleteRecord removes a Record from the Filer based on the specified Key. |
boolean |
drop()
drop instructs the Filerimplementation to remove itself from existence. |
boolean |
exists()
exists returns whether or not a physical representation of this Filer actually exists. |
void |
flush(Transaction tx)
flush forcefully flushes any unwritten buffers to disk. |
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. |
TransactionLog |
getTransactionLog()
getTransactionLog returns the Transaction Log for this Filer. |
boolean |
isOpened()
isOpened returns whether or not the Filer is opened for business. |
boolean |
open()
open opens the 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. |
boolean |
writeRecord(Transaction tx,
Key key,
Value value)
writeRecord writes a Value to the Filer based on the specified Key. |
Methods inherited from interface com.dbxml.util.Configurable |
getConfig, setConfig |
Method Detail |
public java.lang.String getName()
public boolean create() throws DBException
DBException
public boolean open() throws DBException
DBException
public boolean isOpened() throws DBException
DBException
public boolean exists() throws DBException
DBException
public boolean drop() throws DBException
DBException
public boolean close() throws DBException
DBException
public void setCollection(Collection collection)
collection
- The owner Collectionpublic RecordMetaData getRecordMetaData(Transaction tx, Key key) throws DBException
tx
- The controlling Transactionkey
- The Record's Key
DBException
public Record readRecord(Transaction tx, Key key) throws DBException
tx
- The controlling Transactionkey
- The Record's Key
DBException
public boolean writeRecord(Transaction tx, Key key, Value value) throws DBException
tx
- The controlling Transactionkey
- The Record's Keyvalue
- The Record's Value
DBException
public boolean deleteRecord(Transaction tx, Key key) throws DBException
tx
- The controlling Transactionkey
- The Record's Key
DBException
public long getRecordCount(Transaction tx) throws DBException
tx
- The controlling Transaction
DBException
public RecordSet getRecordSet(Transaction tx) throws DBException
tx
- The controlling Transaction
DBException
public void flush(Transaction tx) throws DBException
tx
- The controlling Transaction
DBException
public TransactionLog getTransactionLog() throws DBException
DBException
|
dbXML API | ||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |