ca.uhn.hl7v2.validation.impl

Class AbstractMessageRule

java.lang.Object

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

ca.uhn.hl7v2.validation.impl.AbstractMessageRule

All Implemented Interfaces:

MessageRule, Rule<Message>, Serializable

Direct Known Subclasses:

ChoiceElementsRespectedRule, ConformanceProfileRule, OnlyAllowableSegmentsInSuperstructureRule, OnlyKnownSegmentsRule, PredicateMessageRule, VisitorMessageRule, WrongVersionRule

public abstract class AbstractMessageRule
extends RuleSupport<Message>
implements MessageRule

Abstract base class for message rules

Author:

Christian Ohr

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
AbstractMessageRule()

Method Summary

Modifier and Type	Method and Description
ValidationException[]	test(Message msg) Tests the given (fully populated) message against the criteria defined by this rule class.

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, toString, wait, wait, wait

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

apply, getDescription, getSectionReference

Constructor Detail

AbstractMessageRule

public AbstractMessageRule()

Method Detail

test

public ValidationException[] test(Message msg)

Description copied from interface: MessageRule

Tests the given (fully populated) message against the criteria defined by this rule class.

Specified by:

test in interface MessageRule

Parameters:

msg - message to be tested

Returns:

a list of exceptions indicating points at which the given message failed to validate (empty if validation succeeds; may not be a complete list as testing may be aborted after failure). The list should be empty if this rule is evaluated against a type of message to which it doesn't apply.