Package org.cqframework.cql.elm.execution

Class FunctionDef

java.lang.Object

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

org.cqframework.cql.elm.execution.Element

org.cqframework.cql.elm.execution.ExpressionDef

org.cqframework.cql.elm.execution.FunctionDef

All Implemented Interfaces:

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

public class FunctionDef
extends ExpressionDef
implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2

The FunctionDef type defines a named function that can be invoked by any expression in the artifact. Function names must be unique within the artifact. Functions may take any number of operands.

Java class for FunctionDef complex type.

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

 <complexType name="FunctionDef">
   <complexContent>
     <extension base="{urn:hl7-org:elm:r1}ExpressionDef">
       <sequence>
         <element name="operand" type="{urn:hl7-org:elm:r1}OperandDef" maxOccurs="unbounded" minOccurs="0"/>
       </sequence>
       <attribute name="external" type="{http://www.w3.org/2001/XMLSchema}boolean" />
       <attribute name="fluent" type="{http://www.w3.org/2001/XMLSchema}boolean" />
     </extension>
   </complexContent>
 </complexType>
 

Field Summary

Fields

Modifier and Type	Field	Description
protected Boolean	external
protected Boolean	fluent
protected List<OperandDef>	operand

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

accessLevel, context, expression, name

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

annotation, localId, locator, resultTypeName, resultTypeSpecifier

Constructor Summary

Constructors

Constructor	Description
FunctionDef()

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)
List<OperandDef>	getOperand()	Gets the value of the operand property.
int	hashCode()
int	hashCode(org.jvnet.jaxb2_commons.locator.ObjectLocator locator, org.jvnet.jaxb2_commons.lang.HashCodeStrategy2 strategy)
Boolean	isExternal()	Gets the value of the external property.
Boolean	isFluent()	Gets the value of the fluent property.
void	setExternal(Boolean value)	Sets the value of the external property.
void	setFluent(Boolean value)	Sets the value of the fluent property.
String	toString()
FunctionDef	withAccessLevel(AccessModifier value)
FunctionDef	withAnnotation(Collection<CqlToElmBase> values)
FunctionDef	withAnnotation(CqlToElmBase... values)
FunctionDef	withContext(String value)
FunctionDef	withExpression(Expression value)
FunctionDef	withExternal(Boolean value)
FunctionDef	withFluent(Boolean value)
FunctionDef	withLocalId(String value)
FunctionDef	withLocator(String value)
FunctionDef	withName(String value)
FunctionDef	withOperand(Collection<OperandDef> values)
FunctionDef	withOperand(OperandDef... values)
FunctionDef	withResultTypeName(QName value)
FunctionDef	withResultTypeSpecifier(TypeSpecifier value)

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

getAccessLevel, getContext, getExpression, getName, setAccessLevel, setContext, setExpression, setName

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

operand

protected List<OperandDef> operand

external

protected Boolean external

fluent

protected Boolean fluent

Constructor Details

FunctionDef

public FunctionDef()

Method Details

getOperand

public List<OperandDef> getOperand()

Gets the value of the operand property.

This accessor method returns a reference to the live list, not a snapshot. Therefore any modification you make to the returned list will be present inside the JAXB object. This is why there is not a set method for the operand property.

For example, to add a new item, do as follows:

    getOperand().add(newItem);
 

Objects of the following type(s) are allowed in the list OperandDef

isExternal

public Boolean isExternal()

Gets the value of the external property.

Returns:

possible object is Boolean

setExternal

public void setExternal(Boolean value)

Sets the value of the external property.

Parameters:

value - allowed object is Boolean

isFluent

public Boolean isFluent()

Gets the value of the fluent property.

Returns:

possible object is Boolean

setFluent

public void setFluent(Boolean value)

Sets the value of the fluent property.

Parameters:

value - allowed object is Boolean

withOperand

public FunctionDef withOperand(OperandDef... values)

withOperand

public FunctionDef withOperand(Collection<OperandDef> values)

withExternal

public FunctionDef withExternal(Boolean value)

withFluent

public FunctionDef withFluent(Boolean value)

withExpression

public FunctionDef withExpression(Expression value)

Overrides:

withExpression in class ExpressionDef

withName

public FunctionDef withName(String value)

Overrides:

withName in class ExpressionDef

withContext

public FunctionDef withContext(String value)

Overrides:

withContext in class ExpressionDef

withAccessLevel

public FunctionDef withAccessLevel(AccessModifier value)

Overrides:

withAccessLevel in class ExpressionDef

withAnnotation

public FunctionDef withAnnotation(CqlToElmBase... values)

Overrides:

withAnnotation in class ExpressionDef

withAnnotation

public FunctionDef withAnnotation(Collection<CqlToElmBase> values)

Overrides:

withAnnotation in class ExpressionDef

withResultTypeSpecifier

public FunctionDef withResultTypeSpecifier(TypeSpecifier value)

Overrides:

withResultTypeSpecifier in class ExpressionDef

withLocalId

public FunctionDef withLocalId(String value)

Overrides:

withLocalId in class ExpressionDef

withLocator

public FunctionDef withLocator(String value)

Overrides:

withLocator in class ExpressionDef

withResultTypeName

public FunctionDef withResultTypeName(QName value)

Overrides:

withResultTypeName in class ExpressionDef

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 ExpressionDef

equals

public boolean equals(Object object)

Overrides:

equals in class ExpressionDef

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 ExpressionDef

hashCode

public int hashCode()

Overrides:

hashCode in class ExpressionDef

toString

public String toString()

Overrides:

toString in class ExpressionDef

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 ExpressionDef

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 ExpressionDef