00001 /*
00002  * Copyright 2006-2008 The FLWOR Foundation.
00003  *
00004  * Licensed under the Apache License, Version 2.0 (the "License");
00005  * you may not use this file except in compliance with the License.
00006  * You may obtain a copy of the License at
00007  * 
00008  * http://www.apache.org/licenses/LICENSE-2.0
00009  *
00010  * Unless required by applicable law or agreed to in writing, software
00011  * distributed under the License is distributed on an "AS IS" BASIS,
00012  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
00013  * See the License for the specific language governing permissions and
00014  * limitations under the License.
00015  */
00016 #ifndef ZORBA_ITEM_SEQUENCE_API_H
00017 #define ZORBA_ITEM_SEQUENCE_API_H
00018 
00019 #include <zorba/api_shared_types.h>
00020 
00021 namespace zorba { 
00022 
00023   /** \brief This interface represents an instance of the XQuery 1.0 and XPath 2.0 Data Model (XDM).
00024    *
00025    * See http://www.w3.org/TR/xpath-datamodel/.
00026    */
00027   class ItemSequence
00028   {
00029     public:
00030       /** \brief Destructor
00031        */
00032       virtual ~ItemSequence() { }
00033 
00034       /** \brief Get the next Item of the sequence.
00035        *
00036        * @param aItem the next Item of the sequence if true is returned by the function.
00037        * @return true if the sequence is not exhausted, false otherwise.
00038        * @throw ZorbaException if an error occured.
00039        */
00040       virtual bool next(Item& aItem) = 0;
00041 
00042   }; /* class ItemSequence */
00043 
00044 } // namespace zorba
00045 #endif
Zorba

item_sequence.h
