KickJava   Java API By Example, From Geeks To Geeks.

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


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 for accessing table mappings attached to an XML collection
27  * or a standalone mapping file.
28  *
29  */
30 public interface MappingSet
31 {
32     /**
33      * Returns a list of objects giving access to user table mapping
34      * information.
35      * @return a specific iterator for table doubles management.
36      */
37     public MappingSetIterator getMappingSetIterator();
38     
39     /**
40      * Returns mapping information for a particular table mapping index.
41      * @param index the table mapping index. This index is arbitrary and
42      * allocated when mapping file is loaded.
43      * @return a {@link MappingInfo} object.
44      */
45     public MappingInfo getMappingStatements(int index);
46     
47     /**
48      * Returns the numbers of user table mappings in the mapping set.
49      * @return the number of {@link MappingInfo} object in this object.
50      */
51     public int getMappingStatementsCount();
52     
53     /**
54      * Returns a list of objects giving access to user table mapping
55      * information in a relational dependency (foreign keys) order.
56      * This methods allows, for example, to delete rows in the correct order.
57      * @param mostDependantFirst if true, the list will be returned in the
58      * "delete" order.
59      * @return a specific iterator for table doubles management.
60      */
61     public MappingSetIterator getSortedTableMappingSetIterator(boolean mostDependantFirst);
62
63     /**
64      * Returns a list of objects giving access to user table mapping
65      * information in a relational dependency (foreign keys) order.
66      * This methods allows, for example, to delete rows in the correct order.
67      * @param mostDependantFirst if true, the list will be returned in the
68      * "delete" order.
69      * @return a specific iterator for table doubles management.
70      */
71 // public MappingSetIterator getNameSortedTableMappingStatements();
72 }
73
74
Popular Tags