KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > jaxen > expr > iter > IterableAxis


1 /*
2  $Id: IterableAxis.java,v 1.8 2005/05/13 13:43:37 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.io.Serializable JavaDoc;
49 import java.util.Iterator JavaDoc;
50
51 import org.jaxen.ContextSupport;
52 import org.jaxen.UnsupportedAxisException;
53
54 /**
55  * Provide access to the XPath axes.
56  *
57  * @author Bob McWhirter
58  * @author James Strachan
59  * @author Stephen Colebourne
60  */
61 public abstract class IterableAxis implements Serializable JavaDoc {
62     
63     /** The axis type */
64     private int value;
65
66     /**
67      * Constructor.
68      *
69      * @param axisValue
70      */
71     public IterableAxis(int axisValue) {
72         this.value = axisValue;
73     }
74
75     /**
76      * Gets the axis value.
77      *
78      * @return the axis value
79      */
80     public int value() {
81         return this.value;
82     }
83
84     /**
85      * Gets the iterator for a specific XPath axis.
86      *
87      * @param contextNode the current context node to work from
88      * @param support the additional context information
89      * @return an iterator for the axis
90      * @throws UnsupportedAxisException
91      */
92     public abstract Iterator JavaDoc iterator(Object JavaDoc contextNode, ContextSupport support) throws UnsupportedAxisException;
93
94     /**
95      * Gets the iterator for a specific XPath axis that supports named access.
96      *
97      * @param contextNode the current context node to work from
98      * @param support the additional context information
99      * @param localName the local name of the nodes to return
100      * @param namespacePrefix the prefix of the namespace of the nodes to return
101      * @param namespaceURI the URI of the namespace of the nodes to return
102      */
103     public Iterator JavaDoc namedAccessIterator(
104         Object JavaDoc contextNode,
105         ContextSupport support,
106         String JavaDoc localName,
107         String JavaDoc namespacePrefix,
108         String JavaDoc namespaceURI)
109             throws UnsupportedAxisException {
110                 
111         throw new UnsupportedOperationException JavaDoc("Named access unsupported");
112     }
113
114     /**
115      * Does this axis support named access?
116      *
117      * @param support the additional context information
118      * @return true if named access supported. If not iterator() will be used
119      */
120     public boolean supportsNamedAccess(ContextSupport support) {
121         return false;
122     }
123
124 }
125
Popular Tags