KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > apache > cayenne > map > EntitySorter


1 /*****************************************************************
2  * Licensed to the Apache Software Foundation (ASF) under one
3  * or more contributor license agreements. See the NOTICE file
4  * distributed with this work for additional information
5  * regarding copyright ownership. The ASF licenses this file
6  * to you under the Apache License, Version 2.0 (the
7  * "License"); you may not use this file except in compliance
8  * with the License. You may obtain a copy of the License at
9  *
10  * http://www.apache.org/licenses/LICENSE-2.0
11  *
12  * Unless required by applicable law or agreed to in writing,
13  * software distributed under the License is distributed on an
14  * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
15  * KIND, either express or implied. See the License for the
16  * specific language governing permissions and limitations
17  * under the License.
18  ****************************************************************/
19
20 package org.apache.cayenne.map;
21
22 import java.util.Collection JavaDoc;
23 import java.util.List JavaDoc;
24
25 /**
26  * Defines API for sorting of Cayenne entities based on their mutual dependencies.
27  *
28  * @since 1.1
29  * @author Andrus Adamchik
30  */
31 public interface EntitySorter {
32
33     /**
34      * Initializes a list of DataMaps used by the sorter.
35      */
36     void setDataMaps(Collection JavaDoc dataMaps);
37
38     /**
39      * Sorts a list of DbEntities.
40      */
41     void sortDbEntities(List JavaDoc dbEntities, boolean deleteOrder);
42
43     /**
44      * Sorts a list of ObjEntities.
45      */
46     void sortObjEntities(List JavaDoc objEntities, boolean deleteOrder);
47
48     /**
49      * Sorts a list of objects belonging to the ObjEntity.
50      */
51     void sortObjectsForEntity(ObjEntity entity, List JavaDoc objects, boolean deleteOrder);
52 }
53
Popular Tags