Package org.cqframework.cql.elm.execution

Class ParameterDef

  • All Implemented Interfaces:
    org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
    public class ParameterDef
extends Element
implements org.jvnet.jaxb2_commons.lang.Equals2, org.jvnet.jaxb2_commons.lang.HashCode2, org.jvnet.jaxb2_commons.lang.ToString2
    The ParameterDef type defines a parameter that can be referenced by name anywhere within an expression. Parameters are defined at the artifact level, and may be provided as part of the payload for an evaluation request. If no parameter value is provided, the default element is used to provide the value for the parameter. If no parameter or default is provided, the parameter is defined to be null. Note that the expression specified in the default element must be able to be evaluated at compile-time (i.e. without reference to any run-time capabilities such as data, terminology, and library references, both local and included).

    Java class for ParameterDef complex type.

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

     <complexType name="ParameterDef">
   <complexContent>
     <extension base="{urn:hl7-org:elm:r1}Element">
       <sequence>
         <element name="default" type="{urn:hl7-org:elm:r1}Expression" minOccurs="0"/>
         <element name="parameterTypeSpecifier" type="{urn:hl7-org:elm:r1}TypeSpecifier" minOccurs="0"/>
       </sequence>
       <attribute name="name" type="{http://www.w3.org/2001/XMLSchema}string" />
       <attribute name="parameterType" type="{http://www.w3.org/2001/XMLSchema}QName" />
       <attribute name="accessLevel" type="{urn:hl7-org:elm:r1}AccessModifier" default="Public" />
     </extension>
   </complexContent>
 </complexType>

    • Field Detail

      • parameterTypeSpecifier

        protected TypeSpecifier parameterTypeSpecifier

      • name

        protected java.lang.String name

      • parameterType

        protected javax.xml.namespace.QName parameterType

    • Constructor Detail

      • ParameterDef

        public ParameterDef()

    • Method Detail

      • getDefault

        public Expression getDefault()
        Gets the value of the default property.
        Returns:
        possible object is Expression

      • setDefault

        public void setDefault​(Expression value)
        Sets the value of the default property.
        Parameters:
        value - allowed object is Expression

      • getParameterTypeSpecifier

        public TypeSpecifier getParameterTypeSpecifier()
        Gets the value of the parameterTypeSpecifier property.
        Returns:
        possible object is TypeSpecifier

      • setParameterTypeSpecifier

        public void setParameterTypeSpecifier​(TypeSpecifier value)
        Sets the value of the parameterTypeSpecifier property.
        Parameters:
        value - allowed object is TypeSpecifier

      • getName

        public java.lang.String getName()
        Gets the value of the name property.
        Returns:
        possible object is String

      • setName

        public void setName​(java.lang.String value)
        Sets the value of the name property.
        Parameters:
        value - allowed object is String

      • getParameterType

        public javax.xml.namespace.QName getParameterType()
        Gets the value of the parameterType property.
        Returns:
        possible object is QName

      • setParameterType

        public void setParameterType​(javax.xml.namespace.QName value)
        Sets the value of the parameterType property.
        Parameters:
        value - allowed object is QName

      • getAccessLevel

        public AccessModifier getAccessLevel()
        Gets the value of the accessLevel property.
        Returns:
        possible object is AccessModifier

      • setAccessLevel

        public void setAccessLevel​(AccessModifier value)
        Sets the value of the accessLevel property.
        Parameters:
        value - allowed object is AccessModifier

      • withName

        public ParameterDef withName​(java.lang.String value)

      • withParameterType

        public ParameterDef withParameterType​(javax.xml.namespace.QName value)

      • equals

        public boolean equals​(org.jvnet.jaxb2_commons.locator.ObjectLocator thisLocator,
                      org.jvnet.jaxb2_commons.locator.ObjectLocator thatLocator,
                      java.lang.Object object,
                      org.jvnet.jaxb2_commons.lang.EqualsStrategy2 strategy)
        Specified by:
        equals in interface org.jvnet.jaxb2_commons.lang.Equals2
        Overrides:
        equals in class Element

      • equals

        public boolean equals​(java.lang.Object object)
        Overrides:
        equals in class Element

      • 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 Element

      • toString

        public java.lang.String toString()
        Overrides:
        toString in class Element

      • append

        public java.lang.StringBuilder append​(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                                      java.lang.StringBuilder buffer,
                                      org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
        Specified by:
        append in interface org.jvnet.jaxb2_commons.lang.ToString2
        Overrides:
        append in class Element

      • appendFields

        public java.lang.StringBuilder appendFields​(org.jvnet.jaxb2_commons.locator.ObjectLocator locator,
                                            java.lang.StringBuilder buffer,
                                            org.jvnet.jaxb2_commons.lang.ToStringStrategy2 strategy)
        Specified by:
        appendFields in interface org.jvnet.jaxb2_commons.lang.ToString2
        Overrides:
        appendFields in class Element