MemFiler (Project JXTA J2SE Reference Implementation)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

Project JXTA

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

net.jxta.impl.xindice.core.filer
Class MemFiler

java.lang.Object
  net.jxta.impl.xindice.core.filer.MemFiler

All Implemented Interfaces:: DBObject, Filer, Named

public final class MemFiler
extends Object
implements Filer
extends Object
implements Filer

MemFiler is an In-Memory Filer implementation for Xindice. MemFiler can be used for temporary collections and caching. It's basically a layering on top of HashMap.

Constructor Summary
`MemFiler()`
`MemFiler(Map hashTable)`
`MemFiler(Map hashTable, boolean readOnly)`

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(long pos)` readRecord returns a Record from the Filer at the specified position.
`void`	`setLocation(File root, String location)`
`long`	`writeRecord(Key key, Value value)` writeRecord writes a Value to the Filer based on the specified Key.

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

MemFiler

public MemFiler()

MemFiler

public MemFiler(Map hashTable,
                boolean readOnly)

MemFiler

public MemFiler(Map hashTable)

Method Detail

setLocation

public void setLocation(File root,
                        String location)

getName

public String getName()

Description copied from interface: Named

getName retrieves the contextually important name of the object

Specified by:: getName in interface Named

Returns:: The object's name

create

public boolean create()

Description copied from interface: DBObject

create creates a new DBObject and any associated resources for the new DBObject, such as disk files, etc.

Specified by:: create in interface DBObject

Returns:: Whether or not the DBObject was created

open

public boolean open()

Description copied from interface: DBObject

open opens the DBObject

Specified by:: open in interface DBObject

Returns:: Whether or not the DBObject was opened

isOpened

public boolean isOpened()

Description copied from interface: DBObject

isOpened returns whether or not the DBObject is opened for business.

Specified by:: isOpened in interface DBObject

Returns:: The open status of the DBObject

exists

public boolean exists()

Description copied from interface: DBObject

exists returns whether or not a physical representation of this DBObject actually exists. In the case of a HashFiler, this would check for the file, and in the case of an FTPFiler, it might perform a connection check.

Specified by:: exists in interface DBObject

Returns:: Whether or not the physical resource exists

drop

public boolean drop()

Description copied from interface: DBObject

drop instructs the DBObjectimplementation to remove itself from existence. The DBObject's parent is responsible for removing any references to the DBObject in its own context.

Specified by:: drop in interface DBObject

Returns:: Whether or not the DBObject was dropped

close

public boolean close()

Description copied from interface: DBObject

close closes the DBObject

Specified by:: close in interface DBObject

Returns:: Whether or not the DBObject was closed