|
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.util.SimpleConfigurable org.apache.xindice.core.filer.FSFiler
FSFiler allows you to use existing file systems withing Xindice.
Field Summary |
Fields inherited from class org.apache.xindice.util.SimpleConfigurable |
config |
Constructor Summary | |
FSFiler()
|
Method Summary | |
boolean |
close()
close closes the DBObject |
boolean |
create()
create creates a new DBObject and any associated resources for the new DBObject, such as disk files, etc. |
boolean |
deleteRecord(Key key)
deleteRecord removes a Record from the Filer based on the specified Key. |
boolean |
drop()
drop instructs the DBObjectimplementation to remove itself from existence. |
boolean |
exists()
exists returns whether or not a physical representation of this DBObject actually exists. |
void |
flush()
flush forcefully flushes any unwritten buffers to disk. |
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. |
boolean |
isOpened()
isOpened returns whether or not the DBObject is opened for business. |
boolean |
open()
open opens the DBObject |
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. |
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.util.SimpleConfigurable |
getConfig |
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.util.Configurable |
getConfig |
Constructor Detail |
public FSFiler()
Method Detail |
public String getName()
Named
getName
in interface Named
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 void setConfig(Configuration config) throws XindiceException
Configurable
setConfig
in interface Configurable
setConfig
in class SimpleConfigurable
XindiceException
public boolean close()
DBObject
close
in interface DBObject
public boolean open()
DBObject
open
in interface DBObject
public boolean drop()
DBObject
drop
in interface DBObject
public boolean isOpened()
DBObject
isOpened
in interface DBObject
public boolean exists()
DBObject
exists
in interface DBObject
public boolean create()
DBObject
create
in interface DBObject
public void flush()
Filer
flush
in interface Filer
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
|
Xindice API version 1.2m1 |
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |