XMLResourceIdentifier.hpp Source File

00001 /*
00002  * Copyright 1999-2000,2004 The Apache Software Foundation.
00003  * 
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  * 
00008  *      http://www.apache.org/licenses/LICENSE-2.0
00009  * 
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 
00017 /*
00018  * $Log: XMLResourceIdentifier.hpp,v $
00019  * Revision 1.7  2004/09/26 01:06:31  cargilld
00020  * Fix documentation generation problem.  Replace <pre> with <code>.  Patch from James Littlejohn.
00021  *
00022  * Revision 1.6  2004/09/08 13:56:24  peiyongz
00023  * Apache License Version 2.0
00024  *
00025  * Revision 1.5  2004/02/15 19:37:16  amassari
00026  * Removed cause for warnings in VC 7.1
00027  *
00028  * Revision 1.4  2004/02/13 14:28:30  cargilld
00029  * Fix for bug 26900 (remove virtual on destructor)
00030  *
00031  * Revision 1.3  2004/01/29 11:48:47  cargilld
00032  * Code cleanup changes to get rid of various compiler diagnostic messages.
00033  *
00034  * Revision 1.2  2003/11/25 18:16:38  knoaman
00035  * Documentation update. Thanks to David Cargill.
00036  *
00037  * Revision 1.1  2003/10/30 21:37:32  knoaman
00038  * Enhanced Entity Resolver Support. Thanks to David Cargill.
00039  *
00040  *
00041  * Revision 1.1    1999/11/09 01:07:44  twl
00042  * Initial checkin
00043  *
00044  */
00045 
00046 #ifndef XMLRESOURCEIDENTIFIER_HPP
00047 #define XMLRESOURCEIDENTIFIER_HPP
00048 
00049 XERCES_CPP_NAMESPACE_BEGIN
00050 
00117 class  XMLResourceIdentifier
00118 {
00119 public:
00120 
00121     enum ResourceIdentifierType {
00122         SchemaGrammar = 0,
00123         SchemaImport,
00124         SchemaInclude,
00125         SchemaRedefine ,
00126         ExternalEntity,
00127         UnKnown = 255
00129     };
00130 
00135     XMLResourceIdentifier(const ResourceIdentifierType resourceIdentitiferType
00136                             , const XMLCh* const  systemId
00137                             , const XMLCh* const  nameSpace = 0
00138                             , const XMLCh* const  publicId = 0
00139                             , const XMLCh* const  baseURI = 0);
00140 
00142     ~XMLResourceIdentifier()
00143     {
00144     }
00145 
00147 
00148     // -----------------------------------------------------------------------
00149     //  Getter methods
00150     // -----------------------------------------------------------------------
00151     ResourceIdentifierType getResourceIdentifierType() const;
00152     const XMLCh* getPublicId()          const;
00153     const XMLCh* getSystemId()          const;
00154     const XMLCh* getSchemaLocation()    const;
00155     const XMLCh* getBaseURI()           const;
00156     const XMLCh* getNameSpace()         const;
00157 
00158 private :
00159 
00160     const ResourceIdentifierType    fResourceIdentifierType;
00161     const XMLCh*                    fPublicId;
00162     const XMLCh*                    fSystemId;
00163     const XMLCh*                    fBaseURI;
00164     const XMLCh*                    fNameSpace;
00165 
00166 
00167     /* Unimplemented constructors and operators */
00168 
00169     /* Copy constructor */
00170     XMLResourceIdentifier(const XMLResourceIdentifier&);
00171 
00172     /* Assignment operator */
00173     XMLResourceIdentifier& operator=(const XMLResourceIdentifier&);
00174 
00175 };
00176 
00177 inline XMLResourceIdentifier::ResourceIdentifierType XMLResourceIdentifier::getResourceIdentifierType() const 
00178 {
00179     return fResourceIdentifierType;
00180 }
00181 
00182 inline const XMLCh* XMLResourceIdentifier::getPublicId() const
00183 {
00184     return fPublicId;
00185 }
00186 
00187 inline const XMLCh* XMLResourceIdentifier::getSystemId() const
00188 {
00189     return fSystemId;
00190 }
00191 
00192 inline const XMLCh* XMLResourceIdentifier::getSchemaLocation() const
00193 {
00194     return fSystemId;
00195 }
00196 
00197 inline const XMLCh* XMLResourceIdentifier::getBaseURI() const
00198 {
00199     return fBaseURI;
00200 }
00201 
00202 inline const XMLCh* XMLResourceIdentifier::getNameSpace() const
00203 {
00204     return fNameSpace;
00205 }
00206 
00207 inline XMLResourceIdentifier::XMLResourceIdentifier(const ResourceIdentifierType resourceIdentifierType
00208                             , const XMLCh* const  systemId
00209                             , const XMLCh* const  nameSpace
00210                             , const XMLCh* const  publicId
00211                             , const XMLCh* const  baseURI )
00212     : fResourceIdentifierType(resourceIdentifierType)
00213     , fPublicId(publicId)
00214     , fSystemId(systemId)
00215     , fBaseURI(baseURI)
00216     , fNameSpace(nameSpace)    
00217 {
00218 }
00219 
00220 XERCES_CPP_NAMESPACE_END
00221 
00222 #endif