Package net.solarnetwork.central.common.dao.jdbc

Class BulkLoadingDaoSupport.BulkLoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>

java.lang.Object

net.solarnetwork.central.common.dao.jdbc.BulkLoadingDaoSupport.BulkLoadingContext<T,PK>

Type Parameters:

T - the entity type

PK - the primary key type

All Implemented Interfaces:

AutoCloseable, BulkLoadingDao.LoadingContext<T,PK>

Enclosing class:

BulkLoadingDaoSupport

public abstract class BulkLoadingDaoSupport.BulkLoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>
extends Object
implements BulkLoadingDao.LoadingContext<T,PK>

Abstract implementation of a bulk loading context.

This class implements the majority of a bulk loading context. Extending classes must override doLoad(Entity, PreparedStatement, long) to perform the actual loading of an entity.

Constructor Summary

Constructors

Constructor	Description
BulkLoadingContext(BulkLoadingDao.LoadingOptions options, BulkLoadingDao.LoadingExceptionHandler<T,PK> exceptionHandler)

Method Summary

Modifier and Type	Method	Description
void	close()	Close any temporary resources.
void	commit()	Commit the current transaction.
void	createCheckpoint()	Create a checkpoint that can be rolled back to.
protected abstract boolean	doLoad(T entity, PreparedStatement stmt, long index)
long	getCommittedCount()	Get the count of entities committed thus far using this context.
T	getLastLoadedEntity()	Get the entity that was last passed to the BulkLoadingDao.LoadingContext.load(Entity) method.
long	getLoadedCount()	Get the count of entities loaded thus far using this context.
BulkLoadingDao.LoadingOptions	getOptions()	Get the loading options used to create the context.
final void	load(T entity)	Load an entity.
void	rollback()	Discard the entities loaded within the current transaction.

Methods inherited from class java.lang.Object

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

Constructor Details

BulkLoadingContext

public BulkLoadingContext(BulkLoadingDao.LoadingOptions options,
 BulkLoadingDao.LoadingExceptionHandler<T,PK> exceptionHandler)
                   throws SQLException

Throws:

SQLException

Method Details

getOptions

public BulkLoadingDao.LoadingOptions getOptions()

Description copied from interface: BulkLoadingDao.LoadingContext

Get the loading options used to create the context.

Specified by:

getOptions in interface BulkLoadingDao.LoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>

Returns:

the loading options

getLoadedCount

public long getLoadedCount()

Description copied from interface: BulkLoadingDao.LoadingContext

Get the count of entities loaded thus far using this context.

If BulkLoadingDao.LoadingContext.rollback() is called, this value will reset back to the count of currently committed entities.

Specified by:

getLoadedCount in interface BulkLoadingDao.LoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>

Returns:

the loaded count

getCommittedCount

public long getCommittedCount()

Description copied from interface: BulkLoadingDao.LoadingContext

Get the count of entities committed thus far using this context.

How this value increments depends on the BulkLoadingDao.LoadingTransactionMode defined in the options that were used to create this context:

BulkLoadingDao.LoadingTransactionMode.NoTransaction

This count will match BulkLoadingDao.LoadingContext.getLoadedCount() and increment as each entity is loaded.

BulkLoadingDao.LoadingTransactionMode.BatchTransactions

This count will increment only after each batch of loaded entity have been committed, and thus can lag behind BulkLoadingDao.LoadingContext.getLoadedCount().

BulkLoadingDao.LoadingTransactionMode.TransactionCheckpoints

This count will only increment after calls to BulkLoadingDao.LoadingContext.createCheckpoint() are made. If BulkLoadingDao.LoadingContext.rollback() is called, this count will reset back to the count at the previous time BulkLoadingDao.LoadingContext.createCheckpoint() was called.

BulkLoadingDao.LoadingTransactionMode.SingleTransaction

This count will remain at 0 until BulkLoadingDao.LoadingContext.commit() is called, at which point it will match BulkLoadingDao.LoadingContext.getLoadedCount().

Specified by:

getCommittedCount in interface BulkLoadingDao.LoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>

Returns:

the committed entity count

getLastLoadedEntity

public T getLastLoadedEntity()

Description copied from interface: BulkLoadingDao.LoadingContext

Get the entity that was last passed to the BulkLoadingDao.LoadingContext.load(Entity) method.

Specified by:

getLastLoadedEntity in interface BulkLoadingDao.LoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>

Returns:

the last loaded entity

load

public final void load(T entity)

Description copied from interface: BulkLoadingDao.LoadingContext

Load an entity.

Specified by:

load in interface BulkLoadingDao.LoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>

Parameters:

entity - the entity to load

doLoad

protected abstract boolean doLoad(T entity,
 PreparedStatement stmt,
 long index)
                           throws SQLException

Throws:

SQLException

createCheckpoint

public void createCheckpoint()

Description copied from interface: BulkLoadingDao.LoadingContext

Create a checkpoint that can be rolled back to.

The BulkLoadingDao.LoadingTransactionMode.TransactionCheckpoints mode must have been set in the options used to create this context.

Specified by:

createCheckpoint in interface BulkLoadingDao.LoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>

commit

public void commit()

Description copied from interface: BulkLoadingDao.LoadingContext

Commit the current transaction.

The nature of the current transaction depends on the transaction mode set in the options used to create this context:

TransactionCheckpoints or SingleTransaction

All entities loaded via BulkLoadingDao.LoadingContext.load(Entity) are committed.

BatchTransactions

The entities loaded via BulkLoadingDao.LoadingContext.load(Entity) since the last automatic batch commit are committed.

Specified by:

commit in interface BulkLoadingDao.LoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>

rollback

public void rollback()

Description copied from interface: BulkLoadingDao.LoadingContext

Discard the entities loaded within the current transaction.

The nature of the current transaction depends on the transaction mode set in the options used to create this context:

SingleTransaction

All entities loaded are discarded.

TransactionCheckpoints

All entities loaded via BulkLoadingDao.LoadingContext.load(Entity) since the last call to BulkLoadingDao.LoadingContext.createCheckpoint() are discarded.

BatchTransactions

The entities loaded via BulkLoadingDao.LoadingContext.load(Entity) since the last automatic batch commit are discarded.

Specified by:

rollback in interface BulkLoadingDao.LoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>

close

public void close()

Description copied from interface: BulkLoadingDao.LoadingContext

Close any temporary resources.

Specified by:

close in interface AutoCloseable

Specified by:

close in interface BulkLoadingDao.LoadingContext<T extends net.solarnetwork.dao.Entity<PK>,PK extends Serializable>