org.spincast.plugins.validation

Class SpincastValidatorBase<T>

java.lang.Object

org.spincast.plugins.validation.SpincastValidatorBase<T>

All Implemented Interfaces:

IValidator

public abstract class SpincastValidatorBase<T>
extends Object
implements IValidator

Validator base class implementation.

Constructor Summary

Constructors

Constructor and Description
SpincastValidatorBase(T objToValidate, SpincastValidatorBaseDeps spincastValidatorBaseDeps) Constructor

Method Summary

Modifier and Type	Method and Description
protected void	addError(IValidationError error) Adds a validation error.
protected void	addError(String fieldName, String errorType, String errorMessage) Adds a validation error.
protected void	addErrors(List<IValidationError> errors) Adds validation errors.
protected void	addErrorsFormattedSpecificField(String fieldName, List<IValidationError> errors, FormatType formatType, StringBuilder textBuilder, IJsonObject jsonObject)
protected void	addErrorsFormattedSpecificFieldHtml(String fieldName, StringBuilder textBuilder, List<IValidationError> errors)
protected void	addErrorsFormattedSpecificFieldTextPlain(String fieldName, StringBuilder textBuilder, List<IValidationError> errors)
protected String	getCssClassForErrorField() The css class to use for a field's <li> element.
protected String	getCssClassForErrorMessage() The css class to use for an error message's <li> element.
protected String	getDefaultErrorMessage(String fieldName)
protected org.apache.commons.validator.routines.EmailValidator	getEmailValidator()
protected String	getErrorMessageDefaultMaxLength(String fieldName, long maxLength, long currentLength)
protected String	getErrorMessageDefaultMaxSize(String fieldName, long maxSize, Long currentSize)
protected String	getErrorMessageDefaultMinLength(String fieldName, long minLength, long currentLength)
protected String	getErrorMessageDefaultMinSize(String fieldName, long minSize, Long currentSize)
protected String	getErrorMessageDefaultNotBlank(String fieldName)
protected String	getErrorMessageDefaultNotNull(String fieldName)
protected String	getErrorMessageDefaultPattern(String fieldName, String pattern)
protected String	getErrorMessageEmail(String fieldName)
Map<String,List<IValidationError>>	getErrors() Gets the validation errors.
List<IValidationError>	getErrors(String fieldName) Gets the validation errors for the specified field.
String	getErrorsFormatted(FormatType formatType) Gets the formatted errors, if there are any.
String	getErrorsFormatted(String fieldName, FormatType formatType) Gets the formatted errors of a specific field, if there are any.
protected Map<String,List<IValidationError>>	getErrorsMap()
protected IJsonManager	getJsonManager()
protected T	getObjToValidate()
protected ISpincastValidationConfig	getSpincastBeanValidationConfig()
protected IValidationErrorFactory	getValidationErrorFactory()
protected IXmlManager	getXmlManager()
boolean	isValid() Is the object valid?
protected boolean	isValidationDone()
void	revalidate() Revalidates the object.
protected boolean	usePrettyJson()
protected boolean	usePrettyXml()
protected abstract void	validate() The validation method to implement.
protected void	validateBase() Override "validate()" instead of this method, if you can.
protected boolean	validateEmail(String fieldName, String fieldValue) Validates that a field is a valid email address.
protected boolean	validateEmail(String fieldName, String fieldValue, String errorMessage) Validates that a field is a valid email address.
protected boolean	validateMaxLength(String fieldName, String fieldValue, int maxLength) Validates that a field has a maximum length.
protected boolean	validateMaxLength(String fieldName, String fieldValue, int maxLength, String errorMessage) Validates that a field has a maximum length.
protected boolean	validateMaxLength(String fieldName, String fieldValue, long maxLength) Validates that a field has a maximum length.
protected boolean	validateMaxLength(String fieldName, String fieldValue, long maxLength, String errorMessage) Validates that a field has a maximum length.
protected boolean	validateMaxSize(String fieldName, Integer fieldValue, int maxSize) Validates that a field has a maximum size.
protected boolean	validateMaxSize(String fieldName, Integer fieldValue, int maxSize, String errorMessage) Validates that a field has a maximum size.
protected boolean	validateMaxSize(String fieldName, Long fieldValue, long maxSize) Validates that a field has a maximum size.
protected boolean	validateMaxSize(String fieldName, Long fieldValue, long maxSize, String errorMessage) Validates that a field has a minimum size.
protected boolean	validateMinLength(String fieldName, String fieldValue, int minLength) Validates that a field has a minimum length.
protected boolean	validateMinLength(String fieldName, String fieldValue, int minLength, String errorMessage) Validates that a field has a minimum length.
protected boolean	validateMinLength(String fieldName, String fieldValue, long minLength) Validates that a field has a minimum length.
protected boolean	validateMinLength(String fieldName, String fieldValue, long minLength, String errorMessage) Validates that a field has a minimum length.
protected boolean	validateMinSize(String fieldName, Integer fieldValue, int minSize) Validates that a field has a minimum size.
protected boolean	validateMinSize(String fieldName, Integer fieldValue, int minSize, String errorMessage) Validates that a field has a minimum size.
protected boolean	validateMinSize(String fieldName, Long fieldValue, long minSize) Validates that a field has a minimum size.
protected boolean	validateMinSize(String fieldName, Long fieldValue, long minSize, String errorMessage) Validates that a field has a minimum size.
protected boolean	validateNotBlank(String fieldName, String fieldValue) Validates that a field is not blank (null, empty or contain only spaces).
protected boolean	validateNotBlank(String fieldName, String fieldValue, String errorMessage) Validates that a field is not null.
protected boolean	validateNotNull(String fieldName, Object fieldValue) Validates that a field is not null.
protected boolean	validateNotNull(String fieldName, Object fieldValue, String errorMessage) Validates that a field is not null.
protected boolean	validatePattern(String fieldName, String fieldValue, String pattern) Validates that a field matches a pattern.
protected boolean	validatePattern(String fieldName, String fieldValue, String pattern, boolean mustMatch) Validates that a field matches a pattern or not.
protected boolean	validatePattern(String fieldName, String fieldValue, String pattern, boolean mustMatch, String errorMessage) Validates that a field matches a pattern or not.
protected boolean	validatePattern(String fieldName, String fieldValue, String pattern, String errorMessage) Validates that a field matches a pattern.

Methods inherited from class java.lang.Object

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

Constructor Detail

SpincastValidatorBase

public SpincastValidatorBase(T objToValidate,
                             SpincastValidatorBaseDeps spincastValidatorBaseDeps)

Constructor

Method Detail

getObjToValidate

protected T getObjToValidate()

getValidationErrorFactory

protected IValidationErrorFactory getValidationErrorFactory()

getSpincastBeanValidationConfig

protected ISpincastValidationConfig getSpincastBeanValidationConfig()

getJsonManager

protected IJsonManager getJsonManager()

getXmlManager

protected IXmlManager getXmlManager()

isValidationDone

protected boolean isValidationDone()

validateBase

protected void validateBase()

Override "validate()" instead of this method, if you can.

isValid

public boolean isValid()

Description copied from interface: IValidator

Is the object valid?

Specified by:

isValid in interface IValidator

revalidate

public void revalidate()

Description copied from interface: IValidator

Revalidates the object. The validation result is cached until this is called.

Specified by:

revalidate in interface IValidator

getErrors

public Map<String,List<IValidationError>> getErrors()

Description copied from interface: IValidator

Gets the validation errors. The keys are the field names.

If the validation hasn't been called yet, calls it.

Specified by:

getErrors in interface IValidator

getErrorsMap

protected Map<String,List<IValidationError>> getErrorsMap()

getErrors

public List<IValidationError> getErrors(String fieldName)

Description copied from interface: IValidator

Gets the validation errors for the specified field.

If the validation hasn't been called yet, calls it.

Specified by:

getErrors in interface IValidator

addError

protected void addError(IValidationError error)

Adds a validation error.

addError

protected void addError(String fieldName,
                        String errorType,
                        String errorMessage)

Adds a validation error.

getDefaultErrorMessage

protected String getDefaultErrorMessage(String fieldName)

addErrors

protected void addErrors(List<IValidationError> errors)

Adds validation errors.

getErrorsFormatted

public String getErrorsFormatted(FormatType formatType)

Description copied from interface: IValidator

Gets the formatted errors, if there are any.

If the validation hasn't been called yet, calls it.

Specified by:

getErrorsFormatted in interface IValidator

Parameters:

formatType - The type of output for the errors (Text, HTML, Json or XML).

Returns:

the formatted errors or null if there are no validation errors.

getErrorsFormatted

public String getErrorsFormatted(String fieldName,
                                 FormatType formatType)

Description copied from interface: IValidator

Gets the formatted errors of a specific field, if there are any.

If the validation hasn't been called yet, calls it.

Specified by:

getErrorsFormatted in interface IValidator

Parameters:

fieldName - The field to get errors for.

formatType - The type of output for the errors (Text, HTML, Json or XML).

Returns:

the formatted errors or null if there are no validation errors.

usePrettyJson

protected boolean usePrettyJson()

usePrettyXml

protected boolean usePrettyXml()

addErrorsFormattedSpecificField

protected void addErrorsFormattedSpecificField(String fieldName,
                                               List<IValidationError> errors,
                                               FormatType formatType,
                                               StringBuilder textBuilder,
                                               IJsonObject jsonObject)

addErrorsFormattedSpecificFieldTextPlain

protected void addErrorsFormattedSpecificFieldTextPlain(String fieldName,
                                                        StringBuilder textBuilder,
                                                        List<IValidationError> errors)

addErrorsFormattedSpecificFieldHtml

protected void addErrorsFormattedSpecificFieldHtml(String fieldName,
                                                   StringBuilder textBuilder,
                                                   List<IValidationError> errors)

getCssClassForErrorField

protected String getCssClassForErrorField()

The css class to use for a field's <li> element.

getCssClassForErrorMessage

protected String getCssClassForErrorMessage()

The css class to use for an error message's <li> element.

validateNotNull

protected boolean validateNotNull(String fieldName,
                                  Object fieldValue)

Validates that a field is not null.

validateNotNull

protected boolean validateNotNull(String fieldName,
                                  Object fieldValue,
                                  String errorMessage)

Validates that a field is not null.

getErrorMessageDefaultNotNull

protected String getErrorMessageDefaultNotNull(String fieldName)

validateNotBlank

protected boolean validateNotBlank(String fieldName,
                                   String fieldValue)

Validates that a field is not blank (null, empty or contain only spaces).

validateNotBlank

protected boolean validateNotBlank(String fieldName,
                                   String fieldValue,
                                   String errorMessage)

Validates that a field is not null.

getErrorMessageDefaultNotBlank

protected String getErrorMessageDefaultNotBlank(String fieldName)

validateMinLength

protected boolean validateMinLength(String fieldName,
                                    String fieldValue,
                                    int minLength)

Validates that a field has a minimum length.

validateMinLength

protected boolean validateMinLength(String fieldName,
                                    String fieldValue,
                                    int minLength,
                                    String errorMessage)

Validates that a field has a minimum length.

validateMinLength

protected boolean validateMinLength(String fieldName,
                                    String fieldValue,
                                    long minLength)

Validates that a field has a minimum length.

validateMinLength

protected boolean validateMinLength(String fieldName,
                                    String fieldValue,
                                    long minLength,
                                    String errorMessage)

Validates that a field has a minimum length.

getErrorMessageDefaultMinLength

protected String getErrorMessageDefaultMinLength(String fieldName,
                                                 long minLength,
                                                 long currentLength)

validateMaxLength

protected boolean validateMaxLength(String fieldName,
                                    String fieldValue,
                                    int maxLength)

Validates that a field has a maximum length.

validateMaxLength

protected boolean validateMaxLength(String fieldName,
                                    String fieldValue,
                                    int maxLength,
                                    String errorMessage)

Validates that a field has a maximum length.

validateMaxLength

protected boolean validateMaxLength(String fieldName,
                                    String fieldValue,
                                    long maxLength)

Validates that a field has a maximum length.

validateMaxLength

protected boolean validateMaxLength(String fieldName,
                                    String fieldValue,
                                    long maxLength,
                                    String errorMessage)

Validates that a field has a maximum length.

getErrorMessageDefaultMaxLength

protected String getErrorMessageDefaultMaxLength(String fieldName,
                                                 long maxLength,
                                                 long currentLength)

validateMinSize

protected boolean validateMinSize(String fieldName,
                                  Integer fieldValue,
                                  int minSize)

Validates that a field has a minimum size.

validateMinSize

protected boolean validateMinSize(String fieldName,
                                  Integer fieldValue,
                                  int minSize,
                                  String errorMessage)

Validates that a field has a minimum size.

validateMinSize

protected boolean validateMinSize(String fieldName,
                                  Long fieldValue,
                                  long minSize)

Validates that a field has a minimum size.

validateMinSize

protected boolean validateMinSize(String fieldName,
                                  Long fieldValue,
                                  long minSize,
                                  String errorMessage)

Validates that a field has a minimum size.

getErrorMessageDefaultMinSize

protected String getErrorMessageDefaultMinSize(String fieldName,
                                               long minSize,
                                               Long currentSize)

validateMaxSize

protected boolean validateMaxSize(String fieldName,
                                  Integer fieldValue,
                                  int maxSize)

Validates that a field has a maximum size.

validateMaxSize

protected boolean validateMaxSize(String fieldName,
                                  Integer fieldValue,
                                  int maxSize,
                                  String errorMessage)

Validates that a field has a maximum size.

validateMaxSize

protected boolean validateMaxSize(String fieldName,
                                  Long fieldValue,
                                  long maxSize)

Validates that a field has a maximum size.

validateMaxSize

protected boolean validateMaxSize(String fieldName,
                                  Long fieldValue,
                                  long maxSize,
                                  String errorMessage)

Validates that a field has a minimum size.

getErrorMessageDefaultMaxSize

protected String getErrorMessageDefaultMaxSize(String fieldName,
                                               long maxSize,
                                               Long currentSize)

validatePattern

protected boolean validatePattern(String fieldName,
                                  String fieldValue,
                                  String pattern)

Validates that a field matches a pattern.

validatePattern

protected boolean validatePattern(String fieldName,
                                  String fieldValue,
                                  String pattern,
                                  boolean mustMatch)

Validates that a field matches a pattern or not.

Parameters:

mustMatch - if true, the field must match the pattern, if false, it must not match it.

validatePattern

protected boolean validatePattern(String fieldName,
                                  String fieldValue,
                                  String pattern,
                                  String errorMessage)

Validates that a field matches a pattern.

validatePattern

protected boolean validatePattern(String fieldName,
                                  String fieldValue,
                                  String pattern,
                                  boolean mustMatch,
                                  String errorMessage)

Validates that a field matches a pattern or not.

Parameters:

mustMatch - if true, the field must match the pattern, if false, it must not match it.

getErrorMessageDefaultPattern

protected String getErrorMessageDefaultPattern(String fieldName,
                                               String pattern)

validateEmail

protected boolean validateEmail(String fieldName,
                                String fieldValue)

Validates that a field is a valid email address.

validateEmail

protected boolean validateEmail(String fieldName,
                                String fieldValue,
                                String errorMessage)

Validates that a field is a valid email address.

getEmailValidator

protected org.apache.commons.validator.routines.EmailValidator getEmailValidator()

getErrorMessageEmail

protected String getErrorMessageEmail(String fieldName)

validate

protected abstract void validate()

The validation method to implement.