Package ca.uhn.hl7v2.validation

Class AbstractValidator<R>

java.lang.Object

ca.uhn.hl7v2.validation.AbstractValidator<R>

Type Parameters:

R - The type parameter R denotes the result type of the validation process.

All Implemented Interfaces:

Validator<R>

Direct Known Subclasses:

DefaultValidator, MessageValidator

public abstract class AbstractValidator<R>
extends Object
implements Validator<R>

Abstract implementation of a message validator.

Author:

Christian Ohr

Constructor Summary

Constructors

Constructor	Description
AbstractValidator()

Method Summary

Modifier and Type	Method	Description
protected abstract ValidationContext	getValidationContext()
protected abstract ValidationExceptionHandler<R>	initializeHandler()
boolean	isValidatePrimitives()
void	setValidatePrimitives(boolean validatePrimitives)	Turns validating primtives on and off (default).
R	validate(Message message)	Calls initializeHandler() to obtain a default instance of a ValidationExceptionHandler before starting the validation.
R	validate(Message message, ValidationExceptionHandler<R> handler)	Validates a Message using a custom ValidationExceptionHandler.
R	validate(String message, boolean isXML, String version)	Calls initializeHandler() to obtain a default instance of a ValidationExceptionHandler before starting the validation.
R	validate(String message, boolean isXML, String version, ValidationExceptionHandler<R> handler)	Validates a String representing an encoded message.

Methods inherited from class java.lang.Object

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

Constructor Details

AbstractValidator

public AbstractValidator()

Method Details

setValidatePrimitives

public void setValidatePrimitives(boolean validatePrimitives)

Turns validating primtives on and off (default). Note that primitive validation will significantly slow down the validation process.

Parameters:

validatePrimitives - true if primitive fields shall be validated, false if not

isValidatePrimitives

public boolean isValidatePrimitives()

Returns:

true if primitive fields shall be validated, false if not

validate

public R validate(Message message)
           throws HL7Exception

Calls initializeHandler() to obtain a default instance of a ValidationExceptionHandler before starting the validation.

Specified by:

validate in interface Validator<R>

Parameters:

message - message to be validated

Returns:

true if message is valid

Throws:

HL7Exception - if an unexpected error occurs while validating

See Also:

• Validator.validate(ca.uhn.hl7v2.model.Message)

validate

public R validate(Message message,
 ValidationExceptionHandler<R> handler)
           throws HL7Exception

Description copied from interface: Validator

Validates a Message using a custom ValidationExceptionHandler. The handler provides the possibility to react on the outcome of the validation process and its individual steps, e.g. collecting all validation, issues, aggregating them to a single issue, logging, throwing exceptions etc.

As the handler usually maintains state, a new instance is required for every validation call.

Specified by:

validate in interface Validator<R>

Parameters:

message - message to be validated

handler - message validation handler

Returns:

true if message is valid

Throws:

HL7Exception - if an unexpected error occurs while validating

See Also:

• Validator.validate(ca.uhn.hl7v2.model.Message, ca.uhn.hl7v2.validation.ValidationExceptionHandler)

validate

public R validate(String message,
 boolean isXML,
 String version)
           throws HL7Exception

Calls initializeHandler() to obtain a default instance of a ValidationExceptionHandler before starting the validation.

Specified by:

validate in interface Validator<R>

Parameters:

message - message to be validated

isXML - true if message is supposed to be XML

version - message version

Returns:

true if message is valid

Throws:

HL7Exception - if an unexpected error occurs while validating

See Also:

• Validator.validate(Message, ValidationExceptionHandler)

validate

public R validate(String message,
 boolean isXML,
 String version,
 ValidationExceptionHandler<R> handler)
           throws HL7Exception

Description copied from interface: Validator

Validates a String representing an encoded message. As the handler usually maintains state, a new instance is required for every validation call.

Specified by:

validate in interface Validator<R>

Parameters:

message - message to be validated

isXML - true if message is supposed to be XML

version - message version

handler - message validation handler

Returns:

true if message is valid

Throws:

HL7Exception - if an unexpected error occurs while validating

See Also:

• Validator.validate(java.lang.String, boolean, java.lang.String, ca.uhn.hl7v2.validation.ValidationExceptionHandler)

getValidationContext

protected abstract ValidationContext getValidationContext()

initializeHandler

protected abstract ValidationExceptionHandler<R> initializeHandler()