Field Detail

• DEFAULT_MODE

  public static final int DEFAULT_MODE

  See Also:

  Constant Field Values

• NAMED_MODE

  public static final int NAMED_MODE

  See Also:

  Constant Field Values

• STRIPPER_MODE

  public static final int STRIPPER_MODE

  See Also:

  Constant Field Values

• ALL_MODES

  public static final StructuredQName ALL_MODES

• DEFAULT_MODE_NAME

  public static final StructuredQName DEFAULT_MODE_NAME

Constructor Detail

• Mode

  public Mode​(int usage,
              StructuredQName modeName)

  Default constructor - creates a Mode containing no rules

  Parameters:

  usage - one of DEFAULT_MODE, NAMED_MODE, STRIPPER_MODE

  modeName - the name of the mode

• Mode

  public Mode​(Mode omniMode,
              StructuredQName modeName)

  Construct a new Mode, copying the contents of an existing Mode

  Parameters:

  omniMode - the existing mode. May be null, in which case it is not copied

  modeName - the name of the new mode to be created

Method Detail

• isDefaultMode

  public boolean isDefaultMode​()

  Determine if this is the default mode

  Returns:

  true if this is the default (unnamed) mode

• getModeName

  public StructuredQName getModeName​()

  Get the name of the mode (for diagnostics only)

  Returns:

  the mode name. Null for the default (unnamed) mode

• isEmpty

  public boolean isEmpty​()

  Ask whether there are any template rules in this mode (a mode could exist merely because it is referenced in apply-templates)

  Returns:

  true if no template rules exist in this mode

• addRule

  public void addRule​(Pattern p,
                      java.lang.Object action,
                      int precedence,
                      double priority,
                      boolean explicitMode)

  Add a rule to the Mode.

  Parameters:

  p - a Pattern

  action - the Object to return from getRule() when the supplied node matches this Pattern

  precedence - the import precedence of the rule

  priority - the explicit or implicit priority of the rule

  explicitMode - true if adding a template rule for a specific (default or named) mode; false if adding a rule because it applies to all modes

• getList

  public int getList​(int fingerprint,
                     int kind)

  Determine which list to use for a given pattern (we must also search the generic list)

  Parameters:

  fingerprint - the name of the node being matched

  kind - the node kind of the node being matched

  Returns:

  an index in the hash array for this node name and kind

• getRule

  public Rule getRule​(NodeInfo node,
                      XPathContext context)
               throws XPathException

  Get the rule corresponding to a given Node, by finding the best Pattern match.

  Parameters:

  node - the NodeInfo referring to the node to be matched

  context - the XPath dynamic evaluation context

  Returns:

  the best matching rule, if any (otherwise null).

  Throws:

  XPathException

• getRule

  public Rule getRule​(NodeInfo node,
                      int min,
                      int max,
                      XPathContext context)
               throws XPathException

  Get the rule corresponding to a given Node, by finding the best Pattern match, subject to a minimum and maximum precedence. (This supports xsl:apply-imports)

  Parameters:

  node - the NodeInfo referring to the node to be matched

  min - the minimum import precedence

  max - the maximum import precedence

  context - the XPath dynamic evaluation context

  Returns:

  the Rule registered for that node, if any (otherwise null).

  Throws:

  XPathException

• getNextMatchRule

  public Rule getNextMatchRule​(NodeInfo node,
                               Rule currentRule,
                               XPathContext context)
                        throws XPathException

  Get the rule corresponding to a given Node, by finding the next-best Pattern match after the specified object.

  Parameters:

  node - the NodeInfo referring to the node to be matched

  currentRule - the current rule; we are looking for the next match after the current rule

  context - the XPath dynamic evaluation context

  Returns:

  the object (e.g. a NodeHandler) registered for that element, if any (otherwise null).

  Throws:

  XPathException

• explainTemplateRules

  public void explainTemplateRules​(ExpressionPresenter presenter)

  Explain all template rules in this mode by showing their expression tree represented in XML.

  Parameters:

  presenter - used to display the expression tree