KickJava   Java API By Example, From Geeks To Geeks.

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


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 import org.xquark.mapper.dbms.TableInfo;
26 import org.xquark.mapper.mapping.MappingSet;
27 import org.xquark.mapper.mapping.RepositoryMapping;
28 import org.xquark.xml.xdbc.XMLDBCException;
29
30 /**
31  * Read-only internal collection metadata interface.
32  * @see org.xquark.mapper.AccessManager
33   */
34 public interface _Collection extends MappingSet
35 {
36
37
38
39     /** Returns the string name of this colection.
40      * @return the string ID of the collection.
41      */
42     public String JavaDoc getCollectionName();
43     
44     /** Returns the numeric ID of this colection used especially for table
45      * naming.
46      * @return the numeric ID of the collection.
47      */
48     public short getCollectionID();
49
50     /** Returns the pathSet information of this collection.
51      * @return an implementation of {@link org.xquark.xml.xpath.XTree}
52      */
53     public PathSet getPathSet();
54     
55     /** Returns the mapping information for this collection.
56      * <B>May be shared with other collections.</B>
57      * @return an implementation of {@link org.xquark.xml.xpath.XTree}
58      */
59     public RepositoryMapping getMapping();
60     
61     /**
62      * Get the OID table names (customized with collection and user table ID).
63      *
64      * @param tableMappingIndex index of table mapping.
65      * @return the OID table name.
66      */
67     public String JavaDoc getOIDTableName(int tableMappingIndex) throws XMLDBCException;
68     
69     /**
70      * Access table information for colletcion tables (OID tables excluded)
71      * @see org.xquark.mapper.dbms.TableSpec
72      */
73     public TableInfo getTableInfo(byte type);
74     
75     /**
76      * Returns the object performing OID manipulations.
77      * return the UOIDManager of the collection.
78      */
79     public UOIDManager getUOIDManager();
80     
81     /**
82      * Update statistics for the collection tables using the dbms native features
83      */
84     public void updateStatistics() throws XMLDBCException;
85     
86     /** Synchronizes metadata with database.
87      */
88     public void refresh() throws XMLDBCException;
89     
90 }
91
Popular Tags