KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > mapper > storage > RepositoryReader


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 /*
24  * RepositoryHandler.java
25  *
26  * Created on 30 mai 2001, 10:56
27  */
28
29 package org.xquark.mapper.storage;
30
31 import org.w3c.dom.Document JavaDoc;
32 import org.xml.sax.XMLReader JavaDoc;
33 import org.xquark.mapper.RepositoryException;
34
35 /** This object allows to perform reading operations on an XML collection
36  * using SAX2 and DOM2 interfaces.
37  * This interface extends the SAX2 {@link org.xml.sax.XMLReader org.xml.sax.XMLReader}.
38  * This means that you can use a RepositoryReader like any SAX2 parser <B>except that
39  * the parse method only accept {@link org.xml.sax.InputSource InputSources} with a
40  * sysstem ID</B>.
41  * This object can be used for multiple operations increasing performance since
42  * JDBC and Java resources are allocated one time.
43  */
44 public interface RepositoryReader extends XMLReader JavaDoc
45 {
46     /** Builds a DOM Level 2 document from an XML document stored in the collection
47      * basing on an empty document passed as a parameter.
48      * @param ID The name used to identify the document in the XML collection
49      * @return a DOM Level 2 document.
50      * @throws RepositoryException API exception.
51      */
52     public Document JavaDoc getDocument(String JavaDoc ID) throws RepositoryException;
53     
54     /** Release all resources. The object is no more usable.
55      * @throws RepositoryException an application exception
56      */
57     public void close() throws RepositoryException;
58     
59     /** Release handlers.
60      * @throws RepositoryException an application exception
61      */
62     public void unPlug();
63 }
64
65
Popular Tags