Xalan-C++ API Documentation

The Xalan-C++ XSL Transformer Version 1.0

Main Page   Namespace List   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 <vector>
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 class XPathSupport;
00087 
00088 
00089 
00102 class XALAN_XPATH_EXPORT QName
00103 {
00104 public:
00105 
00106 #if defined(XALAN_NO_NAMESPACES)
00107     typedef vector<NameSpace>                NamespaceVectorType;
00108     typedef vector<NamespaceVectorType>      NamespacesStackType;
00109 #else
00110     typedef std::vector<NameSpace>           NamespaceVectorType;
00111     typedef std::vector<NamespaceVectorType> NamespacesStackType;
00112 #endif
00113 
00120     QName(
00121             const XalanDOMString&   theNamespace = XalanDOMString(),
00122             const XalanDOMString&   theLocalPart = XalanDOMString());
00123 
00131     QName(
00132             const XalanDOMString&       qname,
00133             const NamespacesStackType&  namespaces);
00134 
00144     QName(
00145             const XalanDOMString&   qname,
00146             const XalanElement*     namespaceContext,
00147             const XPathEnvSupport&  envSupport,
00148             const XPathSupport&     support);
00149 
00157     QName(
00158             const XalanDOMString&       qname,
00159             const PrefixResolver&   theResolver);
00160 
00161     ~QName();
00162 
00168     const XalanDOMString&
00169     getLocalPart() const
00170     {
00171         return m_localpart;
00172     }
00173 
00179     const XalanDOMString&
00180     getNamespace() const
00181     {
00182         return m_namespace;
00183     }
00184 
00190     bool isEmpty() const
00191     {
00192         return (::isEmpty(m_namespace) && ::isEmpty(m_localpart));
00193     }
00194 
00202     bool
00203     equals(const QName&     theRHS) const;
00204 
00212     bool
00213     operator==(const QName&     theRHS) const
00214     {
00215         return equals(theRHS);
00216     }
00217 
00225     static const XalanDOMString&
00226     getNamespaceForPrefix(
00227             const NamespaceVectorType&  namespaces,
00228             const XalanDOMString&       prefix,
00229             bool                        reverse = true);
00230 
00239     static const XalanDOMString&
00240     getNamespaceForPrefix(
00241             const NamespacesStackType&  nsStack,
00242             const XalanDOMString&       prefix,
00243             bool                        reverse = true);
00244 
00252     static const XalanDOMString&
00253     getPrefixForNamespace(
00254             const NamespaceVectorType&  namespaces,
00255             const XalanDOMString&       uri,
00256             bool                        reverse = true);
00257 
00266     static const XalanDOMString&
00267     getPrefixForNamespace(
00268             const NamespacesStackType&  nsStack,
00269             const XalanDOMString&       uri,
00270             bool                        reverse = true);
00271 
00272 private:
00273 
00274     void
00275     resolvePrefix(
00276             const XalanDOMString&       qname,
00277             const PrefixResolver&   theResolver);
00278 
00279     XalanDOMString  m_namespace;
00280 
00281     XalanDOMString  m_localpart;
00282 
00283     static const XalanDOMString     s_emptyString;
00284 };
00285 
00286 
00287 
00288 inline bool
00289 operator<(
00290             const QName&    theLHS,
00291             const QName&    theRHS)
00292 {
00293     if (theLHS.getNamespace() < theRHS.getNamespace())
00294         return true;
00295     else if (equals( theLHS.getNamespace(), theRHS.getNamespace()))
00296     {
00297         return theLHS.getLocalPart() < theRHS.getLocalPart();
00298     }
00299     else
00300         return false;
00301 }
00302 
00303 
00304 
00305 #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.0
Copyright © 2000 The Apache Software Foundation. All Rights Reserved.