SourceForge.net Logo
AnyAtomicType.hpp
Go to the documentation of this file.
00001 /*
00002  * Copyright (c) 2001-2008
00003  *     DecisionSoft Limited. All rights reserved.
00004  * Copyright (c) 2004-2008
00005  *     Oracle. All rights reserved.
00006  *
00007  * Licensed under the Apache License, Version 2.0 (the "License");
00008  * you may not use this file except in compliance with the License.
00009  * You may obtain a copy of the License at
00010  *
00011  *     http://www.apache.org/licenses/LICENSE-2.0
00012  *
00013  * Unless required by applicable law or agreed to in writing, software
00014  * distributed under the License is distributed on an "AS IS" BASIS,
00015  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00016  * See the License for the specific language governing permissions and
00017  * limitations under the License.
00018  *
00019  * $Id: AnyAtomicType.hpp 547 2008-06-06 14:41:18Z jpcs $
00020  */
00021 
00022 #ifndef _ANYATOMICTYPE_HPP
00023 #define _ANYATOMICTYPE_HPP
00024 
00025 #include <xqilla/framework/XQillaExport.hpp>
00026 #include <xqilla/items/Item.hpp>
00027 #include <xercesc/util/XercesDefs.hpp>
00028 
00029 class DynamicContext;
00030 class StaticContext;
00031 
00032 class XQILLA_API AnyAtomicType: public Item
00033 {
00034 
00035 public:
00036   enum AtomicObjectType {
00037     ANY_SIMPLE_TYPE    = 0,
00038     ANY_URI            = 1,
00039     BASE_64_BINARY     = 2,
00040     BOOLEAN            = 3,
00041     DATE               = 4,
00042     DATE_TIME          = 5,
00043     DAY_TIME_DURATION  = 6,
00044     DECIMAL            = 7,
00045     DOUBLE             = 8,
00046     DURATION           = 9,
00047     FLOAT              = 10,
00048     G_DAY              = 11,
00049     G_MONTH            = 12,
00050     G_MONTH_DAY        = 13,
00051     G_YEAR             = 14,
00052     G_YEAR_MONTH       = 15,
00053     HEX_BINARY         = 16,
00054     NOTATION           = 17,
00055     QNAME              = 18,
00056     STRING             = 19,
00057     TIME               = 20,
00058     UNTYPED_ATOMIC     = 21,
00059     YEAR_MONTH_DURATION= 22,
00060     NumAtomicObjectTypes= 23
00061   };
00062 
00063   typedef RefCountPointer<const AnyAtomicType> Ptr;
00064 
00065   /* isAtomicValue from Item */
00066   virtual bool isAtomicValue() const;
00067 
00068   /* isNode from Item */
00069   virtual bool isNode() const;
00070 
00071   virtual bool isFunction() const;
00072 
00073   /* is this type numeric?  Return false by default */
00074   virtual bool isNumericValue() const;
00075 
00076   /* is this type date or time based?  Return false by default */
00077   virtual bool isDateOrTimeTypeValue() const;
00078 
00079   /* Get the namespace uri of the primitive type (basic type) of this type */
00080   virtual const XMLCh* getPrimitiveTypeURI() const;
00081 
00082   /* Get the name of the primitive type (basic type) of this type (ie "decimal" for xs:decimal) */
00083   virtual const XMLCh* getPrimitiveTypeName() const = 0;
00084 
00085   /* Get the namespace URI for this type */
00086   virtual const XMLCh* getTypeURI() const = 0;
00087 
00088   /* Get the name of this type  (ie "integer" for xs:integer) */
00089   virtual const XMLCh* getTypeName() const = 0;
00090 
00091   virtual void generateEvents(EventHandler *events, const DynamicContext *context,
00092                               bool preserveNS = true, bool preserveType = true) const;
00093 
00094   /* If possible, cast this type to the target type  -- no casting table lookup made */
00095   AnyAtomicType::Ptr castAs(AtomicObjectType targetIndex, const DynamicContext* context) const;
00096 
00097   /* If possible, cast this type to the target type  -- no casting table lookup made */
00098   AnyAtomicType::Ptr castAsNoCheck(AtomicObjectType targetIndex, const XMLCh* targetURI, const XMLCh* targetType,
00099                                    const DynamicContext* context) const;
00100 
00101   /* If possible, cast this type to the target type  -- not virtual, this is the single entry point for casting */
00102   AnyAtomicType::Ptr castAs(AtomicObjectType targetIndex, const XMLCh* targetURI, const XMLCh* targetType,
00103                             const DynamicContext* context) const;
00104 
00105   /* Test if this type can be cast to the target type */
00106   virtual bool castable(AtomicObjectType targetIndex, const XMLCh* targetURI, const XMLCh* targetType,
00107                         const DynamicContext* context) const;
00108 
00109   /* returns the XMLCh* (canonical) representation of this type */
00110   virtual const XMLCh* asString(const DynamicContext* context) const = 0;
00111 
00112   /* returns true if the two objects are equal (whatever that means 
00113    * in the context of the datatype), false otherwise */
00114   virtual bool equals(const AnyAtomicType::Ptr &target, const DynamicContext* context) const = 0;
00115 
00116   /* Returns true if this typeName and uri match the given typeName and uri */
00117   virtual bool isOfType(const XMLCh* targetURI, const XMLCh* targetType, const DynamicContext* context) const;
00118 
00119   /* Returns true if this typeName and uri match the given typeName and uri,
00120    * or if any of this type's parents match the given typeName and uri */
00121   virtual bool isInstanceOfType(const XMLCh* targetURI, const XMLCh* targetType, const StaticContext* context) const;
00122 
00123   virtual void typeToBuffer(DynamicContext *context, XERCES_CPP_NAMESPACE_QUALIFIER XMLBuffer &buffer) const;
00124   
00137   bool castIsSupported(AtomicObjectType targetIndex, const DynamicContext* context) const;
00138 
00139   virtual AtomicObjectType getPrimitiveTypeIndex() const = 0;
00140  
00141   static const XMLCh fgDT_ANYATOMICTYPE[];
00142 
00143 protected:
00144   /* internal castAs method.  This one is virtual and does the real work */
00145   virtual AnyAtomicType::Ptr castAsInternal(AtomicObjectType targetIndex, const XMLCh* targetURI,
00146                                             const XMLCh* targetType, const DynamicContext* context) const;
00147 
00148 private:
00149 
00150   //friend class CastTable;
00151   //template <class TYPE> friend class DatatypeFactoryTemplate;
00152 
00153   // class that implements the Casting Table
00154   class CastTable {
00155     public: 
00156         CastTable();
00157         bool getCell(AtomicObjectType source, 
00158                      AtomicObjectType target) const;
00159     private:
00160         bool staticCastTable[NumAtomicObjectTypes][NumAtomicObjectTypes];
00161   };
00162 
00163 
00164   // reproduction of the XPath2 casting table: http://www.w3.org/TR/xquery-operators/#casting
00165   static const CastTable staticCastTable;  
00166 };
00167 
00168 #endif