## Xalan-C++ API Documentation

### The Xalan C++ XSLT Processor Version 1.6

Main Page 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-2002 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
    00066
    00067
    00068
    00069 // Base include file.  Must be first.
    00070 #include "XSLTDefinitions.hpp"
    00071
    00072
    00073
    00074 #if defined(XALAN_USE_HASH_MAP)
    00075 #include <hash_map>
    00076 #else
    00077 #include <map>
    00078 #endif
    00079 #include <vector>
    00080
    00081
    00082
    00083 #include <xalanc/PlatformSupport/DOMStringHelper.hpp>
    00084
    00085
    00086
    00087 #include <xalanc/XPath/MutableNodeRefList.hpp>
    00088 #include <xalanc/XPath/XalanQNameByReference.hpp>
    00089
    00090
    00091
    00092 XALAN_CPP_NAMESPACE_BEGIN
    00093
    00094
    00095
    00096 class KeyDeclaration;
    00097 class NodeRefListBase;
    00098 class PrefixResolver;
    00099 class StylesheetExecutionContext;
    00100 class XalanElement;
    00101 class XalanDocument;
    00102 class XalanNode;
    00103
    00104
    00105
    00106
    00113 class KeyTable
    00114 {
    00115 public:
    00116
    00117 #if defined(XALAN_NO_STD_NAMESPACE)
    00118     typedef vector<KeyDeclaration>          KeyDeclarationVectorType;
    00119
    00120     typedef map<XalanDOMString,
    00121                 MutableNodeRefList,
    00122                 less<XalanDOMString> >      NodeListMapType;
    00123
    00124     typedef map<XalanQNameByReference,
    00125                 NodeListMapType,
    00126                 less<XalanQNameByReference> >   KeysMapType;
    00127 #else
    00128     typedef std::vector<KeyDeclaration>     KeyDeclarationVectorType;
    00129
    00130 #if defined(XALAN_USE_HASH_MAP)
    00131     typedef std::hash_map<XalanDOMString,
    00132                           MutableNodeRefList>   NodeListMapType;
    00133
    00134     typedef std::hash_map<XalanQNameByReference,
    00135                           NodeListMapType>      KeysMapType;
    00136 #else
    00137     typedef std::map<XalanDOMString,
    00138                      MutableNodeRefList>    NodeListMapType;
    00139
    00140     typedef std::map<XalanQNameByReference,
    00141                      NodeListMapType>       KeysMapType;
    00142 #endif
    00143 #endif
    00144
    00145
    00155     KeyTable(
    00156             XalanNode*                          startNode,
    00157             const PrefixResolver&               resolver,
    00158             const KeyDeclarationVectorType&     keyDeclarations,
    00159             StylesheetExecutionContext&         executionContext);
    00160
    00161     virtual
    00162     ~KeyTable();
    00163
    00176     const MutableNodeRefList&
    00177     getNodeSetByKey(
    00178                   const XalanQName&         qname,
    00179                   const XalanDOMString&     ref) const;
    00180
    00181 private:
    00182
    00183     static void
    00184     processKeyDeclaration(
    00185             KeysMapType&                    theKeys,
    00186             const KeyDeclaration&           kd,
    00187             XalanNode*                      testNode,
    00188             const PrefixResolver&           resolver,
    00189             StylesheetExecutionContext&     executionContext);
    00190
    00195     const XalanDocument*    m_docKey;
    00196
    00208
    00209     KeysMapType                         m_keys;
    00210
    00211     static const MutableNodeRefList     s_dummyList;
    00212 };
    00213
    00214
    00215
    00216 XALAN_CPP_NAMESPACE_END
    00217
    00218
    00219
    00220 #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++ XSLT Processor Version 1.6 Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.