org.jminor.framework.db.local

Interface LocalEntityConnection

All Superinterfaces:

EntityConnection

public interface LocalEntityConnection
extends EntityConnection

EntityConnection implementation based on a local JDBC connection.

 Domain domain = new Domain();
 EntityConditions conditions = new EntityConditions(domain);
 Database database = new H2Database("pathToDb");
 User user = new User("scott", "tiger".toCharArray());

 EntityConnection connection = LocalEntityConnections.createConnection(domain, database, user);

 List<Entity> entities = connection.selectMany(conditions.selectCondition(Domain.ENTITY_ID));

 connection.disconnect();
 

Field Summary

Fields

Modifier and Type	Field and Description
static PropertyValue<java.lang.Integer>	CONNECTION_LOG_SIZE Specifies the size of the (circular) log that is kept in memory for each connection Value type: Integer Default value: 40
static int	DEFAULT_CONNECTION_LOG_SIZE
static PropertyValue<java.lang.Boolean>	LIMIT_FOREIGN_KEY_FETCH_DEPTH Specifies whether the foreign key value graph should be fully populated instead of being limited by the foreign key fetch depth setting. Value type: Boolean Default value: true
static PropertyValue<java.lang.Boolean>	USE_OPTIMISTIC_LOCKING Specifies whether optimistic locking should be performed, that is, if entities should be selected for update and checked for modification before being updated Value type: Boolean Default value: true

Method Summary

Modifier and Type	Method and Description
DatabaseConnection	getDatabaseConnection()
MethodLogger	getMethodLogger()
boolean	isLimitForeignKeyFetchDepth()
boolean	isOptimisticLocking()
ResultIterator<Entity>	iterator(EntitySelectCondition condition) Returns a result set iterator based on the given query condition, this iterator closes all underlying resources in case of an exception and when it finishes iterating.
void	setLimitForeignKeyFetchDepth(boolean limitForeignKeyFetchDepth)
void	setMethodLogger(MethodLogger methodLogger)
void	setOptimisticLocking(boolean optimisticLocking)

Methods inherited from interface org.jminor.framework.db.EntityConnection

beginTransaction, commitTransaction, delete, delete, disconnect, executeFunction, executeProcedure, fillReport, getDomain, getUser, insert, isConnected, isTransactionOpen, readBlob, rollbackTransaction, selectDependencies, selectMany, selectMany, selectMany, selectRowCount, selectSingle, selectSingle, selectSingle, selectValues, update, writeBlob

Field Detail

DEFAULT_CONNECTION_LOG_SIZE

static final int DEFAULT_CONNECTION_LOG_SIZE

See Also:

Constant Field Values

CONNECTION_LOG_SIZE

static final PropertyValue<java.lang.Integer> CONNECTION_LOG_SIZE

Specifies the size of the (circular) log that is kept in memory for each connection
Value type: Integer
Default value: 40

USE_OPTIMISTIC_LOCKING

static final PropertyValue<java.lang.Boolean> USE_OPTIMISTIC_LOCKING

Specifies whether optimistic locking should be performed, that is, if entities should be selected for update and checked for modification before being updated
Value type: Boolean
Default value: true

LIMIT_FOREIGN_KEY_FETCH_DEPTH

static final PropertyValue<java.lang.Boolean> LIMIT_FOREIGN_KEY_FETCH_DEPTH

Specifies whether the foreign key value graph should be fully populated instead of being limited by the foreign key fetch depth setting.
Value type: Boolean
Default value: true

Method Detail

setMethodLogger

void setMethodLogger(MethodLogger methodLogger)

Parameters:

methodLogger - the MethodLogger to use

getMethodLogger

MethodLogger getMethodLogger()

Returns:

the MethodLogger being used

getDatabaseConnection

DatabaseConnection getDatabaseConnection()

Returns:

the underlying connection

iterator

ResultIterator<Entity> iterator(EntitySelectCondition condition)
                         throws DatabaseException

Returns a result set iterator based on the given query condition, this iterator closes all underlying resources in case of an exception and when it finishes iterating. Calling ResultIterator.close() is required if the iterator has not been exhausted and is always recommended.

Parameters:

condition - the query condition

Returns:

an iterator for the given query condition

Throws:

DatabaseException - in case of an exception

isOptimisticLocking

boolean isOptimisticLocking()

Returns:

true if optimistic locking is enabled

setOptimisticLocking

void setOptimisticLocking(boolean optimisticLocking)

Parameters:

optimisticLocking - true if optimistic locking should be enabled

isLimitForeignKeyFetchDepth

boolean isLimitForeignKeyFetchDepth()

Returns:

true if foreign key fetch depths are being limited

setLimitForeignKeyFetchDepth

void setLimitForeignKeyFetchDepth(boolean limitForeignKeyFetchDepth)

Parameters:

limitForeignKeyFetchDepth - false to override the fetch depth limit provided by condition

See Also:

EntitySelectCondition.setForeignKeyFetchDepthLimit(int)