XMLResourceIdentifier.hpp Source 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: XMLResourceIdentifier.hpp,v $
00059  * Revision 1.2  2003/11/25 18:16:38  knoaman
00060  * Documentation update. Thanks to David Cargill.
00061  *
00062  * Revision 1.1  2003/10/30 21:37:32  knoaman
00063  * Enhanced Entity Resolver Support. Thanks to David Cargill.
00064  *
00065  *
00066  * Revision 1.1    1999/11/09 01:07:44  twl
00067  * Initial checkin
00068  *
00069  */
00070 
00071 #ifndef XMLRESOURCEIDENTIFIER_HPP
00072 #define XMLRESOURCEIDENTIFIER_HPP
00073 
00074 XERCES_CPP_NAMESPACE_BEGIN
00075 
00142 class  XMLResourceIdentifier
00143 {
00144 public:
00145 
00146     enum ResourceIdentifierType {
00147         SchemaGrammar = 0,
00148         SchemaImport,
00149         SchemaInclude,
00150         SchemaRedefine ,
00151         ExternalEntity,
00152         UnKnown = 255
00154     };
00155 
00160     XMLResourceIdentifier(const ResourceIdentifierType resourceIdentitiferType
00161                             , const XMLCh* const  systemId
00162                             , const XMLCh* const  nameSpace = 0
00163                             , const XMLCh* const  publicId = 0
00164                             , const XMLCh* const  baseURI = 0);
00165 
00167     virtual ~XMLResourceIdentifier()
00168     {
00169     }
00170 
00172 
00173     // -----------------------------------------------------------------------
00174     //  Getter methods
00175     // -----------------------------------------------------------------------
00176     const ResourceIdentifierType getResourceIdentifierType() const;
00177     const XMLCh* getPublicId()          const;
00178     const XMLCh* getSystemId()          const;
00179     const XMLCh* getSchemaLocation()    const;
00180     const XMLCh* getBaseURI()           const;
00181     const XMLCh* getNameSpace()         const;
00182 
00183 private :
00184 
00185     const ResourceIdentifierType    fResourceIdentifierType;
00186     const XMLCh*                    fPublicId;
00187     const XMLCh*                    fSystemId;
00188     const XMLCh*                    fBaseURI;
00189     const XMLCh*                    fNameSpace;
00190 
00191 
00192     /* Unimplemented constructors and operators */
00193 
00194     /* Copy constructor */
00195     XMLResourceIdentifier(const XMLResourceIdentifier&);
00196 
00197     /* Assignment operator */
00198     XMLResourceIdentifier& operator=(const XMLResourceIdentifier&);
00199 
00200 };
00201 
00202 inline const XMLResourceIdentifier::ResourceIdentifierType XMLResourceIdentifier::getResourceIdentifierType() const 
00203 {
00204     return fResourceIdentifierType;
00205 }
00206 
00207 inline const XMLCh* XMLResourceIdentifier::getPublicId() const
00208 {
00209     return fPublicId;
00210 }
00211 
00212 inline const XMLCh* XMLResourceIdentifier::getSystemId() const
00213 {
00214     return fSystemId;
00215 }
00216 
00217 inline const XMLCh* XMLResourceIdentifier::getSchemaLocation() const
00218 {
00219     return fSystemId;
00220 }
00221 
00222 inline const XMLCh* XMLResourceIdentifier::getBaseURI() const
00223 {
00224     return fBaseURI;
00225 }
00226 
00227 inline const XMLCh* XMLResourceIdentifier::getNameSpace() const
00228 {
00229     return fNameSpace;
00230 }
00231 
00232 inline XMLResourceIdentifier::XMLResourceIdentifier(const ResourceIdentifierType resourceIdentifierType
00233                             , const XMLCh* const  systemId
00234                             , const XMLCh* const  nameSpace
00235                             , const XMLCh* const  publicId
00236                             , const XMLCh* const  baseURI ) :
00237     fResourceIdentifierType(resourceIdentifierType),
00238     fSystemId(systemId),
00239     fNameSpace(nameSpace),
00240     fPublicId(publicId),
00241     fBaseURI(baseURI)
00242 {
00243 }
00244 
00245 XERCES_CPP_NAMESPACE_END
00246 
00247 #endif