http://xml.apache.org/http://www.apache.org/http://www.w3.org/

Home

Readme
Installation
Build

API Docs
Samples
Programming
Migration
FAQs

Releases
Feedback

PDF Document

Download
Dev Snapshots
CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

XMLMsgLoader.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  * 
00004  * Copyright (c) 1999-2000 The Apache Software Foundation.  All rights
00005  * reserved.
00006  * 
00007  * Redistribution and use in source and binary forms, with or without
00008  * modification, are permitted provided that the following conditions
00009  * are met:
00010  * 
00011  * 1. Redistributions of source code must retain the above copyright
00012  *    notice, this list of conditions and the following disclaimer. 
00013  * 
00014  * 2. Redistributions in binary form must reproduce the above copyright
00015  *    notice, this list of conditions and the following disclaimer in
00016  *    the documentation and/or other materials provided with the
00017  *    distribution.
00018  * 
00019  * 3. The end-user documentation included with the redistribution,
00020  *    if any, must include the following acknowledgment:  
00021  *       "This product includes software developed by the
00022  *        Apache Software Foundation (http://www.apache.org/)."
00023  *    Alternately, this acknowledgment may appear in the software itself,
00024  *    if and wherever such third-party acknowledgments normally appear.
00025  * 
00026  * 4. The names "Xerces" and "Apache Software Foundation" must
00027  *    not be used to endorse or promote products derived from this
00028  *    software without prior written permission. For written 
00029  *    permission, please contact apache\@apache.org.
00030  * 
00031  * 5. Products derived from this software may not be called "Apache",
00032  *    nor may "Apache" appear in their name, without prior written
00033  *    permission of the Apache Software Foundation.
00034  * 
00035  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00036  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00037  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00038  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00039  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00040  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00041  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00042  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00043  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00044  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00045  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00046  * SUCH DAMAGE.
00047  * ====================================================================
00048  * 
00049  * This software consists of voluntary contributions made by many
00050  * individuals on behalf of the Apache Software Foundation, and was
00051  * originally based on software copyright (c) 1999, International
00052  * Business Machines, Inc., http://www.ibm.com .  For more information
00053  * on the Apache Software Foundation, please see
00054  * <http://www.apache.org/>.
00055  */
00056 
00057 /*
00058  * $Log: XMLMsgLoader.hpp,v $
00059  * Revision 1.5  2000/03/28 19:43:20  roddey
00060  * Fixes for signed/unsigned warnings. New work for two way transcoding
00061  * stuff.
00062  *
00063  * Revision 1.4  2000/03/02 19:54:49  roddey
00064  * This checkin includes many changes done while waiting for the
00065  * 1.1.0 code to be finished. I can't list them all here, but a list is
00066  * available elsewhere.
00067  *
00068  * Revision 1.3  2000/02/24 20:05:26  abagchi
00069  * Swat for removing Log from API docs
00070  *
00071  * Revision 1.2  2000/02/06 07:48:05  rahulj
00072  * Year 2K copyright swat.
00073  *
00074  * Revision 1.1.1.1  1999/11/09 01:05:47  twl
00075  * Initial checkin
00076  *
00077  * Revision 1.2  1999/11/08 20:45:20  rahul
00078  * Swat for adding in Product name and CVS comment log variable.
00079  *
00080  */
00081 
00082 
00083 #if !defined(XMLMSGLOADER_HPP)
00084 #define XMLMSGLOADER_HPP
00085 
00086 #include <util/XercesDefs.hpp>
00087 
00088 //
00089 //  This header defines an abstract message loading API. This is the API via
00090 //  which the parser system loads translatable text, and there can be multiple
00091 //  actual implementations of this mechanism. The API is very simple because
00092 //  there can be many kinds of underlying systems on which implementations are
00093 //  based and we don't want to get into portability trouble by being overly
00094 //  smart.
00095 //
00096 //  Each instance of the message loader loads a file of messages, which are
00097 //  accessed by key and which are associated with a particular language. The
00098 //  actual source information may be in many forms, but by the time it is
00099 //  extracted for use it will be in Unicode format. The language is always
00100 //  the default language for the local machine.
00101 //
00102 //  Msg loader derivatives are not required to be thread safe. The parser will
00103 //  never use a single instance in more than one thread.
00104 //
00105 class  XMLMsgLoader
00106 {
00107 public :
00108     // -----------------------------------------------------------------------
00109     //  Class specific types
00110     //
00111     //  XMLMsgId
00112     //      A simple typedef to give us flexibility about the representation
00113     //      of a message id.
00114     // -----------------------------------------------------------------------
00115     typedef unsigned int    XMLMsgId;
00116 
00117 
00118     // -----------------------------------------------------------------------
00119     //  Public Constructors and Destructor
00120     // -----------------------------------------------------------------------
00121     virtual ~XMLMsgLoader();
00122 
00123 
00124     // -----------------------------------------------------------------------
00125     //  The virtual message loader API
00126     // -----------------------------------------------------------------------
00127     virtual bool loadMsg
00128     (
00129         const   XMLMsgId        msgToLoad
00130         ,       XMLCh* const    toFill
00131         , const unsigned int    maxChars
00132     ) = 0;
00133 
00134     virtual bool loadMsg
00135     (
00136         const   XMLMsgId        msgToLoad
00137         ,       XMLCh* const    toFill
00138         , const unsigned int    maxChars
00139         , const XMLCh* const    repText1
00140         , const XMLCh* const    repText2 = 0
00141         , const XMLCh* const    repText3 = 0
00142         , const XMLCh* const    repText4 = 0
00143     ) = 0;
00144 
00145     virtual bool loadMsg
00146     (
00147         const   XMLMsgId        msgToLoad
00148         ,       XMLCh* const    toFill
00149         , const unsigned int    maxChars
00150         , const char* const     repText1
00151         , const char* const     repText2 = 0
00152         , const char* const     repText3 = 0
00153         , const char* const     repText4 = 0
00154     ) = 0;
00155 
00156 
00157     // -----------------------------------------------------------------------
00158     //  Getter methods
00159     // -----------------------------------------------------------------------
00160     const XMLCh* getLanguageName() const;
00161 
00162 
00163 protected :
00164     // -----------------------------------------------------------------------
00165     //  Hidden Constructors
00166     // -----------------------------------------------------------------------
00167     XMLMsgLoader();
00168 
00169 
00170     // -----------------------------------------------------------------------
00171     //  Protected helper methods
00172     // -----------------------------------------------------------------------
00173     void setLanguageName(XMLCh* const nameToAdopt);
00174 
00175 
00176 private :
00177     // -----------------------------------------------------------------------
00178     //  Unimplemented constructors and operators
00179     // -----------------------------------------------------------------------
00180     XMLMsgLoader(const XMLMsgLoader&);
00181     void operator=(const XMLMsgLoader&);
00182 
00183 
00184     // -----------------------------------------------------------------------
00185     //  Private data members
00186     //
00187     //  fLanguage
00188     //      This is the language that is represented by this instance of the
00189     //      loader. The derived class must pass this through for storage and
00190     //      we adopt it and delete it when we go.
00191     // -----------------------------------------------------------------------
00192     XMLCh*  fLanguage;
00193 };
00194 
00195 
00196 // ---------------------------------------------------------------------------
00197 //  XMLMsgLoader: Public Constructors and Destructor
00198 // ---------------------------------------------------------------------------
00199 inline XMLMsgLoader::~XMLMsgLoader()
00200 {
00201     delete [] fLanguage;
00202 }
00203 
00204 
00205 // ---------------------------------------------------------------------------
00206 //  XMLMsgLoader: Hidden Constructors
00207 // ---------------------------------------------------------------------------
00208 inline XMLMsgLoader::XMLMsgLoader() :
00209 
00210     fLanguage(0)
00211 {
00212 }
00213 
00214 
00215 // ---------------------------------------------------------------------------
00216 //  XMLMsgLoader: Getter methods
00217 // ---------------------------------------------------------------------------
00218 inline const XMLCh* XMLMsgLoader::getLanguageName() const
00219 {
00220     return fLanguage;
00221 }
00222 
00223 
00224 // ---------------------------------------------------------------------------
00225 //  XMLMsgLoader: Protected helper methods
00226 // ---------------------------------------------------------------------------
00227 inline void XMLMsgLoader::setLanguageName(XMLCh* const nameToAdopt)
00228 {
00229     delete [] fLanguage;
00230     fLanguage = nameToAdopt;
00231 }
00232 
00233 #endif


Copyright © 2000 The Apache Software Foundation. All Rights Reserved.