View Javadoc

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