Package org.cqframework.cql.elm.execution

Class Message

java.lang.Object

org.opencds.cqf.cql.engine.elm.execution.Executable

org.cqframework.cql.elm.execution.Element

org.cqframework.cql.elm.execution.Expression

org.cqframework.cql.elm.execution.OperatorExpression

org.cqframework.cql.elm.execution.Message

All Implemented Interfaces:

org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

Direct Known Subclasses:

MessageEvaluator

public class Message
extends OperatorExpression
implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

The Message operator is used to support errors, warnings, messages, and tracing in an ELM evaluation environment. The operator is defined to return the input source. If the severity is Error, the operator is expected to raise a run-time error and return the message to the calling environment. This is the only severity that stops processing. All other severities continue evaluation of the expression. If the severity is Trace, the operator is expected to make the message available to a tracing mechanism such as a debug log in the calling environment. If the severity is Warning, the operator is expected to provide the message as a warning to the calling environment. If the severity is Message, the operator is expected to provide the message as information to the calling environment.

Java class for Message complex type.

The following schema fragment specifies the expected content contained within this class.

 <complexType name="Message">
   <complexContent>
     <extension base="{urn:hl7-org:elm:r1}OperatorExpression">
       <sequence>
         <element name="source" type="{urn:hl7-org:elm:r1}Expression"/>
         <element name="condition" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
         <element name="code" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
         <element name="severity" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
         <element name="message" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
       </sequence>
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected Expression	code
protected Expression	condition
protected Expression	message
protected Expression	severity
protected Expression	source

Fields inherited from class org.cqframework.cql.elm.execution.OperatorExpression

signature

Fields inherited from class org.cqframework.cql.elm.execution.Element

annotation, localId, locator, resultTypeName, resultTypeSpecifier

Constructor Summary

Constructors

Constructor	Description
Message()

Method Summary

Modifier and Type	Method	Description
StringBuilder	append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
StringBuilder	appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, StringBuilder buffer, org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
boolean	equals(Object object)
boolean	equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator, org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator, Object object, org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
Expression	getCode()	Gets the value of the code property.
Expression	getCondition()	Gets the value of the condition property.
Expression	getMessage()	Gets the value of the message property.
Expression	getSeverity()	Gets the value of the severity property.
Expression	getSource()	Gets the value of the source property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
void	setCode(Expression value)	Sets the value of the code property.
void	setCondition(Expression value)	Sets the value of the condition property.
void	setMessage(Expression value)	Sets the value of the message property.
void	setSeverity(Expression value)	Sets the value of the severity property.
void	setSource(Expression value)	Sets the value of the source property.
String	toString()
Message	withAnnotation(Collection<CqlToElmBase> values)
Message	withAnnotation(CqlToElmBase... values)
Message	withCode(Expression value)
Message	withCondition(Expression value)
Message	withLocalId(String value)
Message	withLocator(String value)
Message	withMessage(Expression value)
Message	withResultTypeName(QName value)
Message	withResultTypeSpecifier(TypeSpecifier value)
Message	withSeverity(Expression value)
Message	withSignature(Collection<TypeSpecifier> values)
Message	withSignature(TypeSpecifier... values)
Message	withSource(Expression value)

Methods inherited from class org.cqframework.cql.elm.execution.OperatorExpression

getSignature

Methods inherited from class org.cqframework.cql.elm.execution.Element

getAnnotation, getLocalId, getLocator, getResultTypeName, getResultTypeSpecifier, setLocalId, setLocator, setResultTypeName, setResultTypeSpecifier

Methods inherited from class org.opencds.cqf.cql.engine.elm.execution.Executable

evaluate, internalEvaluate

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Field Details

source

protected Expression source

condition

protected Expression condition

code

protected Expression code

severity

protected Expression severity

message

protected Expression message

Constructor Details

Message

public Message()

Method Details

getSource

public Expression getSource()

Gets the value of the source property.

Returns:

possible object is Expression

setSource

public void setSource(Expression value)

Sets the value of the source property.

Parameters:

value - allowed object is Expression

getCondition

public Expression getCondition()

Gets the value of the condition property.

Returns:

possible object is Expression

setCondition

public void setCondition(Expression value)

Sets the value of the condition property.

Parameters:

value - allowed object is Expression

getCode

public Expression getCode()

Gets the value of the code property.

Returns:

possible object is Expression

setCode

public void setCode(Expression value)

Sets the value of the code property.

Parameters:

value - allowed object is Expression

getSeverity

public Expression getSeverity()

Gets the value of the severity property.

Returns:

possible object is Expression

setSeverity

public void setSeverity(Expression value)

Sets the value of the severity property.

Parameters:

value - allowed object is Expression

getMessage

public Expression getMessage()

Gets the value of the message property.

Returns:

possible object is Expression

setMessage

public void setMessage(Expression value)

Sets the value of the message property.

Parameters:

value - allowed object is Expression

withSource

public Message withSource(Expression value)

withCondition

public Message withCondition(Expression value)

withCode

public Message withCode(Expression value)

withSeverity

public Message withSeverity(Expression value)

withMessage

public Message withMessage(Expression value)

withSignature

public Message withSignature(TypeSpecifier... values)

Overrides:

withSignature in class OperatorExpression

withSignature

public Message withSignature(Collection<TypeSpecifier> values)

Overrides:

withSignature in class OperatorExpression

withAnnotation

public Message withAnnotation(CqlToElmBase... values)

Overrides:

withAnnotation in class OperatorExpression

withAnnotation

public Message withAnnotation(Collection<CqlToElmBase> values)

Overrides:

withAnnotation in class OperatorExpression

withResultTypeSpecifier

public Message withResultTypeSpecifier(TypeSpecifier value)

Overrides:

withResultTypeSpecifier in class OperatorExpression

withLocalId

public Message withLocalId(String value)

Overrides:

withLocalId in class OperatorExpression

withLocator

public Message withLocator(String value)

Overrides:

withLocator in class OperatorExpression

withResultTypeName

public Message withResultTypeName(QName value)

Overrides:

withResultTypeName in class OperatorExpression

equals

public boolean equals(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
 org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
 Object object,
 org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)

Specified by:

equals in interface org.jvnet.jaxb2_commons.lang.Equals2

Overrides:

equals in class OperatorExpression

equals

public boolean equals(Object object)

Overrides:

equals in class OperatorExpression

hashCode

public int hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)

Specified by:

hashCode in interface org.jvnet.jaxb2_commons.lang.HashCode2

Overrides:

hashCode in class OperatorExpression

hashCode

public int hashCode()

Overrides:

hashCode in class OperatorExpression

toString

public String toString()

Overrides:

toString in class OperatorExpression

append

public StringBuilder append(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

Specified by:

append in interface org.jvnet.jaxb2_commons.lang.ToString2

Overrides:

append in class OperatorExpression

appendFields

public StringBuilder appendFields(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
 StringBuilder buffer,
 org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)

Specified by:

appendFields in interface org.jvnet.jaxb2_commons.lang.ToString2

Overrides:

appendFields in class OperatorExpression