KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > xml > xdbc > XMLDocumentSet


1 /*
2  * This file belongs to the XQuark distribution.
3  * Copyright (C) 2003 Universite de Versailles Saint-Quentin.
4  *
5  * This program is free software; you can redistribute it and/or
6  * modify it under the terms of the GNU Lesser General Public
7  * License as published by the Free Software Foundation; either
8  * version 2.1 of the License, or (at your option) any later version.
9  *
10  * This program is distributed in the hope that it will be useful,
11  * but WITHOUT ANY WARRANTY; without even the implied warranty of
12  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
13  * Lesser General Public License for more details.
14  *
15  * You should have received a copy of the GNU Lesser General Public
16  * License along with this program; if not, write to the Free Software
17  * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307.
18  * You can also get it at http://www.gnu.org/licenses/lgpl.html
19  *
20  * For more information on this software, see http://www.xquark.org.
21  */
22
23 package org.xquark.xml.xdbc;
24
25 /**
26  * This interface allows the user to access query results as handles to stored
27  * XML documents. This is useful for instance to rename or delete documents,
28  * based on their contents. It is an error to try to use this interface when
29  * the query does not return complete XML documents.
30  */
31 public interface XMLDocumentSet extends XMLResultSet {
32  
33
34   
35   /**
36    * Returns the next result as an XML document and increments by 1 the cursor position.
37    * The cursor is initially positioned before the first result; the first
38    * call to the method nextDocument() makes the first result the current result.
39    * @return the next result of the result set or null if there is no more result in the result set.
40    * @throws XMLDBCException if a data source access error occurs.
41    */
42   public XMLDocument nextDocument() throws XMLDBCException;
43   
44 }
45
46
Popular Tags