Xalan-C++ API Documentation

The Xalan C++ XSL Transformer Version 1.1

Main Page   Class Hierarchy   Alphabetical List   Compound List   File List   Compound Members   File Members  

QName.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999 The Apache Software Foundation.  All rights 
00006  * reserved.
00007  *
00008  * Redistribution and use in source and binary forms, with or without
00009  * modification, are permitted provided that the following conditions
00010  * are met:
00011  *
00012  * 1. Redistributions of source code must retain the above copyright
00013  *    notice, this list of conditions and the following disclaimer. 
00014  *
00015  * 2. Redistributions in binary form must reproduce the above copyright
00016  *    notice, this list of conditions and the following disclaimer in
00017  *    the documentation and/or other materials provided with the
00018  *    distribution.
00019  *
00020  * 3. The end-user documentation included with the redistribution,
00021  *    if any, must include the following acknowledgment:  
00022  *       "This product includes software developed by the
00023  *        Apache Software Foundation (http://www.apache.org/)."
00024  *    Alternately, this acknowledgment may appear in the software itself,
00025  *    if and wherever such third-party acknowledgments normally appear.
00026  *
00027  * 4. The names "Xalan" and "Apache Software Foundation" must
00028  *    not be used to endorse or promote products derived from this
00029  *    software without prior written permission. For written 
00030  *    permission, please contact apache@apache.org.
00031  *
00032  * 5. Products derived from this software may not be called "Apache",
00033  *    nor may "Apache" appear in their name, without prior written
00034  *    permission of the Apache Software Foundation.
00035  *
00036  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00037  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00038  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00039  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00040  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00041  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00042  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00043  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00044  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00045  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00046  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00047  * SUCH DAMAGE.
00048  * ====================================================================
00049  *
00050  * This software consists of voluntary contributions made by many
00051  * individuals on behalf of the Apache Software Foundation and was
00052  * originally based on software copyright (c) 1999, International
00053  * Business Machines, Inc., http://www.ibm.com.  For more
00054  * information on the Apache Software Foundation, please see
00055  * <http://www.apache.org/>.
00056  */
00057 #if !defined(QNAME_HEADER_GUARD_1357924680)
00058 #define QNAME_HEADER_GUARD_1357924680
00059 
00060 
00061 
00062 // Base header file.  Must be first.
00063 #include <XPath/XPathDefinitions.hpp>
00064 
00065 
00066 
00067 #include <deque>
00068 
00069 
00070 
00071 #include <XalanDOM/XalanDOMString.hpp>
00072 
00073 
00074 
00075 #include <PlatformSupport/DOMStringHelper.hpp>
00076 
00077 
00078 
00079 #include <XPath/NameSpace.hpp>
00080 
00081 
00082 
00083 class XalanElement;
00084 class PrefixResolver;
00085 class XPathEnvSupport;
00086 
00087 
00088 
00101 class XALAN_XPATH_EXPORT QName
00102 {
00103 public:
00104 
00105 #if defined(XALAN_NO_NAMESPACES)
00106     typedef deque<NameSpace>                    NamespaceVectorType;
00107     typedef deque<NamespaceVectorType>          NamespacesStackType;
00108 #else
00109     typedef std::deque<NameSpace>               NamespaceVectorType;
00110     typedef std::deque<NamespaceVectorType>     NamespacesStackType;
00111 #endif
00112 
00117     explicit
00118     QName();
00119 
00120     virtual
00121     ~QName();
00122 
00128     virtual const XalanDOMString&
00129     getLocalPart() const = 0;
00130 
00136     virtual const XalanDOMString&
00137     getNamespace() const = 0;
00138 
00144     bool
00145     isEmpty() const
00146     {
00147         return ::isEmpty(getNamespace()) && ::isEmpty(getLocalPart());
00148     }
00149 
00157     bool
00158     equals(const QName&     theRHS) const
00159     {
00160         // Note that we do not use our member variables here.  See
00161         // class QNameReference for details...
00162         return ::equals(getLocalPart(), theRHS.getLocalPart()) &&
00163                ::equals(getNamespace(), theRHS.getNamespace());
00164     }
00165 
00173     static const XalanDOMString&
00174     getNamespaceForPrefix(
00175             const NamespaceVectorType&  namespaces,
00176             const XalanDOMString&       prefix,
00177             bool                        reverse = true);
00178 
00187     static const XalanDOMString&
00188     getNamespaceForPrefix(
00189             const NamespacesStackType&  nsStack,
00190             const XalanDOMString&       prefix,
00191             bool                        reverse = true);
00192 
00200     static const XalanDOMString&
00201     getPrefixForNamespace(
00202             const NamespaceVectorType&  namespaces,
00203             const XalanDOMString&       uri,
00204             bool                        reverse = true);
00205 
00214     static const XalanDOMString&
00215     getPrefixForNamespace(
00216             const NamespacesStackType&  nsStack,
00217             const XalanDOMString&       uri,
00218             bool                        reverse = true);
00219 
00220 protected:
00221 
00222     static const XalanDOMString     s_emptyString;
00223 };
00224 
00225 
00226 
00227 inline bool
00228 operator==(
00229             const QName&    theLHS,
00230             const QName&    theRHS)
00231 {
00232     return theLHS.equals(theRHS);
00233 }
00234 
00235 
00236 
00237 inline bool
00238 operator!=(
00239             const QName&    theLHS,
00240             const QName&    theRHS)
00241 {
00242     return !(theLHS == theRHS);
00243 }
00244 
00245 
00246 
00247 inline bool
00248 operator<(
00249             const QName&    theLHS,
00250             const QName&    theRHS)
00251 {
00252     if (theLHS.getNamespace() < theRHS.getNamespace())
00253     {
00254         return true;
00255     }
00256     else if (equals(theLHS.getNamespace(), theRHS.getNamespace()))
00257     {
00258         return theLHS.getLocalPart() < theRHS.getLocalPart();
00259     }
00260     else
00261     {
00262         return false;
00263     }
00264 }
00265 
00266 
00267 
00268 #endif  // QNAME_HEADER_GUARD_1357924680

Interpreting class diagrams

Doxygen and GraphViz are used to generate this API documentation from the Xalan-C header files.

Xalan-C++ XSL Transformer Version 1.1
Copyright © 2000, 2001 The Apache Software Foundation. All Rights Reserved.