View Javadoc

1   /*
2    * $Header: /home/projects/jaxen/scm/jaxen/src/java/main/org/jaxen/SimpleNamespaceContext.java,v 1.11 2005/04/20 22:46:15 elharo Exp $
3    * $Revision: 1.11 $
4    * $Date: 2005/04/20 22:46:15 $
5    *
6    * ====================================================================
7    *
8    * Copyright (C) 2000-2002 bob mcwhirter & James Strachan.
9    * All rights reserved.
10   *
11   * Redistribution and use in source and binary forms, with or without
12   * modification, are permitted provided that the following conditions
13   * are met:
14   * 
15   * 1. Redistributions of source code must retain the above copyright
16   *    notice, this list of conditions, and the following disclaimer.
17   *
18   * 2. Redistributions in binary form must reproduce the above copyright
19   *    notice, this list of conditions, and the disclaimer that follows 
20   *    these conditions in the documentation and/or other materials 
21   *    provided with the distribution.
22   *
23   * 3. The name "Jaxen" must not be used to endorse or promote products
24   *    derived from this software without prior written permission.  For
25   *    written permission, please contact license@jaxen.org.
26   * 
27   * 4. Products derived from this software may not be called "Jaxen", nor
28   *    may "Jaxen" appear in their name, without prior written permission
29   *    from the Jaxen Project Management (pm@jaxen.org).
30   * 
31   * In addition, we request (but do not require) that you include in the 
32   * end-user documentation provided with the redistribution and/or in the 
33   * software itself an acknowledgement equivalent to the following:
34   *     "This product includes software developed by the
35   *      Jaxen Project (http://www.jaxen.org/)."
36   * Alternatively, the acknowledgment may be graphical using the logos 
37   * available at http://www.jaxen.org/
38   *
39   * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
40   * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
41   * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
42   * DISCLAIMED.  IN NO EVENT SHALL THE Jaxen AUTHORS OR THE PROJECT
43   * CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
44   * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
45   * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
46   * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
47   * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
48   * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
49   * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
50   * SUCH DAMAGE.
51   *
52   * ====================================================================
53   * This software consists of voluntary contributions made by many 
54   * individuals on behalf of the Jaxen Project and was originally 
55   * created by bob mcwhirter <bob@werken.com> and 
56   * James Strachan <jstrachan@apache.org>.  For more information on the 
57   * Jaxen Project, please see <http://www.jaxen.org/>.
58   * 
59   * $Id: SimpleNamespaceContext.java,v 1.11 2005/04/20 22:46:15 elharo Exp $
60   */
61  
62  
63  package org.jaxen;
64  
65  import java.io.Serializable;
66  import java.util.HashMap;
67  import java.util.Iterator;
68  import java.util.Map;
69  
70  /***
71   *  Provides mappings from namespace prefix to namespace URI to the xpath
72   *  engine.
73   */
74  public class SimpleNamespaceContext implements NamespaceContext, Serializable
75  {
76      
77      // XXX should this prebind the xml prefix?
78      private Map namespaces;
79  
80      public SimpleNamespaceContext()
81      {
82          this.namespaces = new HashMap();
83      }
84  
85      public SimpleNamespaceContext(Map namespaces)
86      {
87          this.namespaces = namespaces;
88      }
89  
90      /***
91       *  Adds all the namespace declarations that are in scope on the given
92       *  element. In the case of an XSLT stylesheet, this would be the element
93       *  that has the xpath expression in one of its attributes; i.e.
94       *  <code>&lt;xsl:if test="condition/xpath/expression"&gt;</code>.
95       *
96       *  @param nav  the navigator for use in conjunction with
97       *              <code>element</code>
98       *  @param element  the element to copy the namespaces from
99       */
100     public void addElementNamespaces( Navigator nav, Object element )
101         throws UnsupportedAxisException
102     {
103         Iterator namespaceAxis = nav.getNamespaceAxisIterator( element );
104 
105         while ( namespaceAxis.hasNext() ) {
106             Object namespace = namespaceAxis.next();
107             String prefix = nav.getNamespacePrefix( namespace );
108             String uri = nav.getNamespaceStringValue( namespace );
109             if ( translateNamespacePrefixToUri(prefix) == null ) {
110                 addNamespace( prefix, uri );
111             }
112         }
113     }    
114 
115     public void addNamespace(String prefix, String namespaceUri)
116     {
117         this.namespaces.put( prefix,
118                              namespaceUri );
119     }
120 
121     public String translateNamespacePrefixToUri(String prefix)
122     {
123         if ( this.namespaces.containsKey( prefix ) )
124         {
125             return (String) this.namespaces.get( prefix );
126         }
127 
128         return null;
129     }
130 }