Package net.sf.saxon.expr

Class CardinalityChecker

    • Method Detail

      • makeCardinalityChecker

        public static Expression makeCardinalityChecker​(Expression sequence,
                                                int cardinality,
                                                RoleDiagnostic role)
        Factory method to construct a CardinalityChecker. The method may create an expression that combines the cardinality checking with the functionality of the underlying expression class
        Parameters:
        sequence - the base sequence whose cardinality is to be checked
        cardinality - the required cardinality
        role - information to be used in error reporting
        Returns:
        a new Expression that does the CardinalityChecking (not necessarily a CardinalityChecker)

      • getRequiredCardinality

        public int getRequiredCardinality()
        Get the required cardinality
        Returns:
        the cardinality required by this checker

      • typeCheck

        public Expression typeCheck​(ExpressionVisitor visitor,
                            ContextItemStaticInfo contextInfo)
                     throws XPathException
        Type-check the expression
        Overrides:
        typeCheck in class UnaryExpression
        Parameters:
        visitor - an expression visitor
        contextInfo - Information available statically about the context item: whether it is (possibly) absent; its static type; its streaming posture.
        Returns:
        the original expression, rewritten to perform necessary run-time type checks, and to perform other type-related optimizations
        Throws:
        XPathException - if an error is discovered during this phase (typically a type error)

      • optimize

        public Expression optimize​(ExpressionVisitor visitor,
                           ContextItemStaticInfo contextInfo)
                    throws XPathException
        Perform optimisation of an expression and its subexpressions.

        This method is called after all references to functions and variables have been resolved to the declaration of the function or variable, and after all type checking has been done.

        Overrides:
        optimize in class UnaryExpression
        Parameters:
        visitor - an expression visitor
        contextInfo - the static type of "." at the point where this expression is invoked. The parameter is set to null if it is known statically that the context item will be undefined. If the type of the context item is not known statically, the argument is set to Type.ITEM_TYPE
        Returns:
        the original expression, rewritten if appropriate to optimize execution
        Throws:
        XPathException - if an error is discovered during this phase (typically a type error)

      • setErrorCode

        public void setErrorCode​(java.lang.String code)
        Set the error code to be returned (this is used when evaluating the functions such as exactly-one() which have their own error codes)
        Parameters:
        code - the error code to be used

      • getRoleLocator

        public RoleDiagnostic getRoleLocator()
        Get the RoleLocator, which contains diagnostic information for use if the cardinality check fails
        Returns:
        the diagnostic information

      • getIntegerBounds

        public IntegerValue[] getIntegerBounds()
        For an expression that returns an integer or a sequence of integers, get a lower and upper bound on the values of the integers that may be returned, from static analysis. The default implementation returns null, meaning "unknown" or "not applicable". Other implementations return an array of two IntegerValue objects, representing the lower and upper bounds respectively. The values UNBOUNDED_LOWER and UNBOUNDED_UPPER are used by convention to indicate that the value may be arbitrarily large. The values MAX_STRING_LENGTH and MAX_SEQUENCE_LENGTH are used to indicate values limited by the size of a string or the size of a sequence.
        Overrides:
        getIntegerBounds in class Expression
        Returns:
        the lower and upper bounds of integer values in the result, or null to indicate unknown or not applicable.

      • iterate

        public SequenceIterator iterate​(XPathContext context)
                         throws XPathException
        Iterate over the sequence of values
        Overrides:
        iterate in class Expression
        Parameters:
        context - supplies the context for evaluation
        Returns:
        a SequenceIterator that can be used to iterate over the result of the expression
        Throws:
        XPathException - if any dynamic error occurs evaluating the expression

      • depictSequenceStart

        public static java.lang.String depictSequenceStart​(SequenceIterator seq,
                                                   int max)
        Show the first couple of items in a sequence in an error message
        Parameters:
        seq - iterator over the sequence
        max - maximum number of items to be shown
        Returns:
        a message display of the contents of the sequence

      • evaluateItem

        public Item evaluateItem​(XPathContext context)
                  throws XPathException
        Evaluate as an Item. For this class, this implies checking that the underlying expression delivers a singleton.
        Overrides:
        evaluateItem in class Expression
        Parameters:
        context - The context in which the expression is to be evaluated
        Returns:
        the node or atomic value that results from evaluating the expression; or null to indicate that the result is an empty sequence
        Throws:
        XPathException - if any dynamic error occurs evaluating the expression

      • process

        public void process​(Outputter output,
                    XPathContext context)
             throws XPathException
        Process the instruction, without returning any tail calls
        Overrides:
        process in class Expression
        Parameters:
        output - the destination for the result
        context - The dynamic context, giving access to the current node,
        Throws:
        XPathException - if a dynamic error occurs

      • getItemType

        public ItemType getItemType()
        Determine the data type of the items returned by the expression, if possible
        Overrides:
        getItemType in class UnaryExpression
        Returns:
        a value such as Type.STRING, Type.BOOLEAN, Type.NUMBER, Type.NODE, or Type.ITEM (meaning not known in advance)

      • computeSpecialProperties

        protected int computeSpecialProperties()
        Get the static properties of this expression (other than its type). The result is bit-signficant. These properties are used for optimizations. In general, if property bit is set, it is true, but if it is unset, the value is unknown.
        Overrides:
        computeSpecialProperties in class UnaryExpression
        Returns:
        the special properties, as a bit-significant integer

      • copy

        public Expression copy​(RebindingMap rebindings)
        Copy an expression. This makes a deep copy.
        Specified by:
        copy in class Expression
        Parameters:
        rebindings - variable bindings that need to be changed
        Returns:
        the copy of the original expression

      • equals

        public boolean equals​(java.lang.Object other)
        Is this expression the same as another expression?
        Overrides:
        equals in class UnaryExpression
        Parameters:
        other - the other operand; the result is false if this is not an Expression
        Returns:
        true if the other operand is an expression and if it can be determined that the two expressions are equivalent, in the sense that they will always return the same result.

      • computeHashCode

        protected int computeHashCode()
        get HashCode for comparing two expressions. Note that this hashcode gives the same result for (A op B) and for (B op A), whether or not the operator is commutative.
        Overrides:
        computeHashCode in class UnaryExpression
        Returns:
        a computed hash code

      • export

        public void export​(ExpressionPresenter out)
            throws XPathException
        Diagnostic print of expression structure. The abstract expression tree is written to the supplied output destination.
        Specified by:
        export in interface ExportAgent
        Overrides:
        export in class UnaryExpression
        Parameters:
        out - the expression presenter used to display the structure
        Throws:
        XPathException - if the export fails, for example if an expression is found that won't work in the target environment.

      • toString

        public java.lang.String toString()
        The toString() method for an expression attempts to give a representation of the expression in an XPath-like form. For subclasses of Expression that represent XPath expressions, the result should always be a string that parses as an XPath 3.0 expression.
        Overrides:
        toString in class UnaryExpression
        Returns:
        a representation of the expression as a string

      • getExpressionName

        public java.lang.String getExpressionName()
        Get a name identifying the kind of expression, in terms meaningful to a user.
        Overrides:
        getExpressionName in class Expression
        Returns:
        a name identifying the kind of expression, in terms meaningful to a user. The name will always be in the form of a lexical XML QName, and should match the name used in explain() output displaying the expression.

      • toShortString

        public java.lang.String toShortString()
        Description copied from class: Expression
        Produce a short string identifying the expression for use in error messages
        Overrides:
        toShortString in class UnaryExpression
        Returns:
        a short string, sufficient to identify the expression

      • getStreamerName

        public java.lang.String getStreamerName()
        Description copied from class: Expression
        Get the (partial) name of a class that supports streaming of this kind of expression
        Overrides:
        getStreamerName in class Expression
        Returns:
        the partial name of a class that can be instantiated to provide streaming support in Saxon-EE, or null if there is no such class

      • setLocation

        public void setLocation​(Location id)
        Description copied from class: Expression
        Set the location on an expression.
        Overrides:
        setLocation in class Expression
        Parameters:
        id - the location