com.helger.photon.basic.app.dao.impl

Class AbstractDAO

java.lang.Object

com.helger.photon.basic.app.dao.impl.AbstractDAO

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO

Direct Known Subclasses:

AbstractSimpleDAO, AbstractWALDAO

@ThreadSafe
public abstract class AbstractDAO
extends Object
implements IDAO

Base implementation of IDAO

Author:

Philip Helger

Nested Class Summary

Nested classes/interfaces inherited from interface com.helger.photon.basic.app.dao.IDAO

IDAO.EMode

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_AUTO_SAVE_ENABLED By default auto-save is enabled
protected com.helger.commons.concurrent.SimpleReadWriteLock	m_aRWLock

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractDAO()

Method Summary

Modifier and Type	Method and Description
void	beginWithoutAutoSave() Start doing something without auto save.
void	endWithoutAutoSave() End doing something without auto save.
static com.helger.commons.callback.CallbackList<IDAOReadExceptionCallback>	getExceptionHandlersRead()
static com.helger.commons.callback.CallbackList<IDAOWriteExceptionCallback>	getExceptionHandlersWrite()
boolean	hasPendingChanges()
boolean	internalHasPendingChanges()
protected boolean	internalIsAutoSaveEnabled()
void	internalSetPendingChanges(boolean bPendingChanges)
boolean	isAutoSaveEnabled()
protected static boolean	isDebugLogging()
void	performWithoutAutoSave(Runnable aRunnable) Execute a callback with autosave being disabled.
<RETURNTYPE> RETURNTYPE	performWithoutAutoSave(Supplier<RETURNTYPE> aCallable) Execute a callback with autosave being disabled.
<EXTYPE extends Exception> void	performWithoutAutoSaveThrowing(com.helger.commons.callback.IThrowingRunnable<EXTYPE> aRunnable) Execute a callback with autosave being disabled.
<RETURNTYPE,EXTYPE extends Exception> RETURNTYPE	performWithoutAutoSaveThrowing(com.helger.commons.function.IThrowingSupplier<RETURNTYPE,EXTYPE> aCallable) Execute a callback with autosave being disabled.
String	toString()

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.photon.basic.app.dao.IDAO

getInitCount, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getWriteCount, writeToFileOnPendingChanges

Field Detail

DEFAULT_AUTO_SAVE_ENABLED

public static final boolean DEFAULT_AUTO_SAVE_ENABLED

By default auto-save is enabled

See Also:

Constant Field Values

m_aRWLock

protected final com.helger.commons.concurrent.SimpleReadWriteLock m_aRWLock

Constructor Detail

AbstractDAO

protected AbstractDAO()

Method Detail

isDebugLogging

protected static final boolean isDebugLogging()

getExceptionHandlersRead

@Nonnull
 @ReturnsMutableObject(value="design")
public static final com.helger.commons.callback.CallbackList<IDAOReadExceptionCallback> getExceptionHandlersRead()

getExceptionHandlersWrite

@Nonnull
 @ReturnsMutableObject(value="design")
public static final com.helger.commons.callback.CallbackList<IDAOWriteExceptionCallback> getExceptionHandlersWrite()

internalIsAutoSaveEnabled

@MustBeLocked(value=READ)
protected final boolean internalIsAutoSaveEnabled()

Returns:

true if auto save is enabled, false otherwise.

isAutoSaveEnabled

public final boolean isAutoSaveEnabled()

Specified by:

isAutoSaveEnabled in interface IAutoSaveAware

Returns:

true if auto save is enabled, false otherwise.

internalSetPendingChanges

@MustBeLocked(value=WRITE)
public final void internalSetPendingChanges(boolean bPendingChanges)

internalHasPendingChanges

@MustBeLocked(value=READ)
public final boolean internalHasPendingChanges()

Returns:

true if unsaved changes are present

hasPendingChanges

public final boolean hasPendingChanges()

Specified by:

hasPendingChanges in interface IChangeable

Returns:

true if unsaved changes are present

beginWithoutAutoSave

public final void beginWithoutAutoSave()

Description copied from interface: IAutoSaveAware

Start doing something without auto save.

Specified by:

beginWithoutAutoSave in interface IAutoSaveAware

endWithoutAutoSave

public final void endWithoutAutoSave()

Description copied from interface: IAutoSaveAware

End doing something without auto save. It must be ensure that each call to IAutoSaveAware.beginWithoutAutoSave() is always correctly ended with a call to this method.

Specified by:

endWithoutAutoSave in interface IAutoSaveAware

performWithoutAutoSave

public final void performWithoutAutoSave(@Nonnull
                                         Runnable aRunnable)

Execute a callback with autosave being disabled. Must be called outside a writeLock, as this method locks itself!

Specified by:

performWithoutAutoSave in interface IAutoSaveAware

Parameters:

aRunnable - The callback to be executed

performWithoutAutoSave

@Nullable
public final <RETURNTYPE> RETURNTYPE performWithoutAutoSave(@Nonnull
                                                                       Supplier<RETURNTYPE> aCallable)

Execute a callback with autosave being disabled. Must be called outside a writeLock, as this method locks itself!

Specified by:

performWithoutAutoSave in interface IAutoSaveAware

Type Parameters:

RETURNTYPE - Return type of the callable

Parameters:

aCallable - The callback to be executed

Returns:

The result of the callback. May be null.

performWithoutAutoSaveThrowing

public final <EXTYPE extends Exception> void performWithoutAutoSaveThrowing(@Nonnull
                                                                            com.helger.commons.callback.IThrowingRunnable<EXTYPE> aRunnable)
                                                                     throws EXTYPE extends Exception

Execute a callback with autosave being disabled. Must be called outside a writeLock, as this method locks itself!

Type Parameters:

EXTYPE - Exception type that may be thrown

Parameters:

aRunnable - The callback to be executed

Throws:

EXTYPE - In case of an error

EXTYPE extends Exception

performWithoutAutoSaveThrowing

@Nullable
public final <RETURNTYPE,EXTYPE extends Exception> RETURNTYPE performWithoutAutoSaveThrowing(@Nonnull
                                                                                                        com.helger.commons.function.IThrowingSupplier<RETURNTYPE,EXTYPE> aCallable)
                                                                                                 throws EXTYPE extends Exception

Execute a callback with autosave being disabled. Must be called outside a writeLock, as this method locks itself!

Type Parameters:

RETURNTYPE - Return type of the callable

EXTYPE - Exception type that may be thrown

Parameters:

aCallable - The callback to be executed

Returns:

The result of the callback. May be null.

Throws:

EXTYPE - In case of an error

EXTYPE extends Exception

toString

public String toString()

Overrides:

toString in class Object