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

Home

Readme
Download
Installation
Build

API Docs
Samples
Schema

FAQs
Programming
Migration

Releases
Bug-Reporting
Feedback

Y2K Compliance
PDF Document

CVS Repository
Mail Archive

API Docs for SAX and DOM
 

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

XMLUri.hpp

Go to the documentation of this file.
00001 /*
00002  * The Apache Software License, Version 1.1
00003  *
00004  * Copyright (c) 2001 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  * $Id: XMLUri.hpp,v 1.2 2002/02/20 18:17:02 tng Exp $
00059  * $Log: XMLUri.hpp,v $
00060  * Revision 1.2  2002/02/20 18:17:02  tng
00061  * [Bug 5977] Warnings on generating apiDocs.
00062  *
00063  * Revision 1.1.1.1  2002/02/01 22:22:17  peiyongz
00064  * sane_include
00065  *
00066  * Revision 1.3  2001/08/29 19:03:03  peiyongz
00067  * Bugzilla# 2816:on AIX 4.2, xlC 3 r ev.1, Compilation error on inline method
00068  *
00069  * Revision 1.2  2001/08/16 14:09:44  peiyongz
00070  * Removed unused ctors and methods
00071  *
00072  * Revision 1.1  2001/08/10 16:23:41  peiyongz
00073  * XMLUri: creation
00074  *
00075  *
00076  */
00077 
00078 #if !defined(XMLURI_HPP)
00079 #define XMLURI_HPP
00080 
00081 #include <xercesc/util/XercesDefs.hpp>
00082 #include <xercesc/util/XMLException.hpp>
00083 #include <xercesc/util/XMLUniDefs.hpp>
00084 #include <xercesc/util/XMLString.hpp>
00085 
00086 /*
00087  * This class is a direct port of Java's URI class, to distinguish
00088  * itself from the XMLURL, we use the name XMLUri instead of
00089  * XMLURI.
00090  *
00091  * TODO: how to relate XMLUri and XMLURL since URL is part of URI.
00092  *
00093  */
00094 
00095 class  XMLUri
00096 {
00097 public:
00098 
00099     // -----------------------------------------------------------------------
00100     //  Constructors and Destructor
00101     // -----------------------------------------------------------------------
00102 
00128     XMLUri(const XMLCh* const    uriSpec);
00129 
00142     XMLUri(const XMLUri* const     baseURI
00143          , const XMLCh* const      uriSpec);
00144 
00145     virtual ~XMLUri();
00146 
00147     // -----------------------------------------------------------------------
00148     //  Operators
00149     // -----------------------------------------------------------------------
00150 
00151 
00152     // -----------------------------------------------------------------------
00153     //  Getter methods
00154     // -----------------------------------------------------------------------
00155 
00161      const XMLCh* getScheme() const;
00162 
00168      const XMLCh* getUserInfo() const;
00169 
00170 
00176      const XMLCh* getHost() const;
00177 
00183      int getPort() const;
00184 
00191      const XMLCh* getPath() const;
00192 
00200      const XMLCh* getQueryString() const;
00201 
00209      const XMLCh* getFragment() const;
00210 
00211     // -----------------------------------------------------------------------
00212     //  Setter methods
00213     // -----------------------------------------------------------------------
00214 
00222      void setScheme(const XMLCh* const newScheme);
00223 
00231      void setUserInfo(const XMLCh* const newUserInfo);
00232 
00240      void setHost(const XMLCh* const newHost);
00241 
00251      void setPort(int newPort);
00252 
00273      void setPath(const XMLCh* const newPath);
00274 
00283      void setQueryString(const XMLCh* const newQueryString);
00284 
00293      void setFragment(const XMLCh* const newFragment);
00294 
00295      // -----------------------------------------------------------------------
00296     //  Miscellaneous methods
00297     // -----------------------------------------------------------------------
00298 
00299 private:
00300 
00301     static const XMLCh RESERVED_CHARACTERS[];
00302     static const XMLCh MARK_CHARACTERS[];
00303     static const XMLCh SCHEME_CHARACTERS[];
00304     static const XMLCh USERINFO_CHARACTERS[];
00305 
00309     XMLUri(const XMLUri& toCopy);
00310     XMLUri& operator=(const XMLUri& toAssign);
00311 
00312     // -----------------------------------------------------------------------
00313     //  Private helper methods
00314     // -----------------------------------------------------------------------
00315 
00321     static bool isReservedCharacter(const XMLCh theChar);
00322 
00328     static bool isUnreservedCharacter(const XMLCh theChar);
00329 
00337     static bool isConformantSchemeName(const XMLCh* const scheme);
00338 
00344     static void isConformantUserInfo(const XMLCh* const userInfo);
00345 
00353     static bool isURIString(const XMLCh* const uric);
00354 
00369      static bool isWellFormedAddress(const XMLCh* const addr);
00370 
00378      bool isGenericURI();
00379 
00380     // -----------------------------------------------------------------------
00381     //  Miscellaneous methods
00382     // -----------------------------------------------------------------------
00383 
00389      void initialize(const XMLUri& toCopy);
00390 
00405      void initialize(const XMLUri* const baseURI
00406                    , const XMLCh*  const uriSpec);
00407 
00414      void initializeScheme(const XMLCh* const uriSpec);
00415 
00423      void initializeAuthority(const XMLCh* const uriSpec);
00424 
00431      void initializePath(const XMLCh* const uriSpec);
00432 
00433     // -----------------------------------------------------------------------
00434     //  Data members
00435     //
00436     //  for all the data member, we own it,
00437     //  responsible for the creation and/or deletion for
00438     //  the memory allocated.
00439     //
00440     // -----------------------------------------------------------------------
00441 
00442     XMLCh*          fScheme;
00443     XMLCh*          fUserInfo;
00444     XMLCh*          fHost;
00445     int             fPort;
00446     XMLCh*          fPath;
00447     XMLCh*          fQueryString;
00448     XMLCh*          fFragment;
00449 
00450 };
00451 
00452 // ---------------------------------------------------------------------------
00453 //  XMLUri: Public operators
00454 // ---------------------------------------------------------------------------
00455 
00456 // ctor# 2
00457 inline XMLUri::XMLUri(const XMLCh* const uriSpec)
00458 :fScheme(0)
00459 ,fUserInfo(0)
00460 ,fHost(0)
00461 ,fPort(-1)
00462 ,fPath(0)
00463 ,fQueryString(0)
00464 ,fFragment(0)
00465 {
00466     initialize((XMLUri *)0, uriSpec);
00467 }
00468 
00469 // ctor# 7 relative ctor
00470 inline XMLUri::XMLUri(const XMLUri* const      baseURI
00471                     , const XMLCh* const       uriSpec)
00472 :fScheme(0)
00473 ,fUserInfo(0)
00474 ,fHost(0)
00475 ,fPort(-1)
00476 ,fPath(0)
00477 ,fQueryString(0)
00478 ,fFragment(0)
00479 {
00480     initialize(baseURI, uriSpec);
00481 }
00482 
00483 // ---------------------------------------------------------------------------
00484 //  XMLUri: Getter methods
00485 // ---------------------------------------------------------------------------
00486 inline const XMLCh* XMLUri::getScheme() const
00487 {
00488     return fScheme;
00489 }
00490 
00491 inline const XMLCh* XMLUri::getUserInfo() const
00492 {
00493     return fUserInfo;
00494 }
00495 
00496 inline const XMLCh* XMLUri::getHost() const
00497 {
00498     return fHost;
00499 }
00500 
00501 inline int XMLUri::getPort() const
00502 {
00503     return fPort;
00504 }
00505 
00506 inline const XMLCh* XMLUri::getPath() const
00507 {
00508     return fPath;
00509 }
00510 
00511 inline const XMLCh* XMLUri::getQueryString() const
00512 {
00513     return fQueryString;
00514 }
00515 
00516 inline const XMLCh* XMLUri::getFragment() const
00517 {
00518     return fFragment;
00519 }
00520 
00521 // ---------------------------------------------------------------------------
00522 //  XMLUri: Helper methods
00523 // ---------------------------------------------------------------------------
00524 inline bool XMLUri::isReservedCharacter(const XMLCh theChar)
00525 {
00526     return (XMLString::indexOf(RESERVED_CHARACTERS, theChar) != -1);
00527 }
00528 
00529 inline bool XMLUri::isUnreservedCharacter(const XMLCh theChar)
00530 {
00531     return (XMLString::isAlphaNum(theChar) ||
00532             XMLString::indexOf(MARK_CHARACTERS, theChar) != -1);
00533 }
00534 
00535 #endif


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