iot.jcypher.database

Interface IDBAccess

All Known Subinterfaces:

IDBAccessInit

All Known Implementing Classes:

AbstractEmbeddedDBAccess, EmbeddedDBAccess, InMemoryDBAccess, RemoteDBAccess

public interface IDBAccess

Provides access to a graph database.

Method Summary

Methods

Modifier and Type	Method and Description
ITransaction	beginTX() create a transaction
List<JcError>	clearDatabase() removes all nodes and relations form the graph database
void	close() close the database connection
JcQueryResult	execute(JcQuery query) execute a query against a database
List<JcQueryResult>	execute(List<JcQuery> queries) execute a list of queries against a database
DBType	getDBType() Answer the type of database access (REMOTE, EMBEDDED, IN_MEMORY)
ITransaction	getTX() Answer the transaction which was opened in the context of the current thread.
boolean	isDatabaseEmpty()

Method Detail

execute

JcQueryResult execute(JcQuery query)

execute a query against a database

Parameters:

query - a JcQuery

Returns:

a JcQueryResult

execute

List<JcQueryResult> execute(List<JcQuery> queries)

execute a list of queries against a database

Parameters:

queries -

Returns:

a list of 'JcQueryResult's

clearDatabase

List<JcError> clearDatabase()

removes all nodes and relations form the graph database

Returns:

a list of errors which is empty if no errors occurred

beginTX

ITransaction beginTX()

create a transaction

Returns:

an instance of ITransaction

getTX

ITransaction getTX()

Answer the transaction which was opened in the context of the current thread. Answer null if currently there is no open transaction for the current thread.

Returns:

isDatabaseEmpty

boolean isDatabaseEmpty()

Returns:

true if not a single node or relation is contained in the graph database

getDBType

DBType getDBType()

Answer the type of database access (REMOTE, EMBEDDED, IN_MEMORY)

Returns:

a DBType

close

void close()

close the database connection