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  

KeyTable.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(XALAN_KEYTABLE_HEADER_GUARD)
00058 #define XALAN_KEYTABLE_HEADER_GUARD 
00059 
00067 
00068 
00069 
00070 // Base include file.  Must be first.
00071 #include "XSLTDefinitions.hpp"
00072 
00073 
00074 
00075 #include <map>
00076 #include <vector>
00077 
00078 
00079 
00080 #include <PlatformSupport/DOMStringHelper.hpp>
00081 
00082 
00083 
00084 #include <XPath/MutableNodeRefList.hpp>
00085 
00086 
00087 
00088 class KeyDeclaration;
00089 class NodeRefListBase;
00090 class PrefixResolver;
00091 class StylesheetExecutionContext;
00092 class XalanElement;
00093 class XalanNode;
00094 
00095 
00096 
00097 
00104 class KeyTable
00105 {
00106 public:
00107 
00108 #if defined(XALAN_NO_NAMESPACES)
00109     typedef vector<KeyDeclaration>          KeyDeclarationVectorType;
00110 
00111     typedef map<XalanDOMString,
00112                 MutableNodeRefList,
00113                 less<XalanDOMString> >      NodeListMapType;
00114 
00115     typedef map<XalanDOMString,
00116                 NodeListMapType,
00117                 less<XalanDOMString> >      KeysMapType;
00118 #else
00119     typedef std::vector<KeyDeclaration>     KeyDeclarationVectorType;
00120 
00121     typedef std::map<XalanDOMString,
00122                      MutableNodeRefList>    NodeListMapType;
00123 
00124     typedef std::map<XalanDOMString,
00125                      NodeListMapType>       KeysMapType;
00126 #endif
00127 
00128 
00140     KeyTable(
00141             XalanNode*                          doc,
00142             XalanNode*                          startNode,
00143             const PrefixResolver&               resolver,
00144             const KeyDeclarationVectorType&     keyDeclarations,
00145             StylesheetExecutionContext&         executionContext);
00146 
00147     virtual
00148     ~KeyTable();
00149 
00162     const NodeRefListBase&
00163     getNodeSetByKey(
00164                   const XalanDOMString&     name,
00165                   const XalanDOMString&     ref) const;
00166 
00173     const XalanNode*
00174     getDocKey() const
00175     {
00176         return m_docKey;
00177     }
00178 
00179 private:
00180 
00185     const XalanNode*    m_docKey;
00186 
00198 
00199     KeysMapType                         m_keys;
00200 
00201     static const MutableNodeRefList     s_dummyList;
00202 };
00203 
00204 
00205 
00206 #endif  // XALAN_KEYTABLE_HEADER_GUARD

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.