com.devsmart.microdb

Class MicroDB

java.lang.Object

com.devsmart.microdb.MicroDB

public class MicroDB
extends java.lang.Object

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	MicroDB.Constructor<T extends DBObject>
static class	MicroDB.OperationType

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ChangeListener listener)
<T extends java.lang.Comparable<T>> void	addIndex(java.lang.String indexName, MapFunction<T> mapFunction)
void	close()
com.devsmart.microdb.MicroDB.Operation	commit()
void	compact()
<T extends DBObject> T	create(java.lang.Class<T> classType) Constructs a new proxy instance of classType
com.devsmart.microdb.MicroDB.Operation	delete(DBObject obj)
protected void	finalize()
protected void	finalizing(DBObject obj) called when a dbobject is being finalized by the GC
void	flush() Saves all DBObjects that are marked dirty
com.devsmart.ubjson.UBValue	get(java.lang.String key)
<T extends DBObject> T	get(java.util.UUID id)
<T extends DBObject> T	get(java.util.UUID id, T shell) fetch and load database object with primary key id.
<T extends DBObject> java.lang.Iterable<T>	getAllOfType(java.lang.Class<T> classType)
Driver	getDriver()
<T extends DBObject> T	insert(java.lang.Class<T> classType) creates and inserts into the database a new object of type classType.
<T extends java.lang.Comparable<T>> Cursor	queryIndex(java.lang.String indexName, T min, boolean minInclusive, T max, boolean maxInclusive)
com.devsmart.microdb.MicroDB.Operation	save(DBObject obj) saves/updates obj to the database.
com.devsmart.microdb.MicroDB.Operation	save(java.lang.String key, com.devsmart.ubjson.UBValue data)
void	shutdown()
void	sync() This method blocks until all queued write operation are completed.
void	waitForCompletion(com.devsmart.microdb.MicroDB.Operation op)

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

finalize

protected void finalize()
                 throws java.lang.Throwable

Overrides:

finalize in class java.lang.Object

Throws:

java.lang.Throwable

shutdown

public void shutdown()

getDriver

public Driver getDriver()

finalizing

protected void finalizing(DBObject obj)

called when a dbobject is being finalized by the GC

Parameters:

obj -

close

public void close()
           throws java.io.IOException

Throws:

java.io.IOException

flush

public void flush()

Saves all DBObjects that are marked dirty

insert

public <T extends DBObject> T insert(java.lang.Class<T> classType)

creates and inserts into the database a new object of type classType.

Type Parameters:

T -

Parameters:

classType -

Returns:

newly created object

create

public <T extends DBObject> T create(java.lang.Class<T> classType)

Constructs a new proxy instance of classType

Type Parameters:

T -

Parameters:

classType -

Returns:

a new object of type T

get

public <T extends DBObject> T get(java.util.UUID id)

get

public <T extends DBObject> T get(java.util.UUID id,
                                  T shell)

fetch and load database object with primary key id.

Type Parameters:

T -

Parameters:

id -

shell - new object of type

Returns:

dbobject

get

public com.devsmart.ubjson.UBValue get(java.lang.String key)
                                throws java.io.IOException

Throws:

java.io.IOException

save

public com.devsmart.microdb.MicroDB.Operation save(DBObject obj)

saves/updates obj to the database. This method is not normally necessary for users to call because database objects will automatically be saved when the garbage collector collects them if they are marked dirty.

Parameters:

obj - the data to be saved

save

public com.devsmart.microdb.MicroDB.Operation save(java.lang.String key,
                                                   com.devsmart.ubjson.UBValue data)

delete

public com.devsmart.microdb.MicroDB.Operation delete(DBObject obj)

commit

public com.devsmart.microdb.MicroDB.Operation commit()

waitForCompletion

public void waitForCompletion(com.devsmart.microdb.MicroDB.Operation op)

sync

public void sync()

This method blocks until all queued write operation are completed.

compact

public void compact()

addIndex

public <T extends java.lang.Comparable<T>> void addIndex(java.lang.String indexName,
                                                         MapFunction<T> mapFunction)
                                                  throws java.io.IOException

Throws:

java.io.IOException

addChangeListener

public void addChangeListener(ChangeListener listener)

queryIndex

public <T extends java.lang.Comparable<T>> Cursor queryIndex(java.lang.String indexName,
                                                             T min,
                                                             boolean minInclusive,
                                                             T max,
                                                             boolean maxInclusive)
                                                      throws java.io.IOException

Throws:

java.io.IOException

getAllOfType

public <T extends DBObject> java.lang.Iterable<T> getAllOfType(java.lang.Class<T> classType)
                                                        throws java.io.IOException

Throws:

java.io.IOException