KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > com > hp > hpl > jena > util > xml > SimpleXMLPathAttr


1 /*****************************************************************************
2  * Source code information
3  * -----------------------
4  * Original author Ian Dickinson, HP Labs Bristol
5  * Author email ian.dickinson@hp.com
6  * Package Jena 2
7  * Web http://sourceforge.net/projects/jena/
8  * Created 04-Dec-2003
9  * Filename $RCSfile: SimpleXMLPathAttr.java,v $
10  * Revision $Revision: 1.4 $
11  * Release status $State: Exp $
12  *
13  * Last modified on $Date: 2005/02/21 12:20:33 $
14  * by $Author: andy_seaborne $
15  *
16  * (c) Copyright 2001, 2002, 2003, 2004, 2005 Hewlett-Packard Development Company, LP
17  * [See end of file]
18  *****************************************************************************/
19
20 // Package
21 ///////////////
22 package com.hp.hpl.jena.util.xml;
23
24
25 // Imports
26 ///////////////
27 import java.util.*;
28
29 import org.w3c.dom.*;
30
31
32 /**
33  * <p>
34  * An implementation of a simple XML path component that handles named attributes
35  * </p>
36  *
37  * @author Ian Dickinson, HP Labs (<a HREF="mailto:Ian.Dickinson@hp.com" >email</a>)
38  * @version CVS $Id: SimpleXMLPathAttr.java,v 1.4 2005/02/21 12:20:33 andy_seaborne Exp $
39  */
40 public class SimpleXMLPathAttr
41     implements SimpleXMLPathComponent
42 {
43     // Constants
44 //////////////////////////////////
45
46     // Static variables
47 //////////////////////////////////
48
49     /** The element name we are evaluating */
50     protected String JavaDoc m_attrName;
51     
52     
53     // Constructors
54 //////////////////////////////////
55
56     /**
57      * <p>Construct a simple XML path component that selects the value
58      * of a named attribute.</p>
59      * @param attrName The name of the attribute to select
60      */
61     public SimpleXMLPathAttr( String JavaDoc attrName ) {
62         m_attrName = attrName;
63     }
64
65
66     // External signature methods
67 //////////////////////////////////
68
69     /**
70      * <p>Answer an iterator over all of the values of this path component when
71      * evaluated with respect to the given node.</p>
72      * @param node The parent node to evaluate against
73      * @return An iterator over all of the objects that correspond to evaluating
74      * this path against the given node.
75      */
76     public Iterator getAll( Node node ) {
77         // elements should occur within elements
78 if (!(node instanceof Element)) {
79             throw new IllegalArgumentException JavaDoc( "Tried to get attribute " + m_attrName + " from a parent node of type " + node.getClass().getName() );
80         }
81         
82         List attr = new ArrayList();
83         Element e = (Element) node;
84         if (e.hasAttribute( m_attrName )) {
85             attr.add( e.getAttribute( m_attrName ) );
86         }
87         
88         return attr.iterator();
89     }
90     
91     /**
92      * <p>Answer the first value for this path expression against the given node.</p>
93      * @param node The parent node to evalauate against
94      * @return The first object that corresponds to evaluating
95      * this path against the given node, or null if there is no such value
96      */
97     public Object JavaDoc getFirst( Node node ) {
98         return ((Element) node).getAttribute( m_attrName );
99     }
100     
101     
102
103     // Internal implementation methods
104 //////////////////////////////////
105
106     //==============================================================================
107 // Inner class definitions
108 //==============================================================================
109
110 }
111
112
113 /*
114  * (c) Copyright 2001, 2002, 2003, 2004, 2005 Hewlett-Packard Development Company, LP
115  * All rights reserved.
116  *
117  * Redistribution and use in source and binary forms, with or without
118  * modification, are permitted provided that the following conditions
119  * are met:
120  * 1. Redistributions of source code must retain the above copyright
121  * notice, this list of conditions and the following disclaimer.
122  * 2. Redistributions in binary form must reproduce the above copyright
123  * notice, this list of conditions and the following disclaimer in the
124  * documentation and/or other materials provided with the distribution.
125  * 3. The name of the author may not be used to endorse or promote products
126  * derived from this software without specific prior written permission.
127  *
128  * THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
129  * IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
130  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
131  * IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
132  * INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
133  * NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
134  * DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
135  * THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
136  * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
137  * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
138  */
139
Popular Tags