DatatypeValidator.hpp
上传用户:huihehuasu
上传日期:2007-01-10
资源大小:6948k
文件大小:14k
源码类别:

xml/soap/webservice

开发平台:

C/C++

  1. /*
  2.  * The Apache Software License, Version 1.1
  3.  *
  4.  * Copyright (c) 2001 The Apache Software Foundation.  All rights
  5.  * reserved.
  6.  *
  7.  * Redistribution and use in source and binary forms, with or without
  8.  * modification, are permitted provided that the following conditions
  9.  * are met:
  10.  *
  11.  * 1. Redistributions of source code must retain the above copyright
  12.  *    notice, this list of conditions and the following disclaimer.
  13.  *
  14.  * 2. Redistributions in binary form must reproduce the above copyright
  15.  *    notice, this list of conditions and the following disclaimer in
  16.  *    the documentation and/or other materials provided with the
  17.  *    distribution.
  18.  *
  19.  * 3. The end-user documentation included with the redistribution,
  20.  *    if any, must include the following acknowledgment:
  21.  *       "This product includes software developed by the
  22.  *        Apache Software Foundation (http://www.apache.org/)."
  23.  *    Alternately, this acknowledgment may appear in the software itself,
  24.  *    if and wherever such third-party acknowledgments normally appear.
  25.  *
  26.  * 4. The names "Xerces" and "Apache Software Foundation" must
  27.  *    not be used to endorse or promote products derived from this
  28.  *    software without prior written permission. For written
  29.  *    permission, please contact apache@apache.org.
  30.  *
  31.  * 5. Products derived from this software may not be called "Apache",
  32.  *    nor may "Apache" appear in their name, without prior written
  33.  *    permission of the Apache Software Foundation.
  34.  *
  35.  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
  36.  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
  37.  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
  38.  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
  39.  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
  40.  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
  41.  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
  42.  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
  43.  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
  44.  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
  45.  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  46.  * SUCH DAMAGE.
  47.  * ====================================================================
  48.  *
  49.  * This software consists of voluntary contributions made by many
  50.  * individuals on behalf of the Apache Software Foundation, and was
  51.  * originally based on software copyright (c) 2001, International
  52.  * Business Machines, Inc., http://www.ibm.com .  For more information
  53.  * on the Apache Software Foundation, please see
  54.  * <http://www.apache.org/>.
  55.  */
  56. /*
  57.  * $Id: DatatypeValidator.hpp,v 1.14 2001/09/25 15:59:37 peiyongz Exp $
  58.  */
  59. #if !defined(DATATYPEVALIDATOR_HPP)
  60. #define DATATYPEVALIDATOR_HPP
  61. #include <util/RefHashTableOf.hpp>
  62. #include <util/KVStringPair.hpp>
  63. #include <dom/DOMString.hpp>
  64. #include <util/regx/RegularExpression.hpp>
  65. /**
  66.   * DataTypeValidator defines the interface that data type validators must
  67.   * obey. These validators can be supplied by the application writer and may
  68.   * be useful as standalone code as well as plugins to the validator
  69.   * architecture.
  70.   *
  71.   * Notice:
  72.   * The datatype validator will own the facets hashtable passed to it during
  73.   * construction, which means that the datatype validator will be responsible
  74.   * for the deletion. The facets hashtable will be created during parsing and
  75.   * passed to the appropriate datatype validator which in turn will delete it
  76.   * upon its destruction.
  77.   *
  78.   */
  79. class VALIDATORS_EXPORT DatatypeValidator
  80. {
  81. public:
  82.     // -----------------------------------------------------------------------
  83.     // Constant data
  84.     // -----------------------------------------------------------------------
  85. //facets
  86. enum {
  87.         FACET_LENGTH         = 1,
  88.         FACET_MINLENGTH      = 1<<1,
  89.         FACET_MAXLENGTH      = 1<<2,
  90.         FACET_PATTERN        = 1<<3,
  91.         FACET_ENUMERATION    = 1<<4,
  92.         FACET_MAXINCLUSIVE   = 1<<5,
  93.         FACET_MAXEXCLUSIVE   = 1<<6,
  94.         FACET_MININCLUSIVE   = 1<<7,
  95.         FACET_MINEXCLUSIVE   = 1<<8,
  96.         FACET_TOTALDIGITS    = 1<<9,
  97.         FACET_FRACTIONDIGITS = 1<<10,
  98.         FACET_ENCODING       = 1<<11,
  99.         FACET_DURATION       = 1<<12,
  100.         FACET_PERIOD         = 1<<13,
  101.         FACET_WHITESPACE     = 1<<14
  102.     };
  103.     //2.4.2.6 whiteSpace - Datatypes
  104. enum {
  105.         PRESERVE = 0,
  106.         REPLACE  = 1,
  107.         COLLAPSE = 2
  108.     };
  109.     enum ValidatorType {
  110.         String,
  111.         AnyURI,
  112.         QName,
  113.         Name,
  114.         NCName,
  115.         Boolean,
  116.         Float,
  117.         Double,
  118.         Decimal,
  119.         HexBinary,
  120.         Base64Binary,
  121.         Duration,
  122.         DateTime,
  123.         Date,
  124.         Time,
  125.         MonthDay,
  126.         YearMonth,
  127.         Year,
  128.         Month,
  129.         Day,
  130.         ID,
  131.         IDREF,
  132.         ENTITY,
  133.         NOTATION,
  134.         List,
  135.         Union,
  136.         AnySimpleType
  137.     };
  138.     // -----------------------------------------------------------------------
  139.     //  Public Destructor
  140.     // -----------------------------------------------------------------------
  141. /** @name Destructor. */
  142.     //@{
  143.     virtual ~DatatypeValidator();
  144. //@}
  145.     // -----------------------------------------------------------------------
  146.     // Getter methods
  147.     // -----------------------------------------------------------------------
  148.     /** @name Getter Functions */
  149.     //@{
  150.     /**
  151.       * Returns the final values of the simpleType
  152.       */
  153.     int getFinalSet() const;
  154.     /**
  155.       * Returns the datatype facet if any is set.
  156.       */
  157. RefHashTableOf<KVStringPair>* getFacets() const;
  158.     /**
  159.       * Returns default value (collapse) for whiteSpace facet.
  160.       * This function is overwritten in StringDatatypeValidator.
  161.       */
  162.     virtual short getWSFacet () const;
  163.     /**
  164.       * Returns the base datatype validator if set.
  165.       */
  166.     DatatypeValidator* getBaseValidator() const;
  167.     /**
  168.       * Returns the 'class' type of datatype validator
  169.       */
  170.     ValidatorType getType() const;
  171.     /**
  172.       * Returns whether the type is atomic or not
  173.       *
  174.       * To be redefined in List/Union validators  
  175.       */
  176.     virtual bool isAtomic() const;
  177.     //@}
  178.     // -----------------------------------------------------------------------
  179.     // Validation methods
  180.     // -----------------------------------------------------------------------
  181.     /** @name Validation Function */
  182.     //@{
  183.      /**
  184.    * Checks that the "content" string is valid datatype.
  185.        * If invalid, a Datatype validation exception is thrown.
  186.    *
  187.    * @param  content   A string containing the content to be validated
  188.    *
  189.    */
  190. virtual void validate(const XMLCh* const content) = 0;
  191.     /**
  192.       * Checks whether a given type can be used as a substitute
  193.       *
  194.       * @param  toCheck    A datatype validator of the type to be used as a
  195.       *                    substitute
  196.       *
  197.       * To be redefined in UnionDatatypeValidator
  198.       */
  199.     virtual bool isSubstitutableBy(const DatatypeValidator* const toCheck);
  200.  //@}
  201.     // -----------------------------------------------------------------------
  202.     // Compare methods
  203.     // -----------------------------------------------------------------------
  204.     /** @name Compare Function */
  205.     //@{
  206.     /**
  207.       * Compares content in the Domain value vs. lexical value.
  208.       *
  209.       * e.g. If type is a float then 1.0 may be equivalent to 1 even though
  210.       * both are lexically different.
  211.       *
  212.       * @param  value1    string to compare
  213.       *
  214.       * @param  value2    string to compare
  215.       *
  216.       * We will provide a default behavior that should be redefined at the
  217.       * children level, if necessary (i.e. boolean case).
  218.       */
  219.     virtual int compare(const XMLCh* const value1, const XMLCh* const value2);
  220.     //@}
  221.     /**
  222.       * Returns an instance of the base datatype validator class
  223.   * Used by the DatatypeValidatorFactory.
  224.       */
  225. virtual DatatypeValidator* newInstance(RefHashTableOf<KVStringPair>* const,
  226.                                            RefVectorOf<XMLCh>* const enums,
  227.                                            const int finalSet) = 0;
  228. protected:
  229.     // -----------------------------------------------------------------------
  230.     //  Protected Constructors
  231.     // -----------------------------------------------------------------------
  232.     /** @name Constructors */
  233.     //@{
  234.     /**
  235.       *
  236.       * @param  baseValidator  The base datatype validator for derived
  237.       *                        validators. Null if native validator.
  238.       *
  239.       * @param  facets         A hashtable of datatype facets (except enum).
  240.       *
  241.       * @param  finalSet       'final' value of the simpleType
  242.       */
  243. DatatypeValidator(DatatypeValidator* const baseValidator,
  244.                       RefHashTableOf<KVStringPair>* const facets,
  245.                       const int finalSet,
  246.                       const ValidatorType type);
  247.     //@}
  248. friend class DatatypeValidatorFactory;
  249.     /**
  250.       * facetDefined
  251.   */
  252. int   getFacetsDefined() const;
  253.     void  setFacetsDefined(int);
  254.     /**
  255.       * fixed
  256.   */
  257. int   getFixed() const;
  258.     void  setFixed(int);
  259.     /**
  260.       * fPattern
  261.   */
  262.     const XMLCh* getPattern() const;
  263. void         setPattern(const XMLCh* );
  264.     /**
  265.       * fRegex
  266.   */
  267. RegularExpression* getRegex() const;
  268. void               setRegex(RegularExpression* const);
  269.     /**
  270.       * set fType
  271.       */
  272.     void setType(ValidatorType);
  273.     /**
  274.       * get WSString
  275.       */
  276.     const XMLCh*   getWSstring(const short WSType) const;
  277. private:
  278.     // -----------------------------------------------------------------------
  279.     //  CleanUp methods
  280.     // -----------------------------------------------------------------------
  281. void cleanUp();
  282.     // -----------------------------------------------------------------------
  283.     //  Private data members
  284.     //
  285.     //  fFinalSet
  286.     //      stores "final" values of simpleTypes
  287.     //
  288.     //  fBaseValidator
  289.     //      This is a pointer to a base datatype validator. If value is null,
  290. //      it means we have a native datatype validator not a derived one.
  291. //
  292.     //  fFacets
  293.     //      This is a hashtable of dataype facets.
  294.     //
  295.     //  fType
  296.     //      Stores the class type of datatype validator
  297.     //
  298.     //  fFacetsDefined
  299.     //      Stores the constaiting facets flag
  300.     //
  301.     //  fPattern
  302.     //      the pointer to the String of the pattern. The actual data is
  303.     //      in the Facets.
  304.     //
  305.     //  fRegex
  306.     //      pointer to the RegularExpress object
  307.     //
  308.     //
  309.     //  fFixed
  310.     //      if {fixed} is true, then types for which this type is the
  311.     //      {base type definition} cannot specify a value for a specific
  312.     //      facet.
  313.     //
  314.     // -----------------------------------------------------------------------
  315.     int                           fFinalSet;
  316.     int                           fFacetsDefined;
  317.     int                           fFixed;
  318.     ValidatorType                 fType;
  319. DatatypeValidator*            fBaseValidator;
  320. RefHashTableOf<KVStringPair>* fFacets;
  321.     XMLCh*                        fPattern;
  322.     RegularExpression*            fRegex;
  323. };
  324. // ---------------------------------------------------------------------------
  325. //  DatatypeValidator: Getters
  326. // ---------------------------------------------------------------------------
  327. inline int DatatypeValidator::getFinalSet() const {
  328.     return fFinalSet;
  329. }
  330. inline RefHashTableOf<KVStringPair>* DatatypeValidator::getFacets() const {
  331.     return fFacets;
  332. }
  333. inline DatatypeValidator* DatatypeValidator::getBaseValidator() const {
  334. return fBaseValidator;
  335. }
  336. inline short DatatypeValidator::getWSFacet() const {
  337.     return COLLAPSE;
  338. }
  339. inline DatatypeValidator::ValidatorType DatatypeValidator::getType() const
  340. {
  341.     return fType;
  342. }
  343. inline void DatatypeValidator::setType(ValidatorType theType)
  344. {
  345.     fType = theType;
  346. }
  347. // ---------------------------------------------------------------------------
  348. //  DatatypeValidator: CleanUp methods
  349. // ---------------------------------------------------------------------------
  350. inline void DatatypeValidator::cleanUp() {
  351. delete fFacets;
  352.     delete [] fPattern;
  353.     delete fRegex;
  354. }
  355. // ---------------------------------------------------------------------------
  356. //  DatatypeValidators: Compare methods
  357. // ---------------------------------------------------------------------------
  358. inline int DatatypeValidator::compare(const XMLCh* const lValue,
  359.                                       const XMLCh* const rValue)
  360. {
  361.     return XMLString::compareString(lValue, rValue);
  362. }
  363. // ---------------------------------------------------------------------------
  364. //  DatatypeValidators: Validation methods
  365. // ---------------------------------------------------------------------------
  366. inline bool
  367. DatatypeValidator::isSubstitutableBy(const DatatypeValidator* const toCheck)
  368. {
  369.     const DatatypeValidator* dv = toCheck;
  370. while (dv != 0) {
  371.         if (dv == this) {
  372.             return true;
  373.         }
  374.         dv = dv->getBaseValidator();
  375.     }
  376.     return false;
  377. }
  378. inline int DatatypeValidator::getFacetsDefined() const
  379. {
  380.     return fFacetsDefined;
  381. }
  382. inline void DatatypeValidator::setFacetsDefined(int facets)
  383. {
  384.     fFacetsDefined |= facets;
  385. }
  386. inline int DatatypeValidator::getFixed() const
  387. {
  388.     return fFixed;
  389. }
  390. inline void DatatypeValidator::setFixed(int fixed)
  391. {
  392.     fFixed |= fixed;
  393. }
  394. inline const XMLCh* DatatypeValidator::getPattern() const
  395. {
  396.     return fPattern;
  397. }
  398. inline void DatatypeValidator::setPattern(const XMLCh* pattern)
  399. {
  400.     delete [] fPattern;
  401.     fPattern = XMLString::replicate(pattern);
  402. }
  403. inline RegularExpression* DatatypeValidator::getRegex() const
  404. {
  405.     return fRegex;
  406. }
  407. inline void DatatypeValidator::setRegex(RegularExpression* const regex)
  408. {
  409.     fRegex = regex;
  410. }
  411. inline bool DatatypeValidator::isAtomic() const {
  412.     return true;
  413. }
  414. #endif
  415. /**
  416.   * End of file DatatypeValidator.hpp
  417.   */