item_sequence.h
Go to the documentation of this file.
1 /*
2  * Copyright 2006-2008 The FLWOR Foundation.
3  *
4  * Licensed under the Apache License, Version 2.0 (the "License");
5  * you may not use this file except in compliance with the License.
6  * You may obtain a copy of the License at
7  *
8  * http://www.apache.org/licenses/LICENSE-2.0
9  *
10  * Unless required by applicable law or agreed to in writing, software
11  * distributed under the License is distributed on an "AS IS" BASIS,
12  * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13  * See the License for the specific language governing permissions and
14  * limitations under the License.
15  */
16 #ifndef ZORBA_ITEM_SEQUENCE_API_H
17 #define ZORBA_ITEM_SEQUENCE_API_H
18 
19 #include <zorba/config.h>
20 #include <zorba/api_shared_types.h>
21 
22 namespace zorba {
23 
24  /**
25  * \brief This interface represents an instance of the XQuery 1.0 and XPath 2.0
26  * Data Model (XDM).
27  *
28  * See http://www.w3.org/TR/xpath-datamodel/.
29  */
30  class ZORBA_DLL_PUBLIC ItemSequence : virtual public SmartObject
31  {
32  public:
33  /**
34  * \brief Destructor
35  */
36  virtual ~ItemSequence() { }
37 
38  /**
39  * \brief get the Iterator over the items
40  *
41  * @return an iterator over the items
42  * @throw Throws zerr::ZAPI0039 if the implementation of the associated
43  * ItemSequence does not allow more than one iterator to be created.
44  */
45  virtual Iterator_t getIterator() = 0;
46 
47  }; /* class ItemSequence */
48 
49 } // namespace zorba
50 #endif
51 /* vim:set et sw=2 ts=2: */
blog comments powered by Disqus