Interface BuiltInRuleSet

All Superinterfaces:
ContextOriginator
All Known Implementing Classes:
DeepCopyRuleSet, DeepSkipRuleSet, FailRuleSet, RuleSetWithWarnings, ShallowCopyAllRuleSet, ShallowCopyRuleSet, ShallowSkipRuleSet, TextOnlyCopyRuleSet

public interface BuiltInRuleSet extends ContextOriginator
Defines a set of built-in template rules (rules for use when no user-defined template rules match a given node)
  • Method Details

    • process

      void process(Item item, ParameterSet parameters, ParameterSet tunnelParams, Outputter output, XPathContext context, Location locationId) throws XPathException
      Perform the built-in template action for a given item.
      Parameters:
      item - the item to be processed
      parameters - the parameters supplied to apply-templates
      tunnelParams - the tunnel parameters to be passed through
      output - the destination for the result
      context - the dynamic evaluation context
      locationId - location of the instruction (apply-templates, apply-imports etc) that caused the built-in template to be invoked
      Throws:
      XPathException - if any dynamic error occurs
    • getName

      String getName()
      Identify this built-in rule set
      Returns:
      the XSLT keyword used to identify this rule-set, for example "deep-copy"
    • getActionForParentNodes

      BuiltInRules[] getActionForParentNodes(int nodeKind)
      Get the action for unmatched element and document nodes (used when streaming)
      Parameters:
      nodeKind - the node kind: either Type.DOCUMENT or Type.ELEMENT
      Returns:
      the sequence of actions to be taken