ca.uhn.hl7v2.validation.impl

Class ConformanceProfileRule

java.lang.Object

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

ca.uhn.hl7v2.validation.impl.AbstractMessageRule

ca.uhn.hl7v2.validation.impl.ConformanceProfileRule

All Implemented Interfaces:

MessageRule, Rule<Message>, Serializable

public class ConformanceProfileRule
extends AbstractMessageRule

A MessageRule that checks conformance to message profiles. Messages can either be tested against the profiles they declare, or against a pre-defined profile. If you want both, use two ConformanceProfileRules.

Version:

$Revision: 1.1 $ updated on $Date: 2007-02-19 02:24:40 $ by $Author: jamesagnew $

Author:

Bryan Tripp

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ConformanceProfileRule() Creates an instance that tests messages against whatever profiles they declare in MSH-21.
ConformanceProfileRule(String theProfileID)

Method Summary

Modifier and Type	Method and Description
ValidationException[]	apply(Message msg) Applies to rule to an object to be checked
String	getDescription() Returns a text description of the rule.
String	getProfileID()
String	getSectionReference() Returns a string indicating the section of the HL7 standard from which this rule is derived (if applicable).
void	setEnableCaching(boolean enableCaching)

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

test

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

failed, failed, failed, failed, failedWithValue, getErrorCode, 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

Constructor Detail

ConformanceProfileRule

public ConformanceProfileRule()

Creates an instance that tests messages against whatever profiles they declare in MSH-21. The ID declared in MSH-21 is evaluated in a way that the corresponding profile file is expected to be BASEDIR/profiles/ID.xml.

ConformanceProfileRule

public ConformanceProfileRule(String theProfileID)

Parameters:

theProfileID - the ID of a constant profile against which to test all messages (instead of the profiles they declare in MSH-21). The ID is evaluated in a way that the corresponding profile file is expected to be BASEDIR/profiles/ID.xml.

Method Detail

apply

public ValidationException[] apply(Message msg)

Description copied from interface: Rule

Applies to rule to an object to be checked

Parameters:

msg - object to be checked

Returns:

an (potentially empty) array of ValidationExceptions

See Also:

MessageRule.test(ca.uhn.hl7v2.model.Message)

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<Message>

Overrides:

getDescription in class RuleSupport<Message>

Returns:

rule description

See Also:

Rule.getDescription()

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<Message>

Overrides:

getSectionReference in class RuleSupport<Message>

Returns:

HL7 specification section reference

See Also:

Rule.getSectionReference()

getProfileID

public String getProfileID()

setEnableCaching

public void setEnableCaching(boolean enableCaching)