Class ElementCreator

    • Field Detail

      • inheritNamespaces

        protected boolean inheritNamespaces
        The inheritNamespaces flag indicates that the namespace nodes on the element created by this instruction are to be inherited (copied) on the children of this element. That is, if this flag is false, the child elements must carry a namespace undeclaration for all the namespaces on the parent, unless they are redeclared in some way.
      • preservingTypes

        protected boolean preservingTypes
        Flag set to true if validation=preserve and no schema type supplied for validation
    • Constructor Detail

      • ElementCreator

        public ElementCreator()
        Construct an ElementCreator. Exists for the benefit of subclasses.
    • Method Detail

      • getItemType

        public ItemType getItemType​(TypeHierarchy th)
        Get the item type of the value returned by this instruction
        Overrides:
        getItemType in class Instruction
        Parameters:
        th - the type hierarchy cache
        Returns:
        the item type
      • isPreservingTypes

        public boolean isPreservingTypes()
        Determine whether this elementCreator performs validation or strips type annotations
        Returns:
        false if the instruction performs validation of the constructed output or if it strips type annotations, otherwise true
      • isInheritNamespaces

        public boolean isInheritNamespaces()
        Determine whether the inherit namespaces flag is set
        Returns:
        true if namespaces constructed on a parent element are to be inherited by its children
      • computeSpecialProperties

        public 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 Instruction
        Returns:
        a set of flags indicating static properties of this expression
      • suppressValidation

        public void suppressValidation​(int validationMode)
        Suppress validation on contained element constructors, on the grounds that the parent element is already performing validation. The default implementation does nothing.
        Overrides:
        suppressValidation in class Expression
        Parameters:
        validationMode - the kind of validation being performed on the parent expression
      • getNameCode

        public abstract int getNameCode​(XPathContext context)
                                 throws XPathException
        Determine (at run-time) the name code of the element being constructed
        Parameters:
        context - the XPath dynamic evaluation context
        Returns:
        the integer name code representing the element name
        Throws:
        XPathException - if a failure occurs
      • getNewBaseURI

        public abstract java.lang.String getNewBaseURI​(XPathContext context)
        Get the base URI for the element being constructed
        Parameters:
        context - the XPath dynamic evaluation context
        Returns:
        the base URI of the constructed element
      • outputNamespaceNodes

        protected abstract void outputNamespaceNodes​(XPathContext context,
                                                     Receiver receiver)
                                              throws XPathException
        Callback to output namespace nodes for the new element.
        Parameters:
        context - The execution context
        receiver - the Receiver where the namespace nodes are to be written
        Throws:
        XPathException
      • getActiveNamespaces

        public int[] getActiveNamespaces()
                                  throws XPathException
        Callback to get a list of the intrinsic namespaces that need to be generated for the element.
        Returns:
        an array of namespace codes, the codes either occupy the whole array or are terminated by a -1 entry. A result of null is equivalent to a zero-length array.
        Throws:
        XPathException
      • iterateEvents

        public EventIterator iterateEvents​(XPathContext context)
                                    throws XPathException
        Description copied from class: Expression
        Deliver the result of the expression as a sequence of events.

        The events (of class PullEvent) are either complete items, or one of startElement, endElement, startDocument, or endDocument, known as semi-nodes. The stream of events may also include a nested EventIterator. If a start-end pair exists in the sequence, then the events between this pair represent the content of the document or element. The content sequence will have been processed to the extent that any attribute and namespace nodes in the content sequence will have been merged into the startElement event. Namespace fixup will have been performed: that is, unique prefixes will have been allocated to element and attribute nodes, and all namespaces will be declared by means of a namespace node in the startElement event or in an outer startElement forming part of the sequence. However, duplicate namespaces may appear in the sequence.

        The content of an element or document may include adjacent or zero-length text nodes, atomic values, and nodes represented as nodes rather than broken down into events.

        Overrides:
        iterateEvents in class Expression
        Parameters:
        context - The dynamic evaluation context
        Returns:
        the result of the expression as an iterator over a sequence of PullEvent objects
        Throws:
        XPathException - if a dynamic error occurs during expression evaluation
      • evaluateItem

        public Item evaluateItem​(XPathContext context)
                          throws XPathException
        Evaluate the constructor, returning the constructed element node. If lazy construction mode is in effect, then an UnconstructedParent object is returned instead.
        Specified by:
        evaluateItem in interface EvaluableItem
        Overrides:
        evaluateItem in class Instruction
        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