DOMXPathResult.hpp Source File

00001 #ifndef DOMXPathResult_HEADER_GUARD_
00002 #define DOMXPathResult_HEADER_GUARD_
00003 
00004 /*
00005  * The Apache Software License, Version 1.1
00006  *
00007  * Copyright (c) 2001-2003 The Apache Software Foundation.  All rights
00008  * reserved.
00009  *
00010  * Redistribution and use in source and binary forms, with or without
00011  * modification, are permitted provided that the following conditions
00012  * are met:
00013  *
00014  * 1. Redistributions of source code must retain the above copyright
00015  *    notice, this list of conditions and the following disclaimer.
00016  *
00017  * 2. Redistributions in binary form must reproduce the above copyright
00018  *    notice, this list of conditions and the following disclaimer in
00019  *    the documentation and/or other materials provided with the
00020  *    distribution.
00021  *
00022  * 3. The end-user documentation included with the redistribution,
00023  *    if any, must include the following acknowledgment:
00024  *       "This product includes software developed by the
00025  *        Apache Software Foundation (http://www.apache.org/)."
00026  *    Alternately, this acknowledgment may appear in the software itself,
00027  *    if and wherever such third-party acknowledgments normally appear.
00028  *
00029  * 4. The names "Xerces" and "Apache Software Foundation" must
00030  *    not be used to endorse or promote products derived from this
00031  *    software without prior written permission. For written
00032  *    permission, please contact apache\@apache.org.
00033  *
00034  * 5. Products derived from this software may not be called "Apache",
00035  *    nor may "Apache" appear in their name, without prior written
00036  *    permission of the Apache Software Foundation.
00037  *
00038  * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
00039  * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
00040  * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
00041  * DISCLAIMED.  IN NO EVENT SHALL THE APACHE SOFTWARE FOUNDATION OR
00042  * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
00043  * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
00044  * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
00045  * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
00046  * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
00047  * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
00048  * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
00049  * SUCH DAMAGE.
00050  * ====================================================================
00051  *
00052  * This software consists of voluntary contributions made by many
00053  * individuals on behalf of the Apache Software Foundation, and was
00054  * originally based on software copyright (c) 2001, International
00055  * Business Machines, Inc., http://www.ibm.com .  For more information
00056  * on the Apache Software Foundation, please see
00057  * <http://www.apache.org/>.
00058  */
00059 
00060 #include <xercesc/util/XercesDefs.hpp>
00061 
00062 XERCES_CPP_NAMESPACE_BEGIN
00063 
00064 class DOMXPathNSResolver;
00065 class DOMXPathExpression;
00066 class DOMNode;
00067 
00076 class  DOMXPathResult
00077 {
00078 
00079 protected:
00080     // -----------------------------------------------------------------------
00081     //  Hidden constructors
00082     // -----------------------------------------------------------------------
00085     DOMXPathResult() {};
00087 
00088 private:
00089     // -----------------------------------------------------------------------
00090     // Unimplemented constructors and operators
00091     // -----------------------------------------------------------------------
00094     DOMXPathResult(const DOMXPathResult &);
00095     DOMXPathResult& operator = (const  DOMXPathResult&);
00097 
00098 public:
00099     // -----------------------------------------------------------------------
00100     //  All constructors are hidden, just the destructor is available
00101     // -----------------------------------------------------------------------
00108     virtual ~DOMXPathResult() {};
00110 
00111     // -----------------------------------------------------------------------
00112     //  Class Types
00113     // -----------------------------------------------------------------------
00174     enum resultType {
00175                 ANY_TYPE = 0,
00176                 NUMBER_TYPE = 1,
00177                 STRING_TYPE = 2,
00178                 BOOLEAN_TYPE = 3,
00179                 UNORDERED_NODE_ITERATOR_TYPE = 4,
00180                 ORDERED_NODE_ITERATOR_TYPE = 5,
00181                 UNORDERED_NODE_SNAPSHOT_TYPE = 6,
00182                 ORDERED_NODE_SNAPSHOT_TYPE = 7,
00183                 ANY_UNORDERED_NODE_TYPE = 8,
00184                 FIRST_ORDERED_NODE_TYPE = 9
00185     };
00187 
00188 
00189     // -----------------------------------------------------------------------
00190     // Virtual DOMDocument interface
00191     // -----------------------------------------------------------------------
00194 
00195 
00203     virtual bool getBooleanValue() const = 0;
00204 
00214     virtual bool getInvalidIteratorState() const = 0;
00215 
00226     virtual double getNumberValue() const = 0;
00227 
00235     virtual short getResultType() const = 0;
00236         
00244     virtual DOMNode *getSingleNodeValue() const = 0;
00245 
00255     virtual unsigned long getSnapshotLength() const = 0;
00256         
00264     virtual const XMLCh* getStringValue() const = 0;
00265     
00274     virtual DOMNode* iterateNext() const = 0;
00275 
00286     virtual DOMNode* snapshotItem(unsigned long index) const = 0;
00287 
00289 };
00290 
00291 XERCES_CPP_NAMESPACE_END
00292 
00293 #endif