KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > xquark > mapper > mapping > MappingInfo


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.mapping;
24
25 /**
26  * Interface giving common access to user and the corresponding
27  * XQuark index tables information (including SQL main statements).
28  */
29 public interface MappingInfo
30 {
31
32
33     
34     /**
35      * Returns XQuarkindex table name.
36      * @return the native DBMS table name
37      */
38     public String JavaDoc getOIDTableName();
39
40     /**
41      * Returns the SQL statement for inserting data in the XQuarkindex table.
42      * @return a native DBMS insert SQL statement.
43      */
44     public String JavaDoc getOIDInsertStatement();
45     
46     /**
47      * Returns the SQL statement for inserting data in the user table.
48      * @return a native DBMS insert SQL statement
49      */
50     public String JavaDoc getInsertStatement();
51     /**
52      * Returns the SQL statement for updating the user table.
53      * @return a native DBMS update SQL statement
54      */
55     public String JavaDoc getUpdateStatement();
56     /**
57      * Returns the SQL statement for retrieving data in the user table.
58      * @return a native DBMS select SQL statement
59      */
60     public String JavaDoc getSelectStatement();
61     
62     /**
63      * Accessor to user table mapping information.
64      * @return a memory reprezentation of XQuark table mapping.
65      */
66     public TableMapping getTableMapping();
67     
68     /**
69      * Says if all statements can be shared among the MappingInfo set
70      * defined on the same user table.
71      * @return boolean
72      */
73     public boolean isShareable();
74
75     
76 }
77
Popular Tags