|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||
java.lang.Objectcom.scooterframework.common.validation.Validators
public abstract class Validators
Validators contains basic validation methods to validate data.
Validation can be done for inputs to a controller (ActionValidators)
or data in a model (ModelValidators).
When a validatesXXX method has no messageKey as input, a default constant will be used as the message key. This default constant is one of the built-in message keys in a message property file. When input parameters of a validatesXXX method contain messageKey, but no associated value of the messageKey is found in any message property files, the messageKey itself is treated as a customized validation message.
Examples:
public void validatesRecord() {
//return: message is too short (minimum is 20 characters).
validators().validatesLengthMinimum("message", 20);
//return: Damn! Your post is too short.
validators().validatesLengthMinimum("body", 300, "Damn! Your post is too short.");
}
| Field Summary | |
|---|---|
static java.lang.String |
ACCEPTED
|
static java.lang.String |
CANNOT_BE_BLANK
|
static java.lang.String |
CANNOT_BE_NULL
|
static java.lang.String |
CONFIRMATION
|
static java.lang.String |
EMAIL_PATTERN
|
static java.lang.String |
EXCEEDING_MAXIMUM
|
static java.lang.String |
EXCLUSION
|
static java.lang.String |
INCLUSION
|
static java.lang.String |
IS_EMAIL
|
static java.lang.String |
IS_EQUALTO
|
static java.lang.String |
IS_INSIDE
|
static java.lang.String |
IS_LARGERTHAN
|
static java.lang.String |
IS_LARGERTHAN_OR_EQUALTO
|
static java.lang.String |
IS_LESSTHAN
|
static java.lang.String |
IS_LESSTHAN_OR_EQUALTO
|
static java.lang.String |
IS_UNIQUE
|
static java.lang.String |
IS_WITHIN
|
static java.lang.String |
NOT_A_NUMBER
|
static java.lang.String |
OUTOF_RANGE
|
static java.lang.String |
TOO_LONG
|
static java.lang.String |
TOO_SHORT
|
static java.lang.String |
WRONG_LENGTH
|
| Constructor Summary | |
|---|---|
Validators()
|
|
| Method Summary | |
|---|---|
protected abstract java.lang.Object |
getData(java.lang.String fieldName)
Returns value for the specific fieldName. |
protected abstract ValidationResults |
getValidationResults()
Returns validation result. |
void |
validatesAcceptanceOf(java.lang.String columnNames)
Validates the fields match the accepted values. |
void |
validatesAcceptanceOf(java.lang.String columnNames,
java.lang.String messageKey)
Validates the fields match the accepted values. |
void |
validatesAcceptanceOf(java.lang.String columnNames,
java.lang.String accept,
java.lang.String messageKey)
Validates the fields match the accepted values. |
void |
validatesConfirmationOf(java.lang.String columnNames)
Validates the fields match their corresponding confirmation values. |
void |
validatesConfirmationOf(java.lang.String columnNames,
boolean check)
Validates the fields match their corresponding confirmation values. |
void |
validatesConfirmationOf(java.lang.String columnNames,
java.lang.String messageKey)
Validates the fields match their corresponding confirmation values. |
void |
validatesConfirmationOf(java.lang.String columnNames,
java.lang.String messageKey,
boolean check)
Validates the fields match their corresponding confirmation values. |
void |
validatesExclusionOf(java.lang.String columnNames,
boolean skipNull,
java.lang.String exclusionValues)
Validates each field excludes from the specified values. |
void |
validatesExclusionOf(java.lang.String columnNames,
boolean skipNull,
java.lang.String exclusionValues,
java.lang.String messageKey)
Validates each field excludes from the specified values. |
void |
validatesExclusionOf(java.lang.String columnNames,
java.lang.String exclusionValues)
Validates each field excludes from the specified values. |
void |
validatesInclusionOf(java.lang.String columnNames,
boolean skipNull,
java.lang.String inclusionValues)
Validates each field matches one of the specified values. |
void |
validatesInclusionOf(java.lang.String columnNames,
boolean skipNull,
java.lang.String inclusionValues,
java.lang.String messageKey)
Validates each field matches one of the specified values. |
void |
validatesInclusionOf(java.lang.String columnNames,
java.lang.String inclusionValues)
Validates each field matches one of the specified values. |
void |
validatesIsEmail(java.lang.String columnNames)
Validates the field data contains email only. |
void |
validatesIsEmail(java.lang.String columnNames,
java.lang.String messageKey)
Validates the field data contains email only. |
void |
validatesIsNumber(java.lang.String columnNames)
Validates the field data contains number only. |
void |
validatesIsNumber(java.lang.String columnNames,
java.lang.String messageKey)
Validates the field data contains number only. |
void |
validatesLengthInRangeOf(java.lang.String columnNames,
int length1,
int length2)
Validates the field length is in a specific range. |
void |
validatesLengthInRangeOf(java.lang.String columnNames,
int length1,
int length2,
java.lang.String messageKey)
Validates the field length is in a specific range. |
void |
validatesLengthMaximum(java.lang.String columnNames,
int maximum)
Validates the maximum length of a field. |
void |
validatesLengthMaximum(java.lang.String columnNames,
int maximum,
java.lang.String messageKey)
Validates the maximum length of a field. |
void |
validatesLengthMinimum(java.lang.String columnNames,
int minimum)
Validates the minimum length of a field. |
void |
validatesLengthMinimum(java.lang.String columnNames,
int minimum,
java.lang.String messageKey)
Validates the minimum length of a field. |
void |
validatesLengthOf(java.lang.String columnNames,
int length)
Validates the field length is as specified. |
void |
validatesLengthOf(java.lang.String columnNames,
int length,
java.lang.String messageKey)
Validates the field length is as specified. |
void |
validatesNotNull(java.lang.String columnNames)
Validates the field data is not null. |
void |
validatesNotNull(java.lang.String columnNames,
java.lang.String messageKey)
Validates the field data is not null. |
void |
validatesNumberIsEqualTo(java.lang.String columnNames,
java.lang.Number number)
Validates the field data is equal to a specific number. |
void |
validatesNumberIsEqualTo(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
Validates the field data is equal to a specific number. |
void |
validatesNumberIsInsideRangeOf(java.lang.String columnNames,
java.lang.Number number1,
java.lang.Number number2)
Validates the field data is in a specific range of (number1, number2). |
void |
validatesNumberIsInsideRangeOf(java.lang.String columnNames,
java.lang.Number number1,
java.lang.Number number2,
java.lang.String messageKey)
Validates the field data is in a specific range of (number1, number2). |
void |
validatesNumberIsLargerThan(java.lang.String columnNames,
java.lang.Number number)
Validates the field data is larger than a specific number. |
void |
validatesNumberIsLargerThan(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
Validates the field data is larger than a specific number. |
void |
validatesNumberIsLargerThanOrEqualTo(java.lang.String columnNames,
java.lang.Number number)
Validates the field data is larger than or equal to a specific number. |
void |
validatesNumberIsLargerThanOrEqualTo(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
Validates the field data is larger than or equal to a specific number. |
void |
validatesNumberIsLowerThan(java.lang.String columnNames,
java.lang.Number number)
Validates the field data is lower than a specific number. |
void |
validatesNumberIsLowerThan(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
Validates the field data is lower than a specific number. |
void |
validatesNumberIsLowerThanOrEqualTo(java.lang.String columnNames,
java.lang.Number number)
Validates the field data is lower than or equal to a specific number. |
void |
validatesNumberIsLowerThanOrEqualTo(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
Validates the field data is lower than or equal to a specific number. |
void |
validatesNumberIsWithinRangeOf(java.lang.String columnNames,
java.lang.Number number1,
java.lang.Number number2)
Validates the field data is within a specific range of [number1, number2]. |
void |
validatesNumberIsWithinRangeOf(java.lang.String columnNames,
java.lang.Number number1,
java.lang.Number number2,
java.lang.String messageKey)
Validates the field data is within a specific range of [number1, number2]. |
void |
validatesNumberMaximum(java.lang.String columnNames,
java.lang.Number max)
Validates the field data does not exceed maximum. |
void |
validatesNumberMaximum(java.lang.String columnNames,
java.lang.Number max,
java.lang.String messageKey)
Validates the field data does not exceed maximum. |
void |
validatesPresenceOf(java.lang.String columnNames)
Validates the fields have non-blank values. |
void |
validatesPresenceOf(java.lang.String columnNames,
boolean check)
Validates the fields have non-blank values if check is true. |
void |
validatesPresenceOf(java.lang.String columnNames,
java.lang.String messageKey)
Validates the fields have non-blank values. |
void |
validatesPresenceOf(java.lang.String columnNames,
java.lang.String messageKey,
boolean check)
Validates the fields have non-blank values if check is true. |
void |
validatesUniqenessOf(java.lang.String columnNames)
Validates each field data is unique. |
void |
validatesUniqenessOf(java.lang.String columnNames,
java.lang.String messageKey)
Validates each field data is unique. |
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
public static final java.lang.String CONFIRMATION
public static final java.lang.String ACCEPTED
public static final java.lang.String INCLUSION
public static final java.lang.String EXCLUSION
public static final java.lang.String CANNOT_BE_BLANK
public static final java.lang.String CANNOT_BE_NULL
public static final java.lang.String NOT_A_NUMBER
public static final java.lang.String EXCEEDING_MAXIMUM
public static final java.lang.String IS_LESSTHAN_OR_EQUALTO
public static final java.lang.String IS_LESSTHAN
public static final java.lang.String IS_LARGERTHAN_OR_EQUALTO
public static final java.lang.String IS_LARGERTHAN
public static final java.lang.String IS_EQUALTO
public static final java.lang.String IS_WITHIN
public static final java.lang.String IS_INSIDE
public static final java.lang.String IS_UNIQUE
public static final java.lang.String IS_EMAIL
public static final java.lang.String TOO_LONG
public static final java.lang.String TOO_SHORT
public static final java.lang.String WRONG_LENGTH
public static final java.lang.String OUTOF_RANGE
public static final java.lang.String EMAIL_PATTERN
| Constructor Detail |
|---|
public Validators()
| Method Detail |
|---|
public void validatesPresenceOf(java.lang.String columnNames)
columnNames - A string of column names separated by comma or blank
public void validatesPresenceOf(java.lang.String columnNames,
boolean check)
columnNames - a string of column names separated by comma or blankcheck - a boolean variable to indicate whether to do the validation
public void validatesPresenceOf(java.lang.String columnNames,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankmessageKey - key to a message in message resource files or a message
public void validatesPresenceOf(java.lang.String columnNames,
java.lang.String messageKey,
boolean check)
columnNames - a string of column names separated by comma or blankmessageKey - key to a message in message resource files or a messagecheck - a boolean variable to indicate whether to do the validationpublic void validatesConfirmationOf(java.lang.String columnNames)
columnNames - A string of column names separated by comma or blank
public void validatesConfirmationOf(java.lang.String columnNames,
boolean check)
columnNames - a string of column names separated by comma or blankcheck - a boolean variable to indicate whether to do the validation
public void validatesConfirmationOf(java.lang.String columnNames,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankmessageKey - key to a message in message resource files or a message
public void validatesConfirmationOf(java.lang.String columnNames,
java.lang.String messageKey,
boolean check)
columnNames - a string of column names separated by comma or blankmessageKey - key to a message in message resource files or a messagecheck - a boolean variable to indicate whether to do the validationpublic void validatesAcceptanceOf(java.lang.String columnNames)
columnNames - a string of column names separated by comma or blank
public void validatesAcceptanceOf(java.lang.String columnNames,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankmessageKey - key to a message in message resource files or a message
public void validatesAcceptanceOf(java.lang.String columnNames,
java.lang.String accept,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankaccept - the acceptance valuemessageKey - key to a message in message resource files or a message
public void validatesInclusionOf(java.lang.String columnNames,
java.lang.String inclusionValues)
Examples:
validatesInclusionOf(gender, true, "Male, Female", "Please specify your gender.");//gender can be either "Male" or "Female" or null.
validatesInclusionOf(status, "Open, Close", "validation.inclusion");//status must be either "Open" or "Close", not null.
validatesInclusionOf(status, "Open, Close, null", "validation.inclusion");//status must be either "Open" or "Close" or null.
columnNames - a string of column names separated by comma or blankinclusionValues - the inclusion values separated by comma
public void validatesInclusionOf(java.lang.String columnNames,
boolean skipNull,
java.lang.String inclusionValues)
Examples:
validatesInclusionOf(gender, true, "Male, Female", "Please specify your gender.");//gender can be either "Male" or "Female" or null.
validatesInclusionOf(status, "Open, Close", "validation.inclusion");//status must be either "Open" or "Close", not null.
validatesInclusionOf(status, "Open, Close, null", "validation.inclusion");//status must be either "Open" or "Close" or null.
columnNames - a string of column names separated by comma or blankskipNull - if true skip the validation when the column value is null, default is false.inclusionValues - the inclusion values separated by comma
public void validatesInclusionOf(java.lang.String columnNames,
boolean skipNull,
java.lang.String inclusionValues,
java.lang.String messageKey)
Examples:
validatesInclusionOf(gender, true, "Male, Female", "Please specify your gender.");//gender can be either "Male" or "Female" or null.
validatesInclusionOf(status, "Open, Close", "validation.inclusion");//status must be either "Open" or "Close", not null.
validatesInclusionOf(status, "Open, Close, null", "validation.inclusion");//status must be either "Open" or "Close" or null.
columnNames - a string of column names separated by comma or blankskipNull - if true skip the validation when the column value is null, default is false.inclusionValues - the inclusion values separated by commamessageKey - key to a message in message resource files or a message
public void validatesExclusionOf(java.lang.String columnNames,
java.lang.String exclusionValues)
Examples:
validatesExclusionOf(gender, true, "Female", "No female please.");//gender can be either "Male" or null.
validatesExclusionOf(status, "Open, Close", "validation.exclusion");//status cannot be "Open" or "Close".
validatesExclusionOf(status, "Open, Close, null", "validation.exclusion");//status cannot be "Open" or "Close" or null.
columnNames - a string of column names separated by comma or blankexclusionValues - the exclusion values separated by comma
public void validatesExclusionOf(java.lang.String columnNames,
boolean skipNull,
java.lang.String exclusionValues)
Examples:
validatesExclusionOf(gender, true, "Female", "No female please.");//gender can be either "Male" or null.
validatesExclusionOf(status, "Open, Close", "validation.exclusion");//status cannot be "Open" or "Close".
validatesExclusionOf(status, "Open, Close, null", "validation.exclusion");//status cannot be "Open" or "Close" or null.
columnNames - a string of column names separated by comma or blankskipNull - if true skip the validation when the column value is null, default is false.exclusionValues - the exclusion values separated by comma
public void validatesExclusionOf(java.lang.String columnNames,
boolean skipNull,
java.lang.String exclusionValues,
java.lang.String messageKey)
Examples:
validatesExclusionOf(gender, true, "Female", "No female please.");//gender can be either "Male" or null.
validatesExclusionOf(status, "Open, Close", "validation.exclusion");//status cannot be "Open" or "Close".
validatesExclusionOf(status, "Open, Close, null", "validation.exclusion");//status cannot be "Open" or "Close" or null.
columnNames - a string of column names separated by comma or blankskipNull - if true skip the validation when the column value is null, default is false.exclusionValues - the exclusion values separated by commamessageKey - key to a message in message resource files or a messagepublic void validatesNotNull(java.lang.String columnNames)
columnNames - A string of column names separated by comma or blank
public void validatesNotNull(java.lang.String columnNames,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankmessageKey - key to a message in message resource files or a messagepublic void validatesIsEmail(java.lang.String columnNames)
columnNames - a string of column names separated by comma or blank
public void validatesIsEmail(java.lang.String columnNames,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankmessageKey - key to a message in message resource files or a messagepublic void validatesIsNumber(java.lang.String columnNames)
columnNames - a string of column names separated by comma or blank
public void validatesIsNumber(java.lang.String columnNames,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankmessageKey - key to a message in message resource files or a message
public void validatesNumberMaximum(java.lang.String columnNames,
java.lang.Number max)
columnNames - a string of column names separated by comma or blankmax - a maximum number
public void validatesNumberMaximum(java.lang.String columnNames,
java.lang.Number max,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankmax - a maximum numbermessageKey - key to a message in message resource files or a message
public void validatesNumberIsLowerThanOrEqualTo(java.lang.String columnNames,
java.lang.Number number)
columnNames - a string of column names separated by comma or blanknumber - a specific number
public void validatesNumberIsLowerThanOrEqualTo(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blanknumber - a specific numbermessageKey - key to a message in message resource files or a message
public void validatesNumberIsLowerThan(java.lang.String columnNames,
java.lang.Number number)
columnNames - a string of column names separated by comma or blanknumber - a specific number
public void validatesNumberIsLowerThan(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blanknumber - a specific numbermessageKey - key to a message in message resource files or a message
public void validatesNumberIsLargerThanOrEqualTo(java.lang.String columnNames,
java.lang.Number number)
columnNames - a string of column names separated by comma or blanknumber - a specific number
public void validatesNumberIsLargerThanOrEqualTo(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blanknumber - a specific numbermessageKey - key to a message in message resource files or a message
public void validatesNumberIsLargerThan(java.lang.String columnNames,
java.lang.Number number)
columnNames - a string of column names separated by comma or blanknumber - a specific number
public void validatesNumberIsLargerThan(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blanknumber - a specific numbermessageKey - key to a message in message resource files or a message
public void validatesNumberIsEqualTo(java.lang.String columnNames,
java.lang.Number number)
columnNames - a string of column names separated by comma or blanknumber - a specific number
public void validatesNumberIsEqualTo(java.lang.String columnNames,
java.lang.Number number,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blanknumber - a specific numbermessageKey - key to a message in message resource files or a message
public void validatesNumberIsWithinRangeOf(java.lang.String columnNames,
java.lang.Number number1,
java.lang.Number number2)
columnNames - a string of column names separated by comma or blanknumber1 - a specific numbernumber2 - a specific number
public void validatesNumberIsWithinRangeOf(java.lang.String columnNames,
java.lang.Number number1,
java.lang.Number number2,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blanknumber1 - a specific numbernumber2 - a specific numbermessageKey - key to a message in message resource files or a message
public void validatesNumberIsInsideRangeOf(java.lang.String columnNames,
java.lang.Number number1,
java.lang.Number number2)
columnNames - a string of column names separated by comma or blanknumber1 - a specific numbernumber2 - a specific number
public void validatesNumberIsInsideRangeOf(java.lang.String columnNames,
java.lang.Number number1,
java.lang.Number number2,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blanknumber1 - a specific numbernumber2 - a specific numbermessageKey - key to a message in message resource files or a message
public void validatesLengthMaximum(java.lang.String columnNames,
int maximum)
columnNames - a string of column names separated by comma or blankmaximum - the maximum length
public void validatesLengthMaximum(java.lang.String columnNames,
int maximum,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankmaximum - the maximum lengthmessageKey - key to a message in message resource files or a message
public void validatesLengthMinimum(java.lang.String columnNames,
int minimum)
columnNames - a string of column names separated by comma or blankminimum - the minimum length
public void validatesLengthMinimum(java.lang.String columnNames,
int minimum,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankminimum - the minimum lengthmessageKey - key to a message in message resource files or a message
public void validatesLengthInRangeOf(java.lang.String columnNames,
int length1,
int length2)
columnNames - a string of column names separated by comma or blanklength1 - the minimum lengthlength2 - the maximum length
public void validatesLengthInRangeOf(java.lang.String columnNames,
int length1,
int length2,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blanklength1 - the minimum lengthlength2 - the maximum lengthmessageKey - key to a message in message resource files or a message
public void validatesLengthOf(java.lang.String columnNames,
int length)
columnNames - a string of column names separated by comma or blanklength - the correct length
public void validatesLengthOf(java.lang.String columnNames,
int length,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blanklength - the correct lengthmessageKey - key to a message in message resource files or a messagepublic void validatesUniqenessOf(java.lang.String columnNames)
columnNames - a string of column names separated by comma or blank
public void validatesUniqenessOf(java.lang.String columnNames,
java.lang.String messageKey)
columnNames - a string of column names separated by comma or blankmessageKey - key to a message in message resource files or a messageprotected abstract ValidationResults getValidationResults()
protected abstract java.lang.Object getData(java.lang.String fieldName)
fieldName -
|
|||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | ||||||||