com.softslate.commerce.customer.core
Class FormUtilsImpl

java.lang.Object
  extended by com.softslate.commerce.customer.core.FormUtilsImpl
All Implemented Interfaces:
FormUtils

public class FormUtilsImpl
extends java.lang.Object
implements FormUtils

FormUtilsImpl is the default implementation of the FormUtils interface for the application.

Author:
David Tobey
See Also:
FormUtils

Field Summary
(package private) static org.apache.commons.logging.Log log
           
 
Constructor Summary
FormUtilsImpl()
           
 
Method Summary
 java.lang.String capitalize(java.lang.String stringToCapitalize)
          Returns a new string with the first letter of a given string capitalized.
 java.lang.Character containsCharacter(java.lang.String string, java.lang.String characters)
          Determines if a given string contains a character residing in another string.
 java.lang.String deriveCardType(java.lang.String number)
          Given a credit card number, derive its type (Visa, Discover, MasterCard or AMEX).
 boolean doCardTypeAndNumberMatch(java.lang.String type, java.lang.String number)
          Given a credit card type and a number, checks that the number corresponds correctly with the type.
 boolean isCreditCardValid(java.lang.String creditCardNumber)
          Runs a given string through the Luhn algorithm to determine if it is a valid credit card number.
 boolean isInteger(java.lang.String value)
          Checks to see if a given string is in the form of a valid integer.
 boolean isValidEmail(java.lang.String email)
          Checks to see if a given string is in the form of a valid email address.
 boolean isValidPhone(java.lang.String phone)
          Checks to see if a given string is in the form of a valid phone number.
 boolean isValidPostalCode(java.lang.String postalCode, java.lang.String country)
          Checks to see if a given string is in the form of a valid postal code, given an associated country.
 boolean stringArrayHasAnElement(BaseDynaForm form, java.lang.String property)
          Determines if at least one element was submitted and is of non-zero length for a string array parameter of a BaseDynaForm.
 boolean stringArrayHasAnElement(java.lang.String[] paramValues)
          Determines if a given string array has at least one element and that it's of non-zero length.
 boolean stringArrayValuesGreaterThan(BaseDynaForm form, java.lang.String property, int value)
          Determines if at least one element was submitted and is greater than a given int for a string array parameter of a BaseDynaForm.
 boolean stringArrayValuesGreaterThan(java.lang.String[] paramValues, int value)
          Determines if at least one element in a string array is greater than a given value.
 boolean stringExists(BaseDynaForm form, java.lang.String property)
          Determines if a given parameter was included in the request for a BaseDynaForm and is of non-zero length.
 boolean stringValueGreaterThan(BaseDynaForm form, java.lang.String property, int value)
          Determines if a given parameter for a BaseDynaForm is greater than a given int.
 boolean stringValueLessThan(BaseDynaForm form, java.lang.String property, int value)
          Determines if a given parameter for a BaseDynaForm is less than a given int.
 boolean twoPropertiesEqual(BaseDynaForm form, java.lang.String property1, java.lang.String property2)
          Determines if two string parameters submitted to a BaseDynaForm exist and are equal.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Field Detail

log

static org.apache.commons.logging.Log log
Constructor Detail

FormUtilsImpl

public FormUtilsImpl()
Method Detail

stringExists

public boolean stringExists(BaseDynaForm form,
                            java.lang.String property)
Description copied from interface: FormUtils
Determines if a given parameter was included in the request for a BaseDynaForm and is of non-zero length.

Specified by:
stringExists in interface FormUtils
Parameters:
form - The BaseDynaForm being processed.
property - The name of the parameter being tested.
Returns:
true if the given parameter was submitted to the form and is of non-zero length. false if not.

twoPropertiesEqual

public boolean twoPropertiesEqual(BaseDynaForm form,
                                  java.lang.String property1,
                                  java.lang.String property2)
Description copied from interface: FormUtils
Determines if two string parameters submitted to a BaseDynaForm exist and are equal.

Specified by:
twoPropertiesEqual in interface FormUtils
Parameters:
form - The BaseDynaForm being processed.
property1 - The first parameter to be tested.
property2 - The second parameter to be tested.
Returns:
true if the given parameters were submitted to the form and are equal. false if not.

stringValueGreaterThan

public boolean stringValueGreaterThan(BaseDynaForm form,
                                      java.lang.String property,
                                      int value)
Description copied from interface: FormUtils
Determines if a given parameter for a BaseDynaForm is greater than a given int.

Specified by:
stringValueGreaterThan in interface FormUtils
Parameters:
form - The BaseDynaForm being processed.
property - The name of the parameter to be tested.
value - The value for the parameter to be tested against.
Returns:
true if the given parameter is greater than the value. false if not.

stringValueLessThan

public boolean stringValueLessThan(BaseDynaForm form,
                                   java.lang.String property,
                                   int value)
Description copied from interface: FormUtils
Determines if a given parameter for a BaseDynaForm is less than a given int.

Specified by:
stringValueLessThan in interface FormUtils
Parameters:
form - The BaseDynaForm being processed.
property - The name of the parameter to be tested.
value - The value for the parameter to be tested against.
Returns:
true if the given parameter is less than the value. false if not.

stringArrayHasAnElement

public boolean stringArrayHasAnElement(BaseDynaForm form,
                                       java.lang.String property)
Description copied from interface: FormUtils
Determines if at least one element was submitted and is of non-zero length for a string array parameter of a BaseDynaForm.

Specified by:
stringArrayHasAnElement in interface FormUtils
Parameters:
form - The BaseDynaForm being processed.
property - The name of the parameter being tested.
Returns:
true if the given parameter has at least one element and is of non-zero length. false if not.

stringArrayValuesGreaterThan

public boolean stringArrayValuesGreaterThan(BaseDynaForm form,
                                            java.lang.String property,
                                            int value)
Description copied from interface: FormUtils
Determines if at least one element was submitted and is greater than a given int for a string array parameter of a BaseDynaForm.

Specified by:
stringArrayValuesGreaterThan in interface FormUtils
Parameters:
form - The BaseDynaForm being processed.
property - The name of the parameter being tested.
value - The value for the parameter to be tested against.
Returns:
true if the given parameter has at least one element and is greater than the value. false if not.

stringArrayHasAnElement

public boolean stringArrayHasAnElement(java.lang.String[] paramValues)
Description copied from interface: FormUtils
Determines if a given string array has at least one element and that it's of non-zero length.

Specified by:
stringArrayHasAnElement in interface FormUtils
Parameters:
paramValues - The string array being tested.
Returns:
true if the given string array has one element that's of non-zero length.

stringArrayValuesGreaterThan

public boolean stringArrayValuesGreaterThan(java.lang.String[] paramValues,
                                            int value)
Description copied from interface: FormUtils
Determines if at least one element in a string array is greater than a given value.

Specified by:
stringArrayValuesGreaterThan in interface FormUtils
Parameters:
paramValues - The string array being tested.
value - The value for the string array's elements to be tested against.
Returns:
true if at least one element in a string array is greater than a given value. false if not.

capitalize

public java.lang.String capitalize(java.lang.String stringToCapitalize)
Description copied from interface: FormUtils
Returns a new string with the first letter of a given string capitalized.

Specified by:
capitalize in interface FormUtils
Parameters:
stringToCapitalize - The string to capitalize.
Returns:
A new string with the first letter capitalized.

isValidEmail

public boolean isValidEmail(java.lang.String email)
Description copied from interface: FormUtils
Checks to see if a given string is in the form of a valid email address. Uses the following regular expression for the test: .+@.+\\.[a-z]+

Specified by:
isValidEmail in interface FormUtils
Parameters:
email - The string to be tested.
Returns:
true if the given string matches a valid email address.

isValidPhone

public boolean isValidPhone(java.lang.String phone)
Description copied from interface: FormUtils
Checks to see if a given string is in the form of a valid phone number. Since phone numbers may be U.S. or international in format, and may or may not have an extension, only a light check is done ensuring that at least 10 digits are present.

Specified by:
isValidPhone in interface FormUtils
Parameters:
phone - The string to be tested.
Returns:
true if the given string matches a valid phone number.

isValidPostalCode

public boolean isValidPostalCode(java.lang.String postalCode,
                                 java.lang.String country)
Description copied from interface: FormUtils
Checks to see if a given string is in the form of a valid postal code, given an associated country. If the country is US, a simple check on the number of digits is done.

Specified by:
isValidPostalCode in interface FormUtils
Parameters:
postalCode - The string to be tested.
Returns:
true if the given string matches a valid postal code.

isInteger

public boolean isInteger(java.lang.String value)
Description copied from interface: FormUtils
Checks to see if a given string is in the form of a valid integer.

Specified by:
isInteger in interface FormUtils
Parameters:
value - The string to be tested.
Returns:
true if the given string is a valid integer

isCreditCardValid

public boolean isCreditCardValid(java.lang.String creditCardNumber)
Description copied from interface: FormUtils
Runs a given string through the Luhn algorithm to determine if it is a valid credit card number.

Specified by:
isCreditCardValid in interface FormUtils
Parameters:
creditCardNumber - The credit card number
Returns:
true, if the string is a valid credit card number; false, otherwise.

doCardTypeAndNumberMatch

public boolean doCardTypeAndNumberMatch(java.lang.String type,
                                        java.lang.String number)
Description copied from interface: FormUtils
Given a credit card type and a number, checks that the number corresponds correctly with the type.

Specified by:
doCardTypeAndNumberMatch in interface FormUtils
Parameters:
type - Four types supported: "VISA", "DISCOVER", "AMEX", and "MASTERCARD"
number - The credit card number
Returns:
true if the card type matches the number or if the card type is not supported.

deriveCardType

public java.lang.String deriveCardType(java.lang.String number)
Description copied from interface: FormUtils
Given a credit card number, derive its type (Visa, Discover, MasterCard or AMEX).

Specified by:
deriveCardType in interface FormUtils
Parameters:
number - The credit card number
Returns:
Four types supported: "VISA", "DISCOVER", "AMEX", and "MASTERCARD"

containsCharacter

public java.lang.Character containsCharacter(java.lang.String string,
                                             java.lang.String characters)
Description copied from interface: FormUtils
Determines if a given string contains a character residing in another string.

Specified by:
containsCharacter in interface FormUtils
Parameters:
string - The string to check against
characters - A String containing each of the characters to check
Returns:
the first matching Character, if the string contains one of the characters, otherwise null


Copyright © SoftSlate, LLC 2003–2005