Package ca.uhn.hl7v2.validation.builder

Class MessageRuleBuilder

java.lang.Object

ca.uhn.hl7v2.validation.builder.BuilderSupport

ca.uhn.hl7v2.validation.builder.RuleTypeBuilder<MessageRuleBuilder,MessageRule>

ca.uhn.hl7v2.validation.builder.MessageRuleBuilder

All Implemented Interfaces:

Serializable

public class MessageRuleBuilder
extends RuleTypeBuilder<MessageRuleBuilder,MessageRule>

Rule Builder for MessageRules

Author:

Christian Ohr

See Also:

• Serialized Form

Nested Class Summary

Nested classes/interfaces inherited from class ca.uhn.hl7v2.validation.builder.RuleTypeBuilder

RuleTypeBuilder.MessageExpressionBuilder

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	MessageRuleBuilder(List<RuleBinding<? extends Rule<?>>> rules, Set<Version> versions, String messageType, String... triggerEvents)

Method Summary

Modifier and Type	Method	Description
MessageRuleBuilder	choiceElementsRespected()	Builds a MessageRule that enforces choice elements.
MessageRuleBuilder	conformance()	Builds a MessageRule that evaluates the message against the Conformance Profile referred to in MSH-21.
MessageRuleBuilder	conformance(String profileId)	Builds a MessageRule that evaluates the message against the Conformance Profile referred to by the profileId parameter
protected Collection<RuleBinding<MessageRule>>	getRuleBindings(MessageRule rule, String version)	Builder implementation must overwrite this method to return all RuleBindings for rules that have been built.
MessageRuleBuilder	inspect(MessageVisitorFactory<? extends ValidatingMessageVisitor> visitorFactory)	Builds a MessageRule that runs a ValidatingMessageVisitor over the message that collects ValidationExceptions in a single pass.
MessageRuleBuilder	onlyAllowableSegmentsInSuperStructure()	Builds a MessageRule that disallows the existence of segments which are not alowed in a given message type when the message is an instance of SuperStructure (e.g.
MessageRuleBuilder	onlyKnownSegments()	Builds a MessageRule that disallows the existence of GenericSegments, i.e.
MessageRuleBuilder	terser(String spec, Predicate predicate)	Builds a MessageRule that extracts a primitive value using a Terser expression and evaluates the specified Predicate.
MessageRuleBuilder	wrongVersion()	Builds a MessageRule that disallows the selected HL7 version(s).

Methods inherited from class ca.uhn.hl7v2.validation.builder.RuleTypeBuilder

activate, active, addRuleBindings, description, encoding, getRules, instance, message, message, prepareRule, primitive, refersToSection, severity, test

Methods inherited from class ca.uhn.hl7v2.validation.builder.BuilderSupport

allOf, allOf, always, alwaysFails, anyOf, anyOf, date, dateTime, dateTime25, empty, emptyOr, in, in, isEqual, isEqualIgnoreCase, matches, matches, matches, maxLength, nonNegativeInteger, not, number, oid, startsWith, time, usPhoneNumber, uuid, withdrawn

Methods inherited from class java.lang.Object

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

Constructor Details

MessageRuleBuilder

protected MessageRuleBuilder(List<RuleBinding<? extends Rule<?>>> rules,
 Set<Version> versions,
 String messageType,
 String... triggerEvents)

Method Details

terser

public MessageRuleBuilder terser(String spec,
 Predicate predicate)

Builds a MessageRule that extracts a primitive value using a Terser expression and evaluates the specified Predicate.

Parameters:

spec - Terser expression

predicate - Predicate to evaluate against the value

Returns:

this instance to build more rules

inspect

public MessageRuleBuilder inspect(MessageVisitorFactory<? extends ValidatingMessageVisitor> visitorFactory)

Builds a MessageRule that runs a ValidatingMessageVisitor over the message that collects ValidationExceptions in a single pass.

Parameters:

visitorFactory - MessageVisitorFactory that creates ValidatingMessageVisitor instances

Returns:

this instance to build more rules

onlyKnownSegments

public MessageRuleBuilder onlyKnownSegments()

Builds a MessageRule that disallows the existence of GenericSegments, i.e. segments that are not defined in the structure of a message.

Returns:

this instance to build more rules

onlyAllowableSegmentsInSuperStructure

public MessageRuleBuilder onlyAllowableSegmentsInSuperStructure()

Builds a MessageRule that disallows the existence of segments which are not alowed in a given message type when the message is an instance of SuperStructure (e.g. PID2 within an ADT^A01)

Returns:

this instance to build more rules

choiceElementsRespected

public MessageRuleBuilder choiceElementsRespected()

Builds a MessageRule that enforces choice elements. This means that if several segments are listed as being a possible choice for the first segment in a group, only one of them may have content.

Returns:

this instance to build more rules

wrongVersion

public MessageRuleBuilder wrongVersion()

Builds a MessageRule that disallows the selected HL7 version(s). It is basically equivalent with:

    forAllVersions().message(....).terser("MSH-12", in(allowedVersions))
 

However, when using this specific rule the builder expression and the resulting exception message is more specific:

          forVersion().except(allowedVersions).message(...).wrongVersion()
 

Returns:

this instance to build more rules

conformance

public MessageRuleBuilder conformance()

Builds a MessageRule that evaluates the message against the Conformance Profile referred to in MSH-21.

Returns:

this instance to build more rules

conformance

public MessageRuleBuilder conformance(String profileId)

Builds a MessageRule that evaluates the message against the Conformance Profile referred to by the profileId parameter

Parameters:

profileId - conformance profile id (file name)

Returns:

this instance to build more rules

getRuleBindings

protected Collection<RuleBinding<MessageRule>> getRuleBindings(MessageRule rule,
 String version)

Description copied from class: RuleTypeBuilder

Builder implementation must overwrite this method to return all RuleBindings for rules that have been built.

Overrides:

getRuleBindings in class RuleTypeBuilder<MessageRuleBuilder,MessageRule>

Parameters:

rule - the rule for which bindings shall be retrieved

version - the HL7 version for which bindings shall be retrieved

Returns:

a collection of RuleBindings