Package net.sf.saxon.expr.instruct

Class ElementCreator

java.lang.Object
net.sf.saxon.expr.Expression
net.sf.saxon.expr.instruct.Instruction
net.sf.saxon.expr.instruct.ParentNodeConstructor
net.sf.saxon.expr.instruct.ElementCreator
All Implemented Interfaces:
ExportAgent, InstructionWithComplexContent, ValidatingInstruction, Locatable, IdentityComparable, Traceable
Direct Known Subclasses:
ComputedElement, Copy, FixedElement
public abstract class ElementCreator extends ParentNodeConstructor
An instruction that creates an element node. There are two subtypes, FixedElement for use where the name is known statically, and Element where it is computed dynamically. To allow use in both XSLT and XQuery, the class acts both as an Instruction and as an Expression.

  • Constructor Details

    • ElementCreator

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

  • Method Details

    • getItemType

      public ItemType getItemType()
      Get the item type of the value returned by this instruction
      Overrides:
      getItemType in class Instruction
      Returns:
      the item type

    • getCardinality

      public int getCardinality()
      Description copied from class: Expression
      Determine the static cardinality of the expression. This establishes how many items there will be in the result of the expression, at compile time (i.e., without actually evaluating the result.
      Overrides:
      getCardinality in class ParentNodeConstructor
      Returns:
      one of the values Cardinality.ONE_OR_MORE, Cardinality.ZERO_OR_MORE, Cardinality.EXACTLY_ONE, Cardinality.ZERO_OR_ONE, Cardinality.EMPTY. This default implementation returns ZERO_OR_MORE (which effectively gives no information).

    • setBequeathNamespacesToChildren

      public void setBequeathNamespacesToChildren(boolean inherit)
      Say whether this element causes its children to inherit namespaces
      Parameters:
      inherit - true if namespaces are to be inherited by the children

    • isBequeathNamespacesToChildren

      public boolean isBequeathNamespacesToChildren()
      Ask whether the inherit namespaces flag is set
      Returns:
      true if namespaces constructed on this parent element are to be inherited by its children

    • setInheritNamespacesFromParent

      public void setInheritNamespacesFromParent(boolean inherit)
      Say whether this element causes inherits namespaces from its parent. True except in XQuery where one direct element constructor forms the immediate content of another (see W3C bug 22334)
      Parameters:
      inherit - true if namespaces are to be inherited from the parent

    • isInheritNamespacesFromParent

      public boolean isInheritNamespacesFromParent()
      Ask whether this element inherits namespaces from its parent. True except in XQuery where one direct element constructor forms the immediate content of another (see W3C bug 22334)
      Returns:
      true if this child element inherits namespaces from its parent element

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

    • suppressValidation

      public void suppressValidation(int parentValidationMode)
      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:
      parentValidationMode - the kind of validation being performed on the parent expression

    • checkContentSequence

      protected void checkContentSequence(StaticContext env) throws XPathException
      Check statically whether the content of the element creates attributes or namespaces after creating any child nodes
      Specified by:
      checkContentSequence in class ParentNodeConstructor
      Parameters:
      env - the static context
      Throws:
      XPathException - if the content is found to be incorrect

    • outputNamespaceNodes

      public abstract void outputNamespaceNodes(Outputter receiver, NodeName nodeName, ElementCreator.ElementCreationDetails details) throws XPathException
      Callback to output namespace bindings for the new element. This method is responsible for ensuring that a namespace binding is always generated for the namespace of the element name itself.
      Parameters:
      receiver - the Outputter where the namespace bindings are to be written
      nodeName - the name of the element being created
      details - details supplied to the process() call
      Throws:
      XPathException - if a dynamic error occurs

    • getImplementationMethod

      public int getImplementationMethod()
      An implementation of Expression must provide at least one of the methods evaluateItem(), iterate(), or process(). This method indicates which of these methods is prefered. For instructions this is the process() method.
      Overrides:
      getImplementationMethod in class Instruction
      Returns:
      the implementation method, for example Expression.ITERATE_METHOD or Expression.EVALUATE_METHOD or Expression.PROCESS_METHOD

    • setInheritanceFlags

      public void setInheritanceFlags(String flags)

    • makeElementCreationDetails

      public ElementCreator.ElementCreationDetails makeElementCreationDetails()

    • getStreamerName

      public String getStreamerName()
      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