DOMXPathResult.hpp

Go to the documentation of this file.

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You under the Apache License, Version 2.0
 * (the "License"); you may not use this file except in compliance with
 * the License.  You may obtain a copy of the License at
 *
 *      http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

/*
 * $Id: DOMXPathResult.hpp 698579 2008-09-24 14:13:08Z borisk $
 */

#if !defined(XERCESC_INCLUDE_GUARD_DOMXPATHRESULT_HPP)
#define XERCESC_INCLUDE_GUARD_DOMXPATHRESULT_HPP

#include <xercesc/util/XercesDefs.hpp>

XERCES_CPP_NAMESPACE_BEGIN

class DOMXPathNSResolver;
class DOMXPathExpression;
class DOMTypeInfo;
class DOMNode;

class CDOM_EXPORT DOMXPathResult
{

protected:
    // -----------------------------------------------------------------------
    //  Hidden constructors
    // -----------------------------------------------------------------------
    DOMXPathResult() {};

private:
    // -----------------------------------------------------------------------
    // Unimplemented constructors and operators
    // -----------------------------------------------------------------------
    DOMXPathResult(const DOMXPathResult &);
    DOMXPathResult& operator = (const  DOMXPathResult&);

public:
    // -----------------------------------------------------------------------
    //  All constructors are hidden, just the destructor is available
    // -----------------------------------------------------------------------
    virtual ~DOMXPathResult() {};

    // -----------------------------------------------------------------------
    //  Class Types
    // -----------------------------------------------------------------------
    enum ResultType {
                /* XPath 1.0 */
                ANY_TYPE = 0,
                NUMBER_TYPE = 1,
                STRING_TYPE = 2,
                BOOLEAN_TYPE = 3,
                UNORDERED_NODE_ITERATOR_TYPE = 4,
                ORDERED_NODE_ITERATOR_TYPE = 5,
                UNORDERED_NODE_SNAPSHOT_TYPE = 6,
                ORDERED_NODE_SNAPSHOT_TYPE = 7,
                ANY_UNORDERED_NODE_TYPE = 8,
                FIRST_ORDERED_NODE_TYPE = 9,
                /* XPath 2.0 */
                FIRST_RESULT_TYPE    = 100,
                ITERATOR_RESULT_TYPE = 101,
                SNAPSHOT_RESULT_TYPE = 102
    };


    // -----------------------------------------------------------------------
    // Virtual DOMXPathResult interface
    // -----------------------------------------------------------------------

    virtual ResultType getResultType() const = 0;

    virtual const DOMTypeInfo *getTypeInfo() const = 0;

    virtual bool isNode() const = 0;

    virtual bool getBooleanValue() const = 0;

    virtual int getIntegerValue() const = 0;

    virtual double getNumberValue() const = 0;

    virtual const XMLCh* getStringValue() const = 0;

    virtual DOMNode* getNodeValue() const = 0;

    virtual bool iterateNext() = 0;

    virtual bool getInvalidIteratorState() const = 0;

    virtual bool snapshotItem(XMLSize_t index) = 0;

    virtual XMLSize_t getSnapshotLength() const = 0;


    // -----------------------------------------------------------------------
    //  Non-standard Extension
    // -----------------------------------------------------------------------
    virtual void release() = 0;
};

XERCES_CPP_NAMESPACE_END

#endif