## Xalan-C++ API Documentation

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

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

# NodeSortKey.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  * $ Id: $
    00058  *
    00059  */
    00060
    00061 #if !defined(XALAN_NODESORTKEY_HEADER_GUARD)
    00062 #define XALAN_NODESORTKEY_HEADER_GUARD
    00063
    00072 // Base include file.  Must be first.
    00073 #include "XSLTDefinitions.hpp"
    00074
    00075
    00076
    00077 // $$$ ToDo: This is necessary while XalanDOMString is a typedef.
    00078 #include <XalanDOM/XalanDOMString.hpp>
    00079
    00080
    00081
    00082 XALAN_CPP_NAMESPACE_BEGIN
    00083
    00084
    00085
    00086 class ExecutionContext;
    00087 class PrefixResolver;
    00088 class XPath;
    00089
    00090
    00091
    00095 class XALAN_XSLT_EXPORT NodeSortKey
    00096 {
    00097 public:
    00098
    00099     enum eCaseOrder { eDefault, eLowerFirst, eUpperFirst };
    00100
    00112     NodeSortKey(
    00113             ExecutionContext&       executionContext,
    00114             const XPath&            selectPat,
    00115             bool                    treatAsNumbers,
    00116             bool                    descending,
    00117             eCaseOrder              caseOrder,
    00118             const XalanDOMString&   langValue,
    00119             const PrefixResolver&   resolver);
    00120
    00121     NodeSortKey();
    00122
    00123     NodeSortKey(const NodeSortKey&  theSource);
    00124
    00125     ~NodeSortKey();
    00126
    00127     NodeSortKey&
    00128     operator=(const NodeSortKey&    theRHS);
    00129
    00135     const XPath*
    00136     getSelectPattern() const
    00137     {
    00138         return m_selectPat;
    00139     }
    00140
    00146     bool
    00147     getTreatAsNumbers() const
    00148     {
    00149         return m_treatAsNumbers;
    00150     }
    00151
    00157     bool
    00158     getDescending() const
    00159     {
    00160         return m_descending;
    00161     }
    00162
    00168     eCaseOrder
    00169     getCaseOrder() const
    00170     {
    00171         return m_caseOrder;
    00172     }
    00173
    00179     const PrefixResolver*
    00180     getPrefixResolver() const
    00181     {
    00182         return m_prefixResolver;
    00183     }
    00184
    00185     const XalanDOMString&
    00186     getLanguageString() const
    00187     {
    00188         return *m_languageString;
    00189     }
    00190
    00191 private:
    00192
    00193     ExecutionContext*       m_executionContext; // needed for error reporting.
    00194
    00195     const XPath*            m_selectPat;
    00196
    00197     bool                    m_treatAsNumbers;
    00198     bool                    m_descending;
    00199
    00200     eCaseOrder              m_caseOrder;
    00201
    00202     const PrefixResolver*   m_prefixResolver;
    00203
    00204     const XalanDOMString*   m_languageString;
    00205 };
    00206
    00207
    00208
    00209 XALAN_CPP_NAMESPACE_END
    00210
    00211
    00212
    00213 #endif

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.5 Copyright © 2000, 2001, 2002, 2003 The Apache Software Foundation. All Rights Reserved.