Xalan-C++ API Documentation

The Xalan C++ XSLT Processor Version 1.7

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

XalanNumberingResourceBundle.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  *
00005  * Copyright (c) 1999-2004 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 
00058 #if !defined(XALAN_NUMBERINGRESOURCEBUNDLE_HEADER_GUARD)
00059 #define XALAN_NUMBERINGRESOURCEBUNDLE_HEADER_GUARD
00060 
00061 
00062 
00063 // Base include file.  Must be first.
00064 #include <xalanc/XSLT/XSLTDefinitions.hpp>
00065 
00066 
00067 
00068 #include <vector>
00069 
00070 
00071 
00072 #include <xalanc/PlatformSupport/DOMStringHelper.hpp>
00073 
00074 
00075 
00076 XALAN_CPP_NAMESPACE_BEGIN
00077 
00078 
00079 
00080 class XalanNumberingResourceBundle
00081 {
00082 public:
00083 
00084     typedef unsigned long                           NumberType;
00085 
00086 #if defined(XALAN_NO_STD_NAMESPACE)
00087     typedef vector<NumberType>                      NumberTypeVectorType;
00088     typedef vector<XalanDOMCharVectorType>          DigitsTableVectorType;
00089 #else
00090     typedef std::vector<unsigned long>              NumberTypeVectorType;
00091     typedef std::vector<XalanDOMCharVectorType>     DigitsTableVectorType;
00092 #endif
00093 
00094     // Enum to describe language orientation.  (English is left-to-right,
00095     // Hebrew is right-to-left, etc.)
00096     enum eOrientation { eLeftToRight, eRightToLeft, eTopToBottom, eBottomToTop };
00097 
00098     // Enum to describe how numbering is done.
00099     enum eNumberingMethod { eAdditive, eMultiplicativeAdditive };
00100 
00101     // Enum to describe the where the multiplier goes.
00102     enum eMultiplierOrder { eFollows, ePrecedes };
00103 
00104 
00105     XalanNumberingResourceBundle(
00106         const XalanDOMString&           theLanguage,
00107         const XalanDOMString&           theUILanguage,
00108         const XalanDOMString&           theHelpLanguage,
00109         const XalanDOMCharVectorType&   theAlphabet,
00110         const XalanDOMCharVectorType&   theTraditionalAlphabet,
00111         eOrientation                    theOrientation,
00112         eNumberingMethod                theNumberingMethod,
00113         eMultiplierOrder                theMultiplierOrder,
00114         NumberType                      theMaxNumericalValue,
00115         const NumberTypeVectorType&     theNumberGroups,
00116         const NumberTypeVectorType&     theMultipliers,
00117         const XalanDOMCharVectorType&   theZeroChar,
00118         const XalanDOMCharVectorType&   theMultiplierChars,
00119         const DigitsTableVectorType&    theDigitsTable,
00120         const NumberTypeVectorType&     theDigitsTableTable);
00121 
00122     explicit
00123     XalanNumberingResourceBundle();
00124 
00125     XalanNumberingResourceBundle(const XalanNumberingResourceBundle&    theSource);
00126 
00127     ~XalanNumberingResourceBundle();
00128 
00129     bool
00130 	operator==(const XalanNumberingResourceBundle& theRHS) const
00131     {
00132         return equals(m_language, theRHS.m_language);
00133     }
00134 
00135     const XalanDOMString&
00136     getLanguage() const
00137     {
00138         return m_language;
00139     }
00140 
00141     const XalanDOMString&
00142     getUILanguage() const
00143     {
00144         return m_uiLanguage;
00145     }
00146 
00147     const XalanDOMString&
00148     getHelpLanguage() const
00149     {
00150         return m_helpLanguage;
00151     }
00152 
00153     const XalanDOMCharVectorType&
00154     getAlphabet() const
00155     {
00156         return m_alphabet;
00157     }
00158 
00159     const XalanDOMCharVectorType&
00160     getTraditionalAlphabet() const
00161     {
00162         return m_traditionalAlphabet;
00163     }
00164 
00165     eOrientation
00166     getOrientation() const
00167     {
00168         return m_orientation;
00169     }
00170 
00171     eNumberingMethod
00172     getNumberingMethod() const
00173     {
00174         return m_numberingMethod;
00175     }
00176 
00177     eMultiplierOrder
00178     getMultiplierOrder() const
00179     {
00180         return m_multiplierOrder;
00181     }
00182 
00183     NumberType
00184     getMaxNumericalValue() const
00185     {
00186         return m_maxNumericalValue;
00187     }
00188 
00189     const NumberTypeVectorType&
00190     getNumberGroups() const
00191     {
00192         return m_numberGroups;
00193     }
00194 
00195     const NumberTypeVectorType&
00196     getMultipliers() const
00197     {
00198         return m_multipliers;
00199     }
00200 
00201     const XalanDOMCharVectorType&
00202     getZeroChar() const
00203     {
00204         return m_zeroChar;
00205     }
00206 
00207     const XalanDOMCharVectorType&
00208     getMultiplierChars() const
00209     {
00210         return m_multiplierChars;
00211     }
00212 
00213     const DigitsTableVectorType&
00214     getDigitsTable() const
00215     {
00216         return m_digitsTable;
00217     }
00218 
00219     const NumberTypeVectorType&
00220     getDigitsTableTable() const
00221     {
00222         return m_digitsTableTable;
00223     }
00224 
00225     void
00226     swap(XalanNumberingResourceBundle&  theOther);
00227 
00228 private:
00229 
00230     XalanDOMString          m_language;
00231 
00232     XalanDOMString          m_uiLanguage;
00233 
00234     XalanDOMString          m_helpLanguage;
00235 
00236     XalanDOMCharVectorType  m_alphabet;
00237 
00238     XalanDOMCharVectorType  m_traditionalAlphabet;
00239 
00240     eOrientation            m_orientation;
00241 
00242     eNumberingMethod        m_numberingMethod;
00243 
00244     eMultiplierOrder        m_multiplierOrder;
00245 
00246     NumberType              m_maxNumericalValue;
00247 
00248     NumberTypeVectorType    m_numberGroups;
00249 
00250     NumberTypeVectorType    m_multipliers;
00251 
00252     XalanDOMCharVectorType  m_zeroChar;
00253 
00254     XalanDOMCharVectorType  m_multiplierChars;
00255 
00256     DigitsTableVectorType   m_digitsTable;
00257 
00258     NumberTypeVectorType    m_digitsTableTable;
00259 };
00260 
00261 
00262 
00263 XALAN_CPP_NAMESPACE_END
00264 
00265 
00266 
00267 #endif  // XALAN_NUMBERINGRESOURCEBUNDLE_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.7
Copyright © 1999-2004 The Apache Software Foundation. All Rights Reserved.