KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > mapper > metadata > _Repository


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.mapper.metadata;
24
25
26 import java.util.List JavaDoc;
27
28 import org.xquark.mapper.dbms.TableInfo;
29 import org.xquark.xml.xdbc.XMLDBCException;
30 import org.xquark.xquery.metadata.resolver.MetadataAccess;
31 import org.xquark.xquery.metadata.resolver.SourceMetadata;
32
33
34 /**
35  * Read-only internal repository metadata interface.
36  * @see org.xquark.mapper.AccessManager
37   */
38 public interface _Repository extends MetadataAccess, SourceMetadata
39 {
40
41
42     
43     /**
44      * Access table information for repository tables
45      * @see org.xquark.mapper.dbms.TableSpec
46      */
47     public TableInfo getTableInfo(byte type);
48     
49     /**
50      * Return the collections names that exist in the repository.
51      *
52      * @return repository names in a string List.
53      * @throws RepositoryException application exception.
54      */
55     public List JavaDoc getCollectionList() throws XMLDBCException;
56     
57     /**
58      * Return collection metadata for an opened collection.
59      *
60      * @return null if the collection does not exist or is not opened.
61      * @throws RepositoryException application exception.
62      */
63     public _Collection getCollection(String JavaDoc name) throws XMLDBCException;
64     
65     /** Returns the dbms user name used by this object.
66      * @return the user name supplied at opening time.
67      */
68     public String JavaDoc getUserName();
69     
70     /** Returns the JDBC string used by this object.
71      * @return the JDBC string supplied at opening time.
72      */
73     public String JavaDoc getURL();
74     
75     /** Returns the logical name for this repository.
76      * @return a string.
77      */
78     public String JavaDoc getName();
79     
80     /** Returns the Repository data model version used by this object.
81      * @return a string version ID.
82      */
83     public String JavaDoc getVersion();
84     
85     /** Synchronizes metadata with database.
86      */
87     public void refresh() throws XMLDBCException;
88     
89 }
90
Popular Tags