Source code: org/objectstyle/cayenne/dataport/DataPortDelegate.java
1 /* ====================================================================
2 *
3 * The ObjectStyle Group Software License, Version 1.0
4 *
5 * Copyright (c) 2002-2003 The ObjectStyle Group
6 * and individual authors of the software. All rights reserved.
7 *
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 *
12 * 1. Redistributions of source code must retain the above copyright
13 * notice, this list of conditions and the following disclaimer.
14 *
15 * 2. Redistributions in binary form must reproduce the above copyright
16 * notice, this list of conditions and the following disclaimer in
17 * the documentation and/or other materials provided with the
18 * distribution.
19 *
20 * 3. The end-user documentation included with the redistribution, if
21 * any, must include the following acknowlegement:
22 * "This product includes software developed by the
23 * ObjectStyle Group (http://objectstyle.org/)."
24 * Alternately, this acknowlegement may appear in the software itself,
25 * if and wherever such third-party acknowlegements normally appear.
26 *
27 * 4. The names "ObjectStyle Group" and "Cayenne"
28 * must not be used to endorse or promote products derived
29 * from this software without prior written permission. For written
30 * permission, please contact andrus@objectstyle.org.
31 *
32 * 5. Products derived from this software may not be called "ObjectStyle"
33 * nor may "ObjectStyle" appear in their names without prior written
34 * permission of the ObjectStyle Group.
35 *
36 * THIS SOFTWARE IS PROVIDED ``AS IS'' AND ANY EXPRESSED OR IMPLIED
37 * WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
38 * OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
39 * DISCLAIMED. IN NO EVENT SHALL THE OBJECTSTYLE GROUP OR
40 * ITS CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
41 * SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT
42 * LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF
43 * USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
44 * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
45 * OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
46 * OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
47 * SUCH DAMAGE.
48 * ====================================================================
49 *
50 * This software consists of voluntary contributions made by many
51 * individuals on behalf of the ObjectStyle Group. For more
52 * information on the ObjectStyle Group, please see
53 * <http://objectstyle.org/>.
54 *
55 */
56 package org.objectstyle.cayenne.dataport;
57
58 import java.util.List;
59
60 import org.objectstyle.cayenne.map.DbEntity;
61 import org.objectstyle.cayenne.query.Query;
62
63 /**
64 * Interface for callback and delegate methods allowing implementing classes
65 * to control various aspects of data porting via DataPort. DataPort instance
66 * will invoke appropriate delegate methods during different stages of porting
67 * process.
68 *
69 * @author Andrei Adamchik
70 */
71 public interface DataPortDelegate {
72 /**
73 * Allows delegate to sort or otherwise alter a list of DbEntities
74 * right before the port starts.
75 */
76 public List willPortEntities(DataPort portTool, List entities);
77
78 /**
79 * Invoked by DataPort right before the start of data port
80 * for a given entity. Allows delegate to handle such things like
81 * logging, etc. Also makes it possible to
82 * alter the select query used to cleanup the data, e.g. set a limiting
83 * qualifier.
84 */
85 public void willPortEntity(DataPort portTool, DbEntity entity, Query query);
86
87 /**
88 * Invoked by DataPort right after the end of data port
89 * for a given entity. Allows delegate to handle such things like
90 * logging, etc.
91 */
92 public void didPortEntity(DataPort portTool, DbEntity entity, int rowCount);
93
94 /**
95 * Allows delegate to sort or otherwise alter a list of DbEntities
96 * right before data cleanup starts.
97 */
98 public List willCleanData(DataPort portTool, List entities);
99
100 /**
101 * Invoked by DataPort right before the start of data cleanup
102 * for a given entity. Allows delegate to handle such things like
103 * logging, etc. Also makes it possible to
104 * alter the delete query used to cleanup the data, e.g. set a limiting
105 * qualifier.
106 */
107 public void willCleanData(DataPort portTool, DbEntity entity, Query query);
108
109 /**
110 * Invoked by DataPort right after the end of data cleanup
111 * for a given entity. Allows delegate to handle such things like
112 * logging, etc.
113 */
114 public void didCleanData(DataPort portTool, DbEntity entity, int rowCount);
115 }