Package ca.uhn.hl7v2.validation.builder

Class PredicatePrimitiveTypeRule

java.lang.Object

ca.uhn.hl7v2.validation.impl.RuleSupport<String>

ca.uhn.hl7v2.validation.impl.AbstractPrimitiveTypeRule

ca.uhn.hl7v2.validation.builder.PredicatePrimitiveTypeRule

All Implemented Interfaces:

PredicateRuleSupport<String>, PrimitiveTypeRule, Rule<String>, Serializable

public class PredicatePrimitiveTypeRule
extends AbstractPrimitiveTypeRule
implements PredicateRuleSupport<String>

Abstract base class for PrimitiveTypeRules that validate using predicates

Author:

Christian Ohr

See Also:

• Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	PredicatePrimitiveTypeRule.Trimmer

Constructor Summary

Constructors

Constructor	Description
PredicatePrimitiveTypeRule(Predicate predicate)	Creates a new primitive rule without trimming
PredicatePrimitiveTypeRule(Predicate predicate, PredicatePrimitiveTypeRule.Trimmer trimmer)	Creates a new primitive rule

Method Summary

Modifier and Type	Method	Description
ValidationException[]	apply(String value)	Applies to rule to an object to be checked
String	correct(String value)	Optionally performs an automatic correction on given data to make it conform (eg trims leading whitespace).
Predicate	getPredicate()
boolean	test(String value)	Tests the given string against the criteria defined by this rule -- returns true if it passes the test, false otherwise.
String	toString()

Methods inherited from class ca.uhn.hl7v2.validation.impl.RuleSupport

failed, failed, failed, failed, failedWithValue, getDescription, getErrorCode, getSectionReference, getSeverity, passed, result, result, setDescription, setErrorCode, setSectionReference, setSeverity

Methods inherited from class java.lang.Object

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

Methods inherited from interface ca.uhn.hl7v2.validation.Rule

getDescription, getSectionReference

Constructor Details

PredicatePrimitiveTypeRule

public PredicatePrimitiveTypeRule(Predicate predicate)

Creates a new primitive rule without trimming

Parameters:

predicate - predicate to be used

PredicatePrimitiveTypeRule

public PredicatePrimitiveTypeRule(Predicate predicate,
 PredicatePrimitiveTypeRule.Trimmer trimmer)

Creates a new primitive rule

Parameters:

predicate - predicate to be used

trimmer - trimming behavior

Method Details

getPredicate

public Predicate getPredicate()

Specified by:

getPredicate in interface PredicateRuleSupport<String>

Returns:

the predicate instance used to test

correct

public String correct(String value)

Description copied from interface: PrimitiveTypeRule

Optionally performs an automatic correction on given data to make it conform (eg trims leading whitespace). This is to be called prior to test(). If no corrections are performed, the original value is returned.

Specified by:

correct in interface PrimitiveTypeRule

Overrides:

correct in class AbstractPrimitiveTypeRule

Parameters:

value - an original value to be corrected

Returns:

a corrected version of the given value

test

public boolean test(String value)

Description copied from interface: PrimitiveTypeRule

Tests the given string against the criteria defined by this rule -- returns true if it passes the test, false otherwise.

Specified by:

test in interface PrimitiveTypeRule

Overrides:

test in class AbstractPrimitiveTypeRule

apply

public ValidationException[] apply(String value)

Description copied from interface: Rule

Applies to rule to an object to be checked

Specified by:

apply in interface Rule<String>

Parameters:

value - object to be checked

Returns:

an (potentially empty) array of ValidationExceptions

toString

public String toString()

Overrides:

toString in class Object