com.helger.photon.basic.favorites

Class FavoriteManager

java.lang.Object

com.helger.dao.AbstractDAO

com.helger.dao.wal.AbstractWALDAO<DATATYPE>

com.helger.photon.basic.app.dao.AbstractPhotonWALDAO<Favorite>

com.helger.photon.basic.favorites.FavoriteManager

All Implemented Interfaces:

com.helger.dao.IAutoSaveAware, com.helger.dao.IDAO

@ThreadSafe
public class FavoriteManager
extends AbstractPhotonWALDAO<Favorite>

This class manages Favorite objects.

Author:

Philip Helger

Nested Class Summary

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

com.helger.dao.IDAO.EMode

Field Summary

Fields inherited from class com.helger.dao.wal.AbstractWALDAO

DEFAULT_WAITING_TIME, WAL_XWS, WRITE_XWS

Fields inherited from class com.helger.dao.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()
com.helger.commons.collection.impl.ICommonsList<IFavorite>	getAllFavoritesOfUser(String sUserID)
IFavorite	getFavorite(String sUserID, String sApplicationID, String sMenuItemID, com.helger.commons.collection.impl.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.impl.ICommonsMap<String,String> aAdditionalParams) Get a list favorites of the specified user ID
boolean	isReloadable()
protected com.helger.commons.state.EChange	onRead(com.helger.xml.microdom.IMicroDocument aDoc)
protected void	onRecoveryCreate(Favorite aElement)
protected void	onRecoveryDelete(Favorite aElement)
protected void	onRecoveryUpdate(Favorite aElement)
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.dao.wal.AbstractWALDAO

convertNativeToWALString, convertWALStringToNative, getDataTypeClass, getFilenameProvider, getInitCount, getIO, 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.dao.AbstractDAO

beginWithoutAutoSave, endWithoutAutoSave, exceptionHandlersRead, exceptionHandlersWrite, hasPendingChanges, internalHasPendingChanges, internalIsAutoSaveEnabled, internalSetPendingChanges, isAutoSaveEnabled, isDebugLogging

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.helger.dao.IAutoSaveAware

performWithoutAutoSave, performWithoutAutoSave, performWithoutAutoSaveThrowing, performWithoutAutoSaveThrowing

Constructor Detail

FavoriteManager

public FavoriteManager(@Nonnull @Nonempty
                       String sFilename)
                throws com.helger.dao.DAOException

Throws:

com.helger.dao.DAOException

Method Detail

onRecoveryCreate

protected void onRecoveryCreate(@Nonnull
                                Favorite aElement)

Specified by:

onRecoveryCreate in class com.helger.dao.wal.AbstractWALDAO<Favorite>

onRecoveryUpdate

protected void onRecoveryUpdate(@Nonnull
                                Favorite aElement)

Specified by:

onRecoveryUpdate in class com.helger.dao.wal.AbstractWALDAO<Favorite>

onRecoveryDelete

protected void onRecoveryDelete(@Nonnull
                                Favorite aElement)

Specified by:

onRecoveryDelete in class com.helger.dao.wal.AbstractWALDAO<Favorite>

onRead

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

Specified by:

onRead in class com.helger.dao.wal.AbstractWALDAO<Favorite>

createWriteData

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

Specified by:

createWriteData in class com.helger.dao.wal.AbstractWALDAO<Favorite>

isReloadable

public boolean isReloadable()

reload

public void reload()
            throws com.helger.dao.DAOException

Throws:

com.helger.dao.DAOException

getSize

@Nonnegative
public long getSize()

isEmpty

public boolean isEmpty()

getAllFavoritesOfUser

@Nonnull
 @ReturnsMutableCopy
public com.helger.commons.collection.impl.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.impl.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.impl.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 com.helger.dao.wal.AbstractWALDAO<Favorite>