KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > access > DataPortDelegate


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