Package net.sf.saxon.trans.rules

Class RuleSetWithTypeCheck

java.lang.Object

net.sf.saxon.trans.rules.RuleSetWithTypeCheck

All Implemented Interfaces:

ContextOriginator, BuiltInRuleSet

public class RuleSetWithTypeCheck
extends Object
implements BuiltInRuleSet

A set of built-in template rules that performs the same action as an underlying set of rules, but with the addition of type-checking that the result of the built-in template rules conforms to a supplied sequence type.

Constructor Summary

Constructors

Constructor	Description
RuleSetWithTypeCheck(BuiltInRuleSet baseRuleSet, SequenceType requiredType)

Method Summary

Modifier and Type	Method	Description
BuiltInRules[]	getActionForParentNodes(int nodeKind)	Get the default action for unmatched nodes
BuiltInRuleSet	getBaseRuleSet()
String	getName()	Identify this built-in rule set
SequenceType	getRequiredType()
void	outputWarning(Item item, XPathContext context)
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

Constructor Details

RuleSetWithTypeCheck

public RuleSetWithTypeCheck(BuiltInRuleSet baseRuleSet,
 SequenceType requiredType)

Method Details

getBaseRuleSet

public BuiltInRuleSet getBaseRuleSet()

getRequiredType

public SequenceType getRequiredType()

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 matched

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)

Throws:

XPathException - if the output of the built-in template rule does not match the required type

getName

public String getName()

Identify this built-in rule set

Specified by:

getName in interface BuiltInRuleSet

Returns:

the base name plus "with warnings"

outputWarning

public void outputWarning(Item item,
 XPathContext context)

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 element nodes: one of DEEP_COPY, APPLY_TEMPLATES, DEEP_SKIP, FAIL