Produced by Siminov Software Solution

siminov.orm.database
Interface IDatabase

All Known Implementing Classes:
SQLiteDatabaseImpl

public interface IDatabase

Exposes methods to deal with actual database object. It has methods to open, create, close, and execute query's.


Method Summary
 void close(DatabaseDescriptor databaseDescriptor)
          Close the existing opened database through Database Descriptor.
 void executeBindQuery(DatabaseDescriptor databaseDescriptor, DatabaseMappingDescriptor databaseMappingDescriptor, java.lang.String query, java.util.Iterator<java.lang.Object> columnValues)
          A pre-compiled statement that can be reused.
 java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> executeFetchQuery(DatabaseDescriptor databaseDescriptor, DatabaseMappingDescriptor databaseMappingDescriptor, java.lang.String query)
          Query the given table, returning a Cursor over the result set.
 void executeMethod(java.lang.String methodName, java.lang.Object parameters)
          Executes the method on database object.
 void executeQuery(DatabaseDescriptor databaseDescriptor, DatabaseMappingDescriptor databaseMappingDescriptor, java.lang.String query)
          Execute a single SQL statement that is NOT a SELECT or any other SQL statement that returns data.
 void openOrCreate(DatabaseDescriptor databaseDescriptor)
          Open/Create the database through Database Descriptor.
 

Method Detail

openOrCreate

void openOrCreate(DatabaseDescriptor databaseDescriptor)
                  throws DatabaseException
Open/Create the database through Database Descriptor.

By default add CREATE_IF_NECESSARY flag so that if database does not exist it will create.

Parameters:
databaseMappings - Database-Descriptor object which defines the schema of database.
Throws:
DatabaseException - If the database cannot be opened or create.

close

void close(DatabaseDescriptor databaseDescriptor)
           throws DatabaseException
Close the existing opened database through Database Descriptor.

Parameters:
databaseMappings - Database-Descriptor object which defines the schema of database.
Throws:
DatabaseException - If the database cannot be closed.

executeQuery

void executeQuery(DatabaseDescriptor databaseDescriptor,
                  DatabaseMappingDescriptor databaseMappingDescriptor,
                  java.lang.String query)
                  throws DatabaseException
Execute a single SQL statement that is NOT a SELECT or any other SQL statement that returns data.

It has no means to return any data (such as the number of affected rows). Instead, you're encouraged to use insert, update, delete, when possible.

Parameters:
databaseMappings - Database-Descriptor object which defines the schema of database.
databaseMappingDescriptor - Database-Mapping-Descriptor object which defines the structure of table.
query - Query which needs to be executed.
Throws:
DatabaseException - If any error occur while executing query provided.

executeBindQuery

void executeBindQuery(DatabaseDescriptor databaseDescriptor,
                      DatabaseMappingDescriptor databaseMappingDescriptor,
                      java.lang.String query,
                      java.util.Iterator<java.lang.Object> columnValues)
                      throws DatabaseException
A pre-compiled statement that can be reused. The statement cannot return multiple rows, but 1x1 result sets are allowed.

Parameters:
databaseMappings - Database-Descriptor object which defines the schema of database.
databaseMappingDescriptor - Database-Mapping-Descriptor object which defines the structure of table.
query - A pre-compiled statement.
columnValues - Column values
Throws:
DatabaseException - If any error occur while inserting or updating tuple.

executeFetchQuery

java.util.Iterator<java.util.Map<java.lang.String,java.lang.Object>> executeFetchQuery(DatabaseDescriptor databaseDescriptor,
                                                                                       DatabaseMappingDescriptor databaseMappingDescriptor,
                                                                                       java.lang.String query)
                                                                                       throws DatabaseException
Query the given table, returning a Cursor over the result set.

Parameters:
databaseMappings - Database-Descriptor object which defines the schema of database.
databaseMappingDescriptor - Database-Mapping-Descriptor object which defines the structure of table.
query - Query based on which tuples will be fetched from database.
Returns:
A Cursor object, which is positioned before the first entry. Note that Cursors are not synchronized, see the documentation for more details.
Throws:
DatabaseException - If any error occur while getting tuples from a single table.

executeMethod

void executeMethod(java.lang.String methodName,
                   java.lang.Object parameters)
                   throws DatabaseException
Executes the method on database object.

Parameters:
methodName - Name Of Database Method.
parameters - Parameters Needed By Database Method.
Throws:
DatabaseException - If any exeception occur which invoking method in database object.

Apache License 2.0

Copyright 2013