net.sf.saxon.trans.rules

Class ShallowSkipRuleSet

java.lang.Object

net.sf.saxon.trans.rules.ShallowSkipRuleSet

All Implemented Interfaces:

ContextOriginator, BuiltInRuleSet

public class ShallowSkipRuleSet
extends java.lang.Object
implements BuiltInRuleSet

A built-in set of template rules that ignores the current node and does an apply-templates to its children.

Method Summary

Modifier and Type	Method and Description
BuiltInRules[]	getActionForParentNodes(int nodeKind) Get the default action for unmatched nodes
static ShallowSkipRuleSet	getInstance() Get the singleton instance of this class
java.lang.String	getName() Identify this built-in rule set
void	process(Item item, ParameterSet parameters, ParameterSet tunnelParams, Outputter output, XPathContext context, Location locationId) Perform the built-in template action for a given item.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getInstance

public static ShallowSkipRuleSet getInstance()

Get the singleton instance of this class

Returns:

the singleton instance

process

public 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.

Specified by:

process in interface BuiltInRuleSet

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

public java.lang.String getName()

Identify this built-in rule set

Specified by:

getName in interface BuiltInRuleSet

Returns:

"shallow-skip"

getActionForParentNodes

public BuiltInRules[] getActionForParentNodes(int nodeKind)

Get the default action for unmatched nodes

Specified by:

getActionForParentNodes in interface BuiltInRuleSet

Parameters:

nodeKind - the node kind

Returns:

the default action for unmatched nodes: one of DEEP_COPY, APPLY_TEMPLATES, DEEP_SKIP, FAIL