Class GlobalParam

  • All Implemented Interfaces:
    javax.xml.transform.SourceLocator, Binding, ContextOriginator, ExpressionOwner, Locatable, Declaration, Location, Traceable, TraceableComponent, org.xml.sax.Locator

    public final class GlobalParam
    extends GlobalVariable
    The compiled form of a global xsl:param element in an XSLT stylesheet or an external variable declared in the prolog of a Query.
    The xsl:param element in XSLT has mandatory attribute name and optional attribute select. It can also be specified as required="yes" or required="no". In standard XQuery 1.0 external variables are always required, and no default value can be specified; but Saxon provides an extension pragma that allows a query to specify a default. XQuery 1.1 adds standard syntax for defining a default value.
    • Constructor Detail

      • GlobalParam

        public GlobalParam()
    • Method Detail

      • setImplicitlyRequiredParam

        public void setImplicitlyRequiredParam​(boolean requiredParam)
        Indicate that this parameter is implicitly required, because the default value does not match the type
        requiredParam - true if this is a required parameter
      • isImplicitlyRequiredParam

        public boolean isImplicitlyRequiredParam()
        Ask whether this variable represents a required parameter
        true if this variable represents a required parameter
      • getTracingTag

        public java.lang.String getTracingTag()
        Description copied from class: Actor
        Get a string used to identify this kind of component when used in tracing output
        Specified by:
        getTracingTag in interface TraceableComponent
        getTracingTag in class GlobalVariable
        a diagnostic string used to identify the component when tracing
      • evaluateVariable

        public GroundedValue evaluateVariable​(XPathContext context,
                                              Component target)
                                       throws XPathException
        Evaluate the variable
        evaluateVariable in class GlobalVariable
        context - the XPath dynamic context
        target - the component representing this variable (in the context of a package where it is used)
        the value of the variable
        XPathException - if evaluation of the variable fails with a dynamic error