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  

NodeSorter.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_NODESORTER_HEADER_GUARD)
00058 #define XALAN_NODESORTER_HEADER_GUARD
00059 
00064 
00065  
00066 
00067 // Base include file.  Must be first.
00068 #include "XSLTDefinitions.hpp"
00069 
00070 
00071 
00072 #include <functional>
00073 #include <map>
00074 #include <vector>
00075 
00076 
00077 
00078 #include "NodeSortKey.hpp"
00079 
00080 
00081 
00082 class MutableNodeRefList;
00083 class StylesheetExecutionContext;
00084 class XalanNode;
00085 class XPath;
00086 
00087 
00088 
00092  // TODO: Optimize this so it can reuse queries for each of the nodes.
00093 class NodeSorter
00094 {
00095 public:
00096 
00097 #if defined(XALAN_NO_NAMESPACES)
00098     typedef vector<XalanNode*>          NodeVectorType;
00099     typedef vector<NodeSortKey>         NodeSortKeyVectorType;
00100 #else
00101     typedef std::vector<XalanNode*>     NodeVectorType;
00102     typedef std::vector<NodeSortKey>    NodeSortKeyVectorType;
00103 #endif
00104 
00109     explicit
00110     NodeSorter();
00111   
00112     ~NodeSorter();
00113 
00122     void
00123     sort(
00124             StylesheetExecutionContext&     executionContext,
00125             MutableNodeRefList&             theList,
00126             const NodeSortKeyVectorType&    keys) const;
00127 
00128     /*
00129      * TODO: Optimize compare -- cache the getStringExpr results,
00130      * key by m_selectPat + hash of node.
00131      */
00132 
00136 #if defined(XALAN_NO_NAMESPACES)
00137     struct NodeSortKeyCompare : public binary_function<XalanNode*, XalanNode*, bool>
00138 #else
00139     struct NodeSortKeyCompare : public std::binary_function<XalanNode*, XalanNode*, bool>
00140 #endif
00141     {
00142     public:
00143 
00151         NodeSortKeyCompare(
00152                 StylesheetExecutionContext&     executionContext,
00153                 const MutableNodeRefList&       theList,
00154                 const NodeVectorType&           theNodes,
00155                 const NodeSortKeyVectorType&    theNodeSortKeys) :
00156             m_executionContext(executionContext),
00157             m_list(theList),
00158             m_nodes(theNodes),
00159             m_nodeSortKeys(theNodeSortKeys),
00160             m_numberResultsCache(),
00161             m_stringResultsCache()
00162         {
00163         }
00164 
00172         result_type
00173         operator()(first_argument_type      theLHS,
00174                    second_argument_type     theRHS,
00175                    unsigned int             theKeyIndex = 0) const;
00176 
00177     protected:
00178 
00179         bool
00180         isNodeBefore(
00181                 const XalanNode*    node1,
00182                 const XalanNode*    node2) const;
00183 
00184         double
00185         getNumberResult(
00186                 const NodeSortKey&  theKey,
00187                 XalanNode*          node) const;
00188 
00189         const XalanDOMString
00190         getStringResult(
00191                 const NodeSortKey&  theKey,
00192                 XalanNode*          node) const;
00193 
00194     private:
00195 
00196         StylesheetExecutionContext&     m_executionContext;
00197         const MutableNodeRefList&       m_list;
00198         const NodeVectorType&           m_nodes;
00199         const NodeSortKeyVectorType&    m_nodeSortKeys;
00200 
00201 #if defined(XALAN_NO_NAMESPACES)
00202         typedef map<const XalanNode*,
00203                     double,
00204                     less<const XalanNode*> >    NumberResultsNodeCacheMapType;
00205 
00206         typedef map<const XalanNode*,
00207                     XalanDOMString,
00208                     less<const XalanNode*> >        StringResultsNodeCacheMapType;
00209 
00210         typedef map<const XPath*,
00211                     NumberResultsNodeCacheMapType,
00212                     less<const XPath*> >    NumberResultsCacheMapType;
00213 
00214         typedef map<const XPath*,
00215                     StringResultsNodeCacheMapType,
00216                     less<const XPath*> >    StringResultsCacheMapType;
00217 #else
00218         typedef std::map<const XalanNode*, double>          NumberResultsNodeCacheMapType;
00219         typedef std::map<const XalanNode*, XalanDOMString>  StringResultsNodeCacheMapType;
00220 
00221         typedef std::map<const XPath*, NumberResultsNodeCacheMapType>   NumberResultsCacheMapType;
00222         typedef std::map<const XPath*, StringResultsNodeCacheMapType>   StringResultsCacheMapType;
00223 #endif
00224 
00225         mutable NumberResultsCacheMapType   m_numberResultsCache;
00226         mutable StringResultsCacheMapType   m_stringResultsCache;
00227     };
00228 
00229 private:
00230 
00240     void
00241     sort(
00242             StylesheetExecutionContext&     executionContext,
00243             const MutableNodeRefList&       theList,
00244             NodeVectorType&                 v,
00245             const NodeSortKeyVectorType&    keys) const;
00246 
00251   // NumberFormat m_formatter = NumberFormat.getNumberInstance();  
00252 };
00253 
00254 
00255 
00256 #endif  // XALAN_NODESORTER_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.