item_sequence.h
Go to the documentation of this file.
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/config.h>
00020 #include <zorba/api_shared_types.h>
00021 
00022 namespace zorba { 
00023 
00024   /** 
00025    * \brief This interface represents an instance of the XQuery 1.0 and XPath 2.0
00026    * Data Model (XDM).
00027    *
00028    * See http://www.w3.org/TR/xpath-datamodel/.
00029    */
00030   class ZORBA_DLL_PUBLIC ItemSequence : virtual public SmartObject
00031   {
00032     public:
00033       /**
00034        * \brief Destructor
00035        */
00036       virtual ~ItemSequence() { }
00037 
00038       /**
00039        * \brief get the Iterator over the items
00040        *
00041        * @return an iterator over the items
00042        * @throw Throws zerr::ZAPI0039 if the implementation of the associated
00043        *        ItemSequence does not allow more than one iterator to be created. 
00044       */
00045       virtual Iterator_t  getIterator() = 0;
00046 
00047   }; /* class ItemSequence */
00048 
00049 } // namespace zorba
00050 #endif
00051 /* vim:set et sw=2 ts=2: */
blog comments powered by Disqus