ca.uhn.hl7v2.validation.impl

Class RuleSupport<T>

java.lang.Object

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

All Implemented Interfaces:

Rule<T>, Serializable

Direct Known Subclasses:

AbstractEncodingRule, AbstractMessageRule, AbstractPrimitiveTypeRule

public abstract class RuleSupport<T>
extends Object
implements Rule<T>

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
RuleSupport()

Method Summary

Modifier and Type	Method and Description
protected ValidationException[]	failed(Exception e)
protected ValidationException[]	failed(Exception e, Location location)
protected ValidationException[]	failed(String msg)
protected ValidationException[]	failed(String msg, Location location)
protected ValidationException[]	failedWithValue(Object value, Location location)
String	getDescription() Returns a text description of the rule.
ErrorCode	getErrorCode()
String	getSectionReference() Returns a string indicating the section of the HL7 standard from which this rule is derived (if applicable).
Severity	getSeverity()
protected ValidationException[]	passed()
protected ValidationException[]	result(boolean result, Object value)
protected ValidationException[]	result(boolean result, Object value, Location location)
void	setDescription(String description)
void	setErrorCode(ErrorCode errorCode)
void	setSectionReference(String sectionReference)
void	setSeverity(Severity severity)

Methods inherited from class java.lang.Object

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

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

apply

Constructor Detail

RuleSupport

public RuleSupport()

Method Detail

result

protected ValidationException[] result(boolean result,
                                       Object value)

result

protected ValidationException[] result(boolean result,
                                       Object value,
                                       Location location)

passed

protected ValidationException[] passed()

failedWithValue

protected ValidationException[] failedWithValue(Object value,
                                                Location location)

failed

protected ValidationException[] failed(String msg)

failed

protected ValidationException[] failed(String msg,
                                       Location location)

failed

protected ValidationException[] failed(Exception e)

failed

protected ValidationException[] failed(Exception e,
                                       Location location)

getSectionReference

public String getSectionReference()

Description copied from interface: Rule

Returns a string indicating the section of the HL7 standard from which this rule is derived (if applicable). Like the description, this may be used in an exception message or configuration UI.

Specified by:

getSectionReference in interface Rule<T>

Returns:

HL7 specification section reference

See Also:

Rule.getSectionReference()

getDescription

public String getDescription()

Description copied from interface: Rule

Returns a text description of the rule. This description may be used as a message in exceptions generated if validation against the rule fails, or in a user interface for rule configuration.

Specified by:

getDescription in interface Rule<T>

Returns:

rule description

See Also:

Rule.getDescription()

getSeverity

public Severity getSeverity()

Returns:

the severity if this rule fails

getErrorCode

public ErrorCode getErrorCode()

Returns:

the error code to be used in case the validation failed

setSeverity

public void setSeverity(Severity severity)

setDescription

public void setDescription(String description)

setSectionReference

public void setSectionReference(String sectionReference)

setErrorCode

public void setErrorCode(ErrorCode errorCode)