View Javadoc

1   /*
2    $Id: IterableChildAxis.java,v 1.11 2006/06/03 20:50:12 elharo Exp $
3   
4    Copyright 2003 The Werken Company. All Rights Reserved.
5    
6   Redistribution and use in source and binary forms, with or without
7   modification, are permitted provided that the following conditions are
8   met:
9   
10    * Redistributions of source code must retain the above copyright
11      notice, this list of conditions and the following disclaimer.
12  
13    * Redistributions in binary form must reproduce the above copyright
14      notice, this list of conditions and the following disclaimer in the
15      documentation and/or other materials provided with the distribution.
16  
17    * Neither the name of the Jaxen Project nor the names of its
18      contributors may be used to endorse or promote products derived 
19      from this software without specific prior written permission.
20  
21  THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS
22  IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED
23  TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A
24  PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER
25  OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL,
26  EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO,
27  PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR
28  PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF
29  LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
30  NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
31  SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
32  
33   */
34  package org.jaxen.expr.iter;
35  
36  import java.util.Iterator;
37  
38  import org.jaxen.ContextSupport;
39  import org.jaxen.NamedAccessNavigator;
40  import org.jaxen.UnsupportedAxisException;
41  
42  /***
43   * Provide access to the child xpath axis.
44   * 
45   * @author Bob McWhirter
46   * @author James Strachan
47   * @author Stephen Colebourne
48   */
49  public class IterableChildAxis extends IterableAxis {
50      
51      /***
52       * 
53       */
54      private static final long serialVersionUID = 1L;
55  
56      /***
57       * Constructor.
58       * 
59       * @param value the axis value
60       */
61      public IterableChildAxis(int value) {
62          super(value);
63      }
64  
65      /***
66       * Gets the iterator for the child axis.
67       * 
68       * @param contextNode  the current context node to work from
69       * @param support  the additional context information
70       * @return an iterator over the children of the context node
71       * @throws UnsupportedAxisException if the child axis is not supported
72       */
73      public Iterator iterator(Object contextNode, ContextSupport support) 
74        throws UnsupportedAxisException {
75          return support.getNavigator().getChildAxisIterator(contextNode);
76      }
77  
78      /***
79       * Gets an iterator for the child XPath axis that supports named access.
80       * 
81       * @param contextNode  the current context node to work from
82       * @param support  the additional context information
83       * @param localName  the local name of the children to return
84       * @param namespacePrefix  the prefix of the namespace of the children to return
85       * @param namespaceURI  the URI of the namespace of the children to return
86       * @return an iterator over the children of the context node
87       * @throws UnsupportedAxisException if the child axis is not supported by the model
88       */
89      public Iterator namedAccessIterator(
90          Object contextNode,
91          ContextSupport support,
92          String localName,
93          String namespacePrefix,
94          String namespaceURI)
95              throws UnsupportedAxisException {
96                  
97          NamedAccessNavigator nav = (NamedAccessNavigator) support.getNavigator();
98          return nav.getChildAxisIterator(contextNode, localName, namespacePrefix, namespaceURI);
99      }
100 
101     /***
102      * Does this axis support named access?
103      * 
104      * @param support the additional context information
105      * @return true if named access supported. If not iterator() will be used
106      */
107     public boolean supportsNamedAccess(ContextSupport support) {
108         return (support.getNavigator() instanceof NamedAccessNavigator);
109     }
110 
111 }