# XQilla Simple API Documentation

- Main Page
- Namespaces
- Classes
- Files
- Examples

- File List
- File Members

# ATStringOrDerived.hpp

Go to the documentation of this file.

    00001 /*
    00002  * Copyright (c) 2001, 2008,
    00003  *     DecisionSoft Limited. All rights reserved.
    00004  * Copyright (c) 2004, 2015 Oracle and/or its affiliates. All rights reserved.
    00005  *
    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
    00020 #ifndef _ATSTRINGORDERIVED_HPP
    00021 #define _ATSTRINGORDERIVED_HPP
    00022
    00023 #include <xercesc/util/XercesDefs.hpp>
    00024 #include <xqilla/framework/XQillaExport.hpp>
    00025 #include <xqilla/items/AnyAtomicType.hpp>
    00026 #include <xqilla/items/Numeric.hpp>
    00027
    00028 class Collation;
    00029 class Result;
    00030 class DynamicContext;
    00031
    00032 class XQILLA_API ATStringOrDerived : public AnyAtomicType
    00033 {
    00034 public:
    00035   typedef RefCountPointer<const ATStringOrDerived> Ptr;
    00036
    00037   /* Get the name of the primitive type (basic type) of this type
    00038    * (ie "decimal" for xs:decimal) */
    00039   virtual const XMLCh* getPrimitiveTypeName() const = 0;
    00040
    00041   /* Get the namespace URI for this type */
    00042   virtual const XMLCh* getTypeURI() const = 0;
    00043
    00044   /* Get the name of this type  (ie "integer" for xs:integer) */
    00045   virtual const XMLCh* getTypeName() const = 0;
    00046
    00047   /* returns the XMLCh* (canonical) representation of this type */
    00048   virtual const XMLCh* asString(const DynamicContext* context) const = 0;
    00049
    00050   /* returns this string as a set of codepoints */
    00051   virtual Result asCodepoints(const DynamicContext* context) const = 0;
    00052
    00053   /* returns the length of this string */
    00054   virtual unsigned int getLength() const = 0;
    00055
    00056   /* returns the substring starting at startingLoc of given length */
    00057   virtual ATStringOrDerived::Ptr substring(const Numeric::Ptr &startingLoc, const Numeric::Ptr &length, const DynamicContext* context) const = 0;
    00058
    00059   /* returns the substring that occurs after the first occurence of pattern */
    00060   virtual ATStringOrDerived::Ptr substringAfter(const ATStringOrDerived::Ptr &pattern, Collation* collation, const DynamicContext* context) const = 0;
    00061
    00062   /* returns the substring that occurs before the first occurence of pattern */
    00063   virtual ATStringOrDerived::Ptr substringBefore(const ATStringOrDerived::Ptr &pattern, Collation* collation, const DynamicContext* context) const = 0;
    00064
    00065   /* returns true if the two objects' URI are equal (string comparison)
    00066    * false otherwise */
    00067   virtual bool equals(const AnyAtomicType::Ptr &target, const DynamicContext* context) const = 0;
    00068
    00069   virtual AnyAtomicType::AtomicObjectType getPrimitiveTypeIndex() const = 0;
    00070 };
    00071
    00072 #endif //  _ATSTRINGORDERIVED_HPP