uk.ac.sheffield.jast.xpath

Class ContentAxisRule

java.lang.Object

uk.ac.sheffield.jast.xpath.XPathRule

uk.ac.sheffield.jast.xpath.ContentAxisRule

Direct Known Subclasses:

ChildAxisRule

public class ContentAxisRule
extends XPathRule

ContentAxisRule is an XPathRule that selects the context node's contents. ContentAxisRule is the rule that navigates along the child-axis of the XML tree, returning zero or more general Content nodes that match the query pattern. By default, this returns all the Content nodes under the context node, but a Filter restriction may be applied to specify any particular kind of Content, such as a Comment, or Instruction, or Text and Data.

Version:

2.5

Author:

Anthony J H Simons

Field Summary

Fields inherited from class uk.ac.sheffield.jast.xpath.XPathRule

filter

Constructor Summary

Constructors

Constructor and Description
ContentAxisRule() Creates a ContentAxisRule that returns any Content children.
ContentAxisRule(Filter filter) Creates a ContentAxisRule that returns any Content children passed by the supplied Filter.

Method Summary

Modifier and Type	Method and Description
java.util.List<Content>	apply(Content context) Applies this rule to the context node, returning any matching nodes.

Methods inherited from class uk.ac.sheffield.jast.xpath.XPathRule

broaden, getFilter, restrict, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ContentAxisRule

public ContentAxisRule()

Creates a ContentAxisRule that returns any Content children. This rule accepts all addressable XPath Content, with no further restriction.

ContentAxisRule

public ContentAxisRule(Filter filter)

Creates a ContentAxisRule that returns any Content children passed by the supplied Filter. This can be used to restrict the result to Element children, or any other kind of Content.

Parameters:

filter - a restriction on the Content children.

Method Detail

apply

public java.util.List<Content> apply(Content context)

Applies this rule to the context node, returning any matching nodes. If the context node has any contents, selects the subset that pass the the restriction filter and returns them in a list.

Overrides:

apply in class XPathRule

Parameters:

context - the current node, known as the context.

Returns:

a list of XML nodes satisfying the rule.