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

Class AbstractMapBasedWALDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable,IMPLTYPE extends INTERFACETYPE>

java.lang.Object

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

com.helger.photon.basic.app.dao.impl.AbstractWALDAO<IMPLTYPE>

com.helger.photon.basic.app.dao.impl.AbstractMapBasedWALDAO<INTERFACETYPE,IMPLTYPE>

Type Parameters:

INTERFACETYPE - Interface type to be handled

IMPLTYPE - Implementation type to be handled

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO, IMapBasedDAO<INTERFACETYPE>

Direct Known Subclasses:

LongRunningJobResultManager

@ThreadSafe
public abstract class AbstractMapBasedWALDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable,IMPLTYPE extends INTERFACETYPE>
extends AbstractWALDAO<IMPLTYPE>
implements IMapBasedDAO<INTERFACETYPE>

Base class for WAL based DAO that uses a simple ICommonsMap for data storage.

Author:

Philip Helger

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	AbstractMapBasedWALDAO.InitSettings<IMPLTYPE> Extensible constructor parameter builder.

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

IDAO.EMode

Field Summary

Fields

Modifier and Type	Field and Description
protected static String	ELEMENT_ITEM
protected static String	ELEMENT_ROOT

Fields inherited from class com.helger.photon.basic.app.dao.impl.AbstractWALDAO

DEFAULT_WAITING_TIME, WAL_XWS, WRITE_XWS

Fields inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

DEFAULT_AUTO_SAVE_ENABLED, m_aRWLock

Constructor Summary

Constructors

Constructor and Description
AbstractMapBasedWALDAO(Class<IMPLTYPE> aImplClass, String sFilename) Default constructor.
AbstractMapBasedWALDAO(Class<IMPLTYPE> aImplClass, String sFilename, AbstractMapBasedWALDAO.InitSettings<IMPLTYPE> aInitSettings)

Method Summary

Modifier and Type	Method and Description
boolean	containsAllIDs(Iterable<String> aIDs)
boolean	containsAny()
boolean	containsAny(Predicate<? super INTERFACETYPE> aFilter)
boolean	containsNone()
boolean	containsNone(Predicate<? super INTERFACETYPE> aFilter)
boolean	containsOnly(Predicate<? super INTERFACETYPE> aFilter)
boolean	containsWithID(String sID)
protected com.helger.xml.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
void	findAll(Predicate<? super INTERFACETYPE> aFilter, Consumer<? super INTERFACETYPE> aConsumer)
<RETTYPE> void	findAllMapped(Predicate<? super INTERFACETYPE> aFilter, Function<? super INTERFACETYPE,? extends RETTYPE> aMapper, Consumer<? super RETTYPE> aConsumer)
INTERFACETYPE	findFirst(Predicate<? super INTERFACETYPE> aFilter)
<RETTYPE> RETTYPE	findFirstMapped(Predicate<? super INTERFACETYPE> aFilter, Function<? super INTERFACETYPE,? extends RETTYPE> aMapper)
void	forEach(BiConsumer<? super String,? super INTERFACETYPE> aConsumer)
void	forEach(BiPredicate<? super String,? super INTERFACETYPE> aFilter, BiConsumer<? super String,? super INTERFACETYPE> aConsumer)
void	forEachKey(Consumer<? super String> aConsumer)
void	forEachKey(Predicate<? super String> aFilter, Consumer<? super String> aConsumer)
void	forEachValue(Consumer<? super INTERFACETYPE> aConsumer)
void	forEachValue(Predicate<? super INTERFACETYPE> aFilter, Consumer<? super INTERFACETYPE> aConsumer)
com.helger.commons.collection.ext.ICommonsList<INTERFACETYPE>	getAll()
com.helger.commons.collection.ext.ICommonsList<INTERFACETYPE>	getAll(Predicate<? super INTERFACETYPE> aFilter)
com.helger.commons.collection.ext.ICommonsSet<String>	getAllIDs()
<RETTYPE> com.helger.commons.collection.ext.ICommonsList<RETTYPE>	getAllMapped(Predicate<? super INTERFACETYPE> aFilter, Function<? super INTERFACETYPE,? extends RETTYPE> aMapper)
protected Collection<IMPLTYPE>	getAllSortedByKey()
protected INTERFACETYPE	getAtIndex(int nIndex) Get the item at the specified index.
com.helger.commons.callback.CallbackList<IDAOChangeCallback<INTERFACETYPE>>	getCallbacks()
int	getCount()
int	getCount(Predicate<? super INTERFACETYPE> aFilter)
<T> com.helger.commons.collection.ext.ICommonsList<T>	getNone()
protected IMPLTYPE	getOfID(String sID)
protected IMPLTYPE	getOfIDLocked(String sID)
protected IMPLTYPE	internalCreateItem(IMPLTYPE aNewItem) Add an item including invoking the callback
protected IMPLTYPE	internalDeleteItem(String sID) Delete the item by removing it from the map.
protected Iterable<IMPLTYPE>	internalDirectGetAll()
protected void	internalForEachValue(Consumer<? super IMPLTYPE> aConsumer)
protected void	internalForEachValue(Predicate<? super IMPLTYPE> aFilter, Consumer<? super IMPLTYPE> aConsumer)
protected com.helger.commons.collection.ext.ICommonsList<IMPLTYPE>	internalGetAll(Predicate<? super IMPLTYPE> aFilter)
protected void	internalMarkItemDeleted(IMPLTYPE aItem) Mark an item as "deleted" without actually deleting it from the map.
protected void	internalMarkItemUndeleted(IMPLTYPE aItem) Mark an item as "no longer deleted" without actually adding it to the map.
protected com.helger.commons.state.EChange	internalRemoveAllItemsNoCallback() Remove all items without triggering any callback.
protected void	internalUpdateItem(IMPLTYPE aItem) Update and existing item including invoking the callback
protected void	markAsChanged(IMPLTYPE aModifiedElement, EDAOActionType eActionType) Deprecated.
protected com.helger.commons.state.EChange	onRead(com.helger.xml.microdom.IMicroDocument aDoc) Fill the internal structures with from the passed XML document.
protected void	onRecoveryCreate(IMPLTYPE aItem) Called when a recovery is needed to create a new item.
protected void	onRecoveryDelete(IMPLTYPE aItem) Called when a recovery is needed to delete an existing item.
protected void	onRecoveryUpdate(IMPLTYPE aItem) Called when a recovery is needed to update an existing item.
String	toString()

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractWALDAO

convertNativeToWALString, convertWALStringToNative, getDAOIO, getDataTypeClass, getFilenameProvider, getInitCount, getLastFilename, getLastInitDateTime, getLastReadDateTime, getLastWriteDateTime, getReadCount, getSafeFile, getWaitingTime, getWALXMLWriterSettings, getWriteCount, getXMLWriterSettings, initialRead, markAsChanged, modifyWriteData, onBetweenReadAndWAL, onFilenameChange, onInit, setWaitingTime, triggerExceptionHandlersRead, triggerExceptionHandlersWrite, writeToFileOnPendingChanges

Methods inherited from class com.helger.photon.basic.app.dao.impl.AbstractDAO

beginWithoutAutoSave, endWithoutAutoSave, getExceptionHandlersRead, getExceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, isDebugLogging, performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSaveThrowing, performWithoutAutoSaveThrowing

Methods inherited from class java.lang.Object

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

Field Detail

ELEMENT_ROOT

protected static final String ELEMENT_ROOT

See Also:

Constant Field Values

ELEMENT_ITEM

protected static final String ELEMENT_ITEM

See Also:

Constant Field Values

Constructor Detail

AbstractMapBasedWALDAO

public AbstractMapBasedWALDAO(@Nonnull
                              Class<IMPLTYPE> aImplClass,
                              @Nullable
                              String sFilename)
                       throws DAOException

Default constructor. Automatically tries to read the file in the constructor.

Parameters:

aImplClass - Implementation class. May not be null.

sFilename - The filename to read and write.

Throws:

DAOException - If reading and reading fails

AbstractMapBasedWALDAO

public AbstractMapBasedWALDAO(@Nonnull
                              Class<IMPLTYPE> aImplClass,
                              @Nullable
                              String sFilename,
                              @Nonnull
                              AbstractMapBasedWALDAO.InitSettings<IMPLTYPE> aInitSettings)
                       throws DAOException

Throws:

DAOException

Method Detail

onRecoveryCreate

protected void onRecoveryCreate(@Nonnull
                                IMPLTYPE aItem)

Description copied from class: AbstractWALDAO

Called when a recovery is needed to create a new item.

Specified by:

onRecoveryCreate in class AbstractWALDAO<IMPLTYPE extends INTERFACETYPE>

Parameters:

aItem - The element to be created. Never null.

onRecoveryUpdate

protected void onRecoveryUpdate(@Nonnull
                                IMPLTYPE aItem)

Description copied from class: AbstractWALDAO

Called when a recovery is needed to update an existing item.

Specified by:

onRecoveryUpdate in class AbstractWALDAO<IMPLTYPE extends INTERFACETYPE>

Parameters:

aItem - The element to be updated. Never null.

onRecoveryDelete

protected void onRecoveryDelete(@Nonnull
                                IMPLTYPE aItem)

Description copied from class: AbstractWALDAO

Called when a recovery is needed to delete an existing item.

Specified by:

onRecoveryDelete in class AbstractWALDAO<IMPLTYPE extends INTERFACETYPE>

Parameters:

aItem - The element to be deleted. Never null.

onRead

@Nonnull
protected com.helger.commons.state.EChange onRead(@Nonnull
                                                            com.helger.xml.microdom.IMicroDocument aDoc)

Description copied from class: AbstractWALDAO

Fill the internal structures with from the passed XML document. This method is only called within a write lock!

Specified by:

onRead in class AbstractWALDAO<IMPLTYPE extends INTERFACETYPE>

Parameters:

aDoc - The XML document to read from. Never null.

Returns:

EChange.CHANGED if reading the data changed something in the internal structures that requires a writing.

getAllSortedByKey

@MustBeLocked(value=READ)
 @CodingStyleguideUnaware
protected final Collection<IMPLTYPE> getAllSortedByKey()

createWriteData

@Nonnull
protected com.helger.xml.microdom.IMicroDocument createWriteData()

Description copied from class: AbstractWALDAO

Create the XML document that should be saved to the file. This method is only called within a write lock!

Specified by:

createWriteData in class AbstractWALDAO<IMPLTYPE extends INTERFACETYPE>

Returns:

The non-null document to write to the file.

getCallbacks

@Nonnull
 @ReturnsMutableObject(value="design")
public com.helger.commons.callback.CallbackList<IDAOChangeCallback<INTERFACETYPE>> getCallbacks()

markAsChanged

@MustBeLocked(value=WRITE)
 @OverridingMethodsMustInvokeSuper
 @Deprecated
 @DevelopersNote(value="Avoid that this method is overridden!")
protected final void markAsChanged(@Nonnull
                                                                                                                                                                                  IMPLTYPE aModifiedElement,
                                                                                                                                                                                  @Nonnull
                                                                                                                                                                                  EDAOActionType eActionType)

Deprecated.

Description copied from class: AbstractWALDAO

This method must be called every time something changed in the DAO. It triggers the writing to a file if auto-save is active. This method must be called within a write-lock as it is not locked!

Overrides:

markAsChanged in class AbstractWALDAO<IMPLTYPE extends INTERFACETYPE>

Parameters:

aModifiedElement - The modified data element. May not be null.

eActionType - The action that was performed. May not be null.

internalCreateItem

@MustBeLocked(value=WRITE)
protected final IMPLTYPE internalCreateItem(@Nonnull
                                                                        IMPLTYPE aNewItem)

Add an item including invoking the callback

Parameters:

aNewItem - The item to be added. May not be null.

Returns:

The passed parameter as-is

Throws:

IllegalArgumentException - If an item with the same ID is already contained

internalUpdateItem

@MustBeLocked(value=WRITE)
protected final void internalUpdateItem(@Nonnull
                                                                    IMPLTYPE aItem)

Update and existing item including invoking the callback

Parameters:

aItem - The item to be updated. May not be null.

Throws:

IllegalArgumentException - If no item with the same ID is already contained

internalDeleteItem

@MustBeLocked(value=WRITE)
 @Nullable
protected final IMPLTYPE internalDeleteItem(@Nullable
                                                                                    String sID)

Delete the item by removing it from the map. If something was remove the onDeleteItem callback is invoked.

Parameters:

sID - The ID to be removed. May be null.

Returns:

The deleted item. If null no such item was found and therefore nothing was removed.

internalMarkItemDeleted

@MustBeLocked(value=WRITE)
protected final void internalMarkItemDeleted(@Nonnull
                                                                         IMPLTYPE aItem)

Mark an item as "deleted" without actually deleting it from the map. This method only triggers the update action but does not alter the item.

Parameters:

aItem - The item that was marked as "deleted"

internalMarkItemUndeleted

@MustBeLocked(value=WRITE)
protected final void internalMarkItemUndeleted(@Nonnull
                                                                           IMPLTYPE aItem)

Mark an item as "no longer deleted" without actually adding it to the map. This method only triggers the update action but does not alter the item.

Parameters:

aItem - The item that was marked as "no longer deleted"

internalRemoveAllItemsNoCallback

@MustBeLocked(value=WRITE)
 @Nonnull
protected final com.helger.commons.state.EChange internalRemoveAllItemsNoCallback()

Remove all items without triggering any callback.

Returns:

EChange.CHANGED if something was contained, EChange.UNCHANGED otherwise.

getNone

@Nonnull
 @ReturnsMutableCopy
public final <T> com.helger.commons.collection.ext.ICommonsList<T> getNone()

getAll

@Nonnull
 @ReturnsMutableCopy
public final com.helger.commons.collection.ext.ICommonsList<INTERFACETYPE> getAll()

Specified by:

getAll in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

getAll

@Nonnull
 @ReturnsMutableCopy
public final com.helger.commons.collection.ext.ICommonsList<INTERFACETYPE> getAll(@Nullable
                                                                                                                  Predicate<? super INTERFACETYPE> aFilter)

Specified by:

getAll in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

internalDirectGetAll

@Nonnull
 @ReturnsMutableCopy
protected final Iterable<IMPLTYPE> internalDirectGetAll()

internalGetAll

@Nonnull
 @ReturnsMutableCopy
protected final com.helger.commons.collection.ext.ICommonsList<IMPLTYPE> internalGetAll(@Nullable
                                                                                                                        Predicate<? super IMPLTYPE> aFilter)

findAll

public final void findAll(@Nullable
                          Predicate<? super INTERFACETYPE> aFilter,
                          @Nonnull
                          Consumer<? super INTERFACETYPE> aConsumer)

Specified by:

findAll in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

getAllMapped

@Nonnull
 @ReturnsMutableCopy
public final <RETTYPE> com.helger.commons.collection.ext.ICommonsList<RETTYPE> getAllMapped(@Nullable
                                                                                                                            Predicate<? super INTERFACETYPE> aFilter,
                                                                                                                            @Nonnull
                                                                                                                            Function<? super INTERFACETYPE,? extends RETTYPE> aMapper)

Specified by:

getAllMapped in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

findAllMapped

public final <RETTYPE> void findAllMapped(@Nullable
                                          Predicate<? super INTERFACETYPE> aFilter,
                                          @Nonnull
                                          Function<? super INTERFACETYPE,? extends RETTYPE> aMapper,
                                          @Nonnull
                                          Consumer<? super RETTYPE> aConsumer)

Specified by:

findAllMapped in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

findFirst

@Nullable
public final INTERFACETYPE findFirst(@Nullable
                                                Predicate<? super INTERFACETYPE> aFilter)

Specified by:

findFirst in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

findFirstMapped

@Nullable
public final <RETTYPE> RETTYPE findFirstMapped(@Nullable
                                                          Predicate<? super INTERFACETYPE> aFilter,
                                                          @Nonnull
                                                          Function<? super INTERFACETYPE,? extends RETTYPE> aMapper)

Specified by:

findFirstMapped in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

containsAny

public final boolean containsAny()

Specified by:

containsAny in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

containsAny

public final boolean containsAny(@Nullable
                                 Predicate<? super INTERFACETYPE> aFilter)

Specified by:

containsAny in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

containsNone

public final boolean containsNone()

Specified by:

containsNone in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

containsNone

public final boolean containsNone(@Nullable
                                  Predicate<? super INTERFACETYPE> aFilter)

Specified by:

containsNone in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

containsOnly

public final boolean containsOnly(@Nullable
                                  Predicate<? super INTERFACETYPE> aFilter)

Specified by:

containsOnly in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

forEach

public final void forEach(@Nullable
                          BiConsumer<? super String,? super INTERFACETYPE> aConsumer)

forEach

public final void forEach(@Nullable
                          BiPredicate<? super String,? super INTERFACETYPE> aFilter,
                          @Nullable
                          BiConsumer<? super String,? super INTERFACETYPE> aConsumer)

forEachKey

public final void forEachKey(@Nullable
                             Consumer<? super String> aConsumer)

forEachKey

public final void forEachKey(@Nullable
                             Predicate<? super String> aFilter,
                             @Nullable
                             Consumer<? super String> aConsumer)

forEachValue

public final void forEachValue(@Nullable
                               Consumer<? super INTERFACETYPE> aConsumer)

internalForEachValue

protected final void internalForEachValue(@Nullable
                                          Consumer<? super IMPLTYPE> aConsumer)

forEachValue

public final void forEachValue(@Nullable
                               Predicate<? super INTERFACETYPE> aFilter,
                               @Nullable
                               Consumer<? super INTERFACETYPE> aConsumer)

internalForEachValue

protected final void internalForEachValue(@Nullable
                                          Predicate<? super IMPLTYPE> aFilter,
                                          @Nullable
                                          Consumer<? super IMPLTYPE> aConsumer)

getOfIDLocked

@Nullable
 @MustBeLocked(value=READ)
protected final IMPLTYPE getOfIDLocked(@Nullable
                                                                              String sID)

getOfID

@Nullable
protected final IMPLTYPE getOfID(@Nullable
                                            String sID)

getAtIndex

@Nullable
protected final INTERFACETYPE getAtIndex(@Nonnegative
                                                    int nIndex)

Get the item at the specified index. This method only returns defined results if a CommonLinkedHashMap is used for data storage.

Parameters:

nIndex - The index to retrieve. Should be ≥ 0.

Returns:

null if an invalid index was provided.

containsWithID

public final boolean containsWithID(@Nullable
                                    String sID)

Specified by:

containsWithID in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

containsAllIDs

public final boolean containsAllIDs(@Nullable
                                    Iterable<String> aIDs)

getAllIDs

@Nonnull
 @ReturnsMutableCopy
public final com.helger.commons.collection.ext.ICommonsSet<String> getAllIDs()

Specified by:

getAllIDs in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

getCount

@Nonnegative
public final int getCount()

Specified by:

getCount in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

getCount

@Nonnegative
public final int getCount(@Nullable
                                        Predicate<? super INTERFACETYPE> aFilter)

Specified by:

getCount in interface IMapBasedDAO<INTERFACETYPE extends com.helger.commons.id.IHasID<String> & Serializable>

toString

public String toString()

Overrides:

toString in class AbstractWALDAO<IMPLTYPE extends INTERFACETYPE>