com.helger.photon.basic.app.dao

Interface IDAO

All Superinterfaces:

IAutoSaveAware, IChangeable

All Known Subinterfaces:

IReloadableDAO

All Known Implementing Classes:

AbstractDAO, AbstractSimpleDAO, AbstractWALDAO, AccountingAreaManager, AuditManager, ClientManager, FavoriteManager, LongRunningJobResultManager, RoleManager, SystemMessageManager, SystemMigrationManager, UserGroupManager, UserManager

public interface IDAO
extends IChangeable, IAutoSaveAware

Base DAO interface. DAO = Data Access Object. A DAO implementation usually has 3 basic operations:

• Initialization - when no file exists and an initial setup can be performed.
• Reading - read existing data from a file
• Write - write modified data to a file

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	IDAO.EMode

Method Summary

Methods

Modifier and Type	Method and Description
int	getInitCount()
org.joda.time.DateTime	getLastInitDateTime()
org.joda.time.DateTime	getLastReadDateTime()
org.joda.time.DateTime	getLastWriteDateTime()
int	getReadCount()
int	getWriteCount()
void	writeToFileOnPendingChanges() This method is called to persist the content in disk in case there are pending changes.

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

hasPendingChanges

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

beginWithoutAutoSave, endWithoutAutoSave, isAutoSaveEnabled, performWithoutAutoSave, performWithoutAutoSave

Method Detail

writeToFileOnPendingChanges

void writeToFileOnPendingChanges()

This method is called to persist the content in disk in case there are pending changes. If no pending changes are present, nothing happens. In case the implementation is thread-safe, this method must be thread-safe!

getInitCount

@Nonnegative
int getInitCount()

Returns:

The number of times this DAO was initialized. Always ≥ 0. Usually this field is not persistent and only is valid until the application ends.

getLastInitDateTime

@Nullable
org.joda.time.DateTime getLastInitDateTime()

Returns:

The last time this DAO was initialized (without error). May be null if it wasn't read before. Usually this field is not persistent and only is valid until the application ends.

getReadCount

@Nonnegative
int getReadCount()

Returns:

The number of times this DAO was initialized. Always ≥ 0. Usually this field is not persistent and only is valid until the application ends.

getLastReadDateTime

@Nullable
org.joda.time.DateTime getLastReadDateTime()

Returns:

The last time this DAO was read (without error). May be null if it wasn't read before. Usually this field is not persistent and only is valid until the application ends.

getWriteCount

@Nonnegative
int getWriteCount()

Returns:

The number of times this DAO was initialized. Always ≥ 0. Usually this field is not persistent and only is valid until the application ends.

getLastWriteDateTime

@Nullable
org.joda.time.DateTime getLastWriteDateTime()

Returns:

The last time this DAO was written (without error). May be null if it wasn't written before. Usually this field is not persistent and only is valid until the application ends.