uk.ac.sheffield.jast.xpath

Class ParentAxisRule

java.lang.Object

uk.ac.sheffield.jast.xpath.XPathRule

uk.ac.sheffield.jast.xpath.ParentAxisRule

public class ParentAxisRule
extends XPathRule

ParentAxisRule is an XPathRule that selects the parent of the context node. ParentAxisRule is the rule that navigates upward in the XML tree to the parent of the context node. It is created for XPath segments containing "..", the instruction to select the immediate parent node. It may also apply filter restrictions to the parent node, in which case, it may also return the empty list.

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
ParentAxisRule() Creates a ParentAxisRule that returns any parent node.
ParentAxisRule(Filter filter) Creates a ParentAxisRule that returns only parent nodes 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

ParentAxisRule

public ParentAxisRule()

Creates a ParentAxisRule that returns any parent node. Installs a NodeFilter accepting ELEMENT and DOCUMENT content-types.

ParentAxisRule

public ParentAxisRule(Filter filter)

Creates a ParentAxisRule that returns only parent nodes passed by the supplied Filter. This can be used to restrict the parents to nodes with further properties.

Parameters:

filter - a restriction on the parent node.

Method Detail

apply

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

Applies this rule to the context node, returning any matching nodes. If the parent is accepted by this rule's filter restriction, which by default accepts Elements and the Document, returns the parent node as a singleton list. Otherwise, returns an empty list.

Overrides:

apply in class XPathRule

Parameters:

context - the current node, known as the context.

Returns:

a list of XML nodes satisfying the rule.