com.helger.photon.basic.favorites

Class FavoriteManager

java.lang.Object

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

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

com.helger.photon.basic.favorites.FavoriteManager

All Implemented Interfaces:

IAutoSaveAware, IChangeable, IDAO

@ThreadSafe
public class FavoriteManager
extends AbstractWALDAO<Favorite>

This class manages Favorite objects.

Author:

Philip Helger

Nested Class Summary

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

IDAO.EMode

Field Summary

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
FavoriteManager(String sFilename)

Method Summary

Modifier and Type	Method and Description
IFavorite	addFavorite(String sUserID, String sApplicationID, String sMenuItemID, String sDisplayName, Map<String,String> aAdditionalParams) Create a new favorite object.
boolean	containsFavoritesOfUser(String sUserID) Check if the specified user ID is contained or not.
protected com.helger.xml.microdom.IMicroDocument	createWriteData() Create the XML document that should be saved to the file.
com.helger.commons.collection.ext.ICommonsList<IFavorite>	getAllFavoritesOfUser(String sUserID)
IFavorite	getFavorite(String sUserID, String sApplicationID, String sMenuItemID, com.helger.commons.collection.ext.ICommonsMap<String,String> aAdditionalParams) Get the favorite of the specified user ID
long	getSize()
boolean	isEmpty()
boolean	isFavorite(String sUserID, String sApplicationID, String sMenuItemID, com.helger.commons.collection.ext.ICommonsMap<String,String> aAdditionalParams) Get a list favorites of the specified user ID
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(Favorite aElement) Called when a recovery is needed to create a new item.
protected void	onRecoveryDelete(Favorite aElement) Called when a recovery is needed to delete an existing item.
protected void	onRecoveryUpdate(Favorite aElement) Called when a recovery is needed to update an existing item.
void	reload()
com.helger.commons.state.EChange	removeAllFavoritesOfUser(String sUserID) Remove all contained favorites objects of an user.
com.helger.commons.state.EChange	removeFavorite(String sUserID, String sID) Remove the favorites with the specified ID.
String	toString()
com.helger.commons.state.EChange	updateFavorite(String sUserID, String sID, String sDisplayName) Update an existing favorite object.

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, 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

Constructor Detail

FavoriteManager

public FavoriteManager(@Nonnull @Nonempty
                       String sFilename)
                throws DAOException

Throws:

DAOException

Method Detail

onRecoveryCreate

protected void onRecoveryCreate(@Nonnull
                                Favorite aElement)

Description copied from class: AbstractWALDAO

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

Specified by:

onRecoveryCreate in class AbstractWALDAO<Favorite>

Parameters:

aElement - The element to be created. Never null.

onRecoveryUpdate

protected void onRecoveryUpdate(@Nonnull
                                Favorite aElement)

Description copied from class: AbstractWALDAO

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

Specified by:

onRecoveryUpdate in class AbstractWALDAO<Favorite>

Parameters:

aElement - The element to be updated. Never null.

onRecoveryDelete

protected void onRecoveryDelete(@Nonnull
                                Favorite aElement)

Description copied from class: AbstractWALDAO

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

Specified by:

onRecoveryDelete in class AbstractWALDAO<Favorite>

Parameters:

aElement - 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<Favorite>

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.

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<Favorite>

Returns:

The non-null document to write to the file.

reload

public void reload()
            throws DAOException

Throws:

DAOException

getSize

@Nonnegative
public long getSize()

isEmpty

public boolean isEmpty()

getAllFavoritesOfUser

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.ext.ICommonsList<IFavorite> getAllFavoritesOfUser(@Nullable
                                                                                                                       String sUserID)

Parameters:

sUserID - The ID of the user.

Returns:

A copy of all contained favorite as map from ID to object. Never null but maybe empty.

containsFavoritesOfUser

public boolean containsFavoritesOfUser(@Nullable
                                       String sUserID)

Check if the specified user ID is contained or not.

Parameters:

sUserID - The UserID to check. May be null.

Returns:

true if the passed ID is contained

isFavorite

public boolean isFavorite(@Nullable
                          String sUserID,
                          @Nullable
                          String sApplicationID,
                          @Nullable
                          String sMenuItemID,
                          @Nullable
                          com.helger.commons.collection.ext.ICommonsMap<String,String> aAdditionalParams)

Get a list favorites of the specified user ID

Parameters:

sUserID - The ID of the user.

sApplicationID - The application ID to compare to.

sMenuItemID - Menu item ID

aAdditionalParams - Additional params. May be null.

Returns:

null if no such settings are contained.

getFavorite

@Nullable
public IFavorite getFavorite(@Nullable
                                        String sUserID,
                                        @Nullable
                                        String sApplicationID,
                                        @Nullable
                                        String sMenuItemID,
                                        @Nullable
                                        com.helger.commons.collection.ext.ICommonsMap<String,String> aAdditionalParams)

Get the favorite of the specified user ID

Parameters:

sUserID - The ID of the user.

sApplicationID - The application ID to compare to.

sMenuItemID - Menu item ID

aAdditionalParams - Additional params. May be null.

Returns:

null if no such settings are contained.

addFavorite

@Nonnull
public IFavorite addFavorite(@Nonnull @Nonempty
                                       String sUserID,
                                       @Nonnull @Nonempty
                                       String sApplicationID,
                                       @Nonnull @Nonempty
                                       String sMenuItemID,
                                       @Nonnull @Nonempty
                                       String sDisplayName,
                                       @Nullable
                                       Map<String,String> aAdditionalParams)

Create a new favorite object.

Parameters:

sUserID - The ID of the user. May neither be null nor empty.

sApplicationID - The application ID. May neither be null nor empty.

sMenuItemID - Menu item ID. May neither be null nor empty.

sDisplayName - Display name of the favorite. May neither be null nor empty.

aAdditionalParams - Additional params. May be null.

Returns:

The created IFavorite object and never null.

updateFavorite

@Nullable
public com.helger.commons.state.EChange updateFavorite(@Nullable
                                                                  String sUserID,
                                                                  @Nullable
                                                                  String sID,
                                                                  @Nullable
                                                                  String sDisplayName)

Update an existing favorite object.

Parameters:

sUserID - The ID of the user of the favorite object to be updated.

sID - The ID of the favorite object to be updated.

sDisplayName - The display name to change.

Returns:

EChange.CHANGED if something was changed.

removeFavorite

@Nullable
public com.helger.commons.state.EChange removeFavorite(@Nullable
                                                                  String sUserID,
                                                                  @Nullable
                                                                  String sID)

Remove the favorites with the specified ID.

Parameters:

sUserID - The ID of the user of the favorite object to be updated.

sID - The ID of the favorite object to be updated.

Returns:

EChange.CHANGED if a removal was performed.

removeAllFavoritesOfUser

@Nullable
public com.helger.commons.state.EChange removeAllFavoritesOfUser(@Nullable
                                                                            String sUserID)

Remove all contained favorites objects of an user.

Parameters:

sUserID - The ID of the user of the favorite objects to be updated.

Returns:

EChange.CHANGED if a removal was performed.

toString

public String toString()

Overrides:

toString in class AbstractWALDAO<Favorite>