org.openmrs.validator

Class PatientIdentifierValidator

java.lang.Object

org.openmrs.validator.PatientIdentifierValidator

All Implemented Interfaces:

org.springframework.validation.Validator

@Handler(supports=PatientIdentifier.class,
         order=50)
public class PatientIdentifierValidator
extends Object
implements org.springframework.validation.Validator

This class validates a PatientIdentifier object.

Constructor Summary

Constructors

Constructor and Description
PatientIdentifierValidator()

Method Summary

Modifier and Type	Method and Description
static void	checkIdentifierAgainstFormat(String identifier, String format, String formatDescription) Validates that a given identifier string is valid for a given regular expression format
static void	checkIdentifierAgainstValidator(String identifier, IdentifierValidator validator) Validates that a given identifier string is valid for a given IdentifierValidator
boolean	supports(Class<?> c)
void	validate(Object obj, org.springframework.validation.Errors errors) Validates a PatientIdentifier.
static void	validateIdentifier(PatientIdentifier pi) Checks that the given PatientIdentifier is valid
static void	validateIdentifier(String identifier, PatientIdentifierType pit) Validates that a given identifier string is valid for a given PatientIdentifierType Checks for things like blank identifiers, invalid check digits, and invalid format.

Methods inherited from class java.lang.Object

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

Constructor Detail

PatientIdentifierValidator

public PatientIdentifierValidator()

Method Detail

supports

public boolean supports(Class<?> c)

Specified by:

supports in interface org.springframework.validation.Validator

See Also:

Validator.supports(java.lang.Class)

validate

public void validate(Object obj,
                     org.springframework.validation.Errors errors)

Validates a PatientIdentifier.

Specified by:

validate in interface org.springframework.validation.Validator

See Also:

Should pass validation if field lengths are correct Should fail validation if field lengths are not correct

validateIdentifier

public static void validateIdentifier(PatientIdentifier pi)
                               throws PatientIdentifierException

Checks that the given PatientIdentifier is valid

Parameters:

pi - - the PatientIdentifier to validate

Throws:

PatientIdentifierException - if the PatientIdentifier is invalid Should fail validation if PatientIdentifier is null Should pass validation if PatientIdentifier is voided Should fail validation if another patient has a matching identifier of the same type Should pass if in use and id type uniqueness is set to non unique

See Also:

validateIdentifier(String, PatientIdentifierType)

validateIdentifier

public static void validateIdentifier(String identifier,
                                      PatientIdentifierType pit)
                               throws PatientIdentifierException

Validates that a given identifier string is valid for a given PatientIdentifierType Checks for things like blank identifiers, invalid check digits, and invalid format.

Parameters:

pit - - the PatientIdentifierType to validate against

identifier - - the identifier to check against the passed PatientIdentifierType

Throws:

PatientIdentifierException - if the identifier is invalid Should fail validation if PatientIdentifierType is null Should fail validation if identifier is blank

See Also:

checkIdentifierAgainstFormat(String, String, String), checkIdentifierAgainstValidator(String, IdentifierValidator)

checkIdentifierAgainstFormat

public static void checkIdentifierAgainstFormat(String identifier,
                                                String format,
                                                String formatDescription)
                                         throws PatientIdentifierException

Validates that a given identifier string is valid for a given regular expression format

Parameters:

identifier - - the identifier to check against the passed PatientIdentifierType

format - - the regular expression format to validate against

formatDescription - - user-friendly way of describing format (may be null)

Throws:

PatientIdentifierException - if the identifier is does not match the format Should fail validation if identifier is blank Should fail validation if identifier does not match the format Should pass validation if identifier matches the format Should pass validation if the format is blank Should include format in error message if no formatDescription is specified Should include formatDescription in error message if specified

checkIdentifierAgainstValidator

public static void checkIdentifierAgainstValidator(String identifier,
                                                   IdentifierValidator validator)
                                            throws PatientIdentifierException

Validates that a given identifier string is valid for a given IdentifierValidator

Parameters:

identifier - the identifier to check against the passed PatientIdentifierType

validator - the IdentifierValidator to use to check the identifier

Throws:

PatientIdentifierException - if the identifier is does not match the format Should fail validation if identifier is blank Should fail validation if identifier is invalid Should pass validation if identifier is valid Should pass validation if validator is null