de.xima.fc.gui.validator.name

Class AUniqueNameValidator<T extends INameProviding & de.xima.cmn.dao.interfaces.IEntity<Long>>

java.lang.Object

de.xima.fc.gui.common.utils.msg.I18nUtils

de.xima.fc.gui.common.utils.msg.MessageUtils

de.xima.fc.gui.common.utils.msg.AMessaging

de.xima.fc.gui.common.utils.msg.AJSFContext

de.xima.fc.gui.bean.ABackendJSFContext

de.xima.fc.gui.validator.name.AUniqueNameValidator<T>

Type Parameters:

T - Type of the entity.

All Implemented Interfaces:

Serializable, EventListener, javax.faces.validator.Validator

Direct Known Subclasses:

UniqueActionName, UniqueClientName, UniqueFrontendServerName

public class AUniqueNameValidator<T extends INameProviding & de.xima.cmn.dao.interfaces.IEntity<Long>>
extends ABackendJSFContext
implements javax.faces.validator.Validator, Serializable

Attach this validator to the input field for the INameProviding.getName() of an IEntity. Validates whether that name is unique, that is, whether the current entity is the only one with that given name. This requires that we know which entity is the current entity. Attach the "currentEntityId" to the input component or one of its parents, like so:

 <p:outputPanel>
   <p:inputText value="#{bean.entity.name}" />
   <f:attribute name="currentEntity" value="#{bean.entity}" />
 </p:outputPanel>
 

In case the attribute is not attached to the component or one of its parents, we fall back to the old behavior: Skip the validation iff the new value is equal to the old (previous) value of the component. Please note that this fails when creating a new entity and setting a default value for the name -- validation of the name will be skipped when saving the entity.

Author:

XIMA MEDIA GmbH, XIMA MEDIA GmbH

See Also:

Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext

AJSFContext.RedirectOptions, AJSFContext.RedirectOptionsBuilder

Field Summary

Fields inherited from interface javax.faces.validator.Validator

NOT_IN_RANGE_MESSAGE_ID

Constructor Summary

Constructors

Constructor and Description
AUniqueNameValidator(Class<T> clazz)

Method Summary

Modifier and Type	Method and Description
protected de.xima.cmn.criteria.QueryCriteriaManager	setupQcm(de.xima.cmn.criteria.QueryCriteriaManager qcm, T currentEntity) To check for duplicate names, we create a query criteria manager for all entities with the given name, excluding the current entity.
void	throwError()
void	validate(javax.faces.context.FacesContext context, javax.faces.component.UIComponent component, Object value)

Methods inherited from class de.xima.fc.gui.bean.ABackendJSFContext

ec, isDetached, isHasDB

Methods inherited from class de.xima.fc.gui.common.utils.msg.AJSFContext

destroySessionBean, encodeURL, findBean, findBean, findBean, findBean, findBean, findBean, findBean, findCurrentView, getBeanName, getBeanName, getContext, getCurrentViewBean, getLocaleBean, getRequest, getResponse, getSession, getSession, getSessionAttribute, isMasterServerContext, loadLazy, redirect, redirect, redirect, redirect, redirectToDashboard, redirectToDashboard, setLocaleBean, setSessionAttribute, uc

Methods inherited from class de.xima.fc.gui.common.utils.msg.MessageUtils

addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsg, addErrorMsgFromString, addErrorMsgFromString, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addErrorMsgToComponent, addInfoMsg, addInfoMsg, addInfoMsg, addInfoMsg, addInfoMsgFromString, addInfoMsgFromString, addInfoMsgToComponent, addInfoMsgToComponent, addInfoMsgToComponent, addInfoMsgToComponent, addMsg, addMsg, addMsg, addMsg, addMsgs, addMsgToComponent, addMsgToComponent, addWarnMsg, addWarnMsg, addWarnMsg, addWarnMsg, addWarnMsgFromString, addWarnMsgFromString, addWarnMsgToComponent, addWarnMsgToComponent, addWarnMsgToComponent, addWarnMsgToComponent, cleanErrorMsg, getErrorMessage, getNewErrorMsg, getNewErrorMsg, getNewErrorMsg, getNewInfoMsg, getNewInfoMsg, getNewMsg, getNewWarnMsg, getNewWarnMsg

Methods inherited from class de.xima.fc.gui.common.utils.msg.I18nUtils

getFacesContext, getLocale, rbValue, rbValue, rbValue

Methods inherited from class java.lang.Object

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

Constructor Detail

AUniqueNameValidator

public AUniqueNameValidator(Class<T> clazz)

Method Detail

validate

public void validate(javax.faces.context.FacesContext context,
                     javax.faces.component.UIComponent component,
                     Object value)
              throws javax.faces.validator.ValidatorException

Specified by:

validate in interface javax.faces.validator.Validator

Throws:

javax.faces.validator.ValidatorException

setupQcm

protected de.xima.cmn.criteria.QueryCriteriaManager setupQcm(de.xima.cmn.criteria.QueryCriteriaManager qcm,
                                                             T currentEntity)

To check for duplicate names, we create a query criteria manager for all entities with the given name, excluding the current entity. For adding additional restrictions, override this method (such as restricting the query to a particular client).

Parameters:

qcm - Current query criteria manager.

currentEntity - The current entitity whose name is validated. Might be null.

Returns:

The query criteria manager to be used for the unique name query. May be the same as the given qcm.

throwError

public void throwError()
                throws javax.faces.validator.ValidatorException

Throws:

javax.faces.validator.ValidatorException