KickJava   Java API By Example, From Geeks To Geeks.

Java > Open Source Codes > org > objectstyle > cayenne > tools > AntDataPortDelegate


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.tools;
57
58 import java.util.Iterator JavaDoc;
59 import java.util.List JavaDoc;
60
61 import org.apache.oro.text.perl.Perl5Util;
62 import org.apache.tools.ant.Project;
63 import org.apache.tools.ant.Task;
64 import org.objectstyle.cayenne.access.DataPort;
65 import org.objectstyle.cayenne.access.DataPortDelegate;
66 import org.objectstyle.cayenne.map.DataMap;
67 import org.objectstyle.cayenne.map.DbEntity;
68 import org.objectstyle.cayenne.query.GenericSelectQuery;
69 import org.objectstyle.cayenne.query.Query;
70
71 /**
72  * DataPortDelegate implementation that works in the context of Ant DataPortTask task
73  * execution, performing entity filtering and logging functions.
74  *
75  * @author Andrei Adamchik
76  * @since 1.2: Prior to 1.2 DataPort classes were a part of cayenne-examples package.
77  */

78 class AntDataPortDelegate implements DataPortDelegate {
79
80     private static final Perl5Util regexUtil = new Perl5Util();
81
82     protected Task parentTask;
83     
84     protected String JavaDoc[] mapFilters;
85
86     protected long timestamp;
87     protected DbEntity lastEntity;
88
89     protected NamePatternMatcher namePatternMatcher;
90     
91     public AntDataPortDelegate(Task parentTask, String JavaDoc mapsPattern,
92             String JavaDoc includeEntitiesPattern, String JavaDoc excludeEntitiesPattern) {
93         this.parentTask = parentTask;
94
95         this.namePatternMatcher = new NamePatternMatcher(parentTask, includeEntitiesPattern, excludeEntitiesPattern);
96
97         this.mapFilters = namePatternMatcher.tokenizePattern(mapsPattern);
98     }
99
100     /**
101      * Applies preconfigured list of filters to the list, removing entities that do not
102      * pass the filter.
103      */

104     protected List JavaDoc filterEntities(List JavaDoc entities) {
105         if (entities == null || entities.isEmpty()) {
106             return entities;
107         }
108
109         if (mapFilters.length == 0) {
110             return entities;
111         }
112
113         Iterator JavaDoc it = entities.iterator();
114         while (it.hasNext()) {
115             DbEntity entity = (DbEntity) it.next();
116
117             if (!passedDataMapFilter(entity)) {
118                 it.remove();
119                 continue;
120             }
121         }
122
123         namePatternMatcher.filter(entities);
124         
125         return entities;
126     }
127
128     /**
129      * Returns true if the entity passes a set of DataMap filters or if there is no
130      * DataMap filters.
131      */

132     protected boolean passedDataMapFilter(DbEntity entity) {
133         if (mapFilters.length == 0) {
134             return true;
135         }
136
137         DataMap map = entity.getDataMap();
138         if (map == null) {
139             return true;
140         }
141
142         String JavaDoc mapName = map.getName();
143         for (int i = 0; i < mapFilters.length; i++) {
144             if (regexUtil.match(mapFilters[i], mapName)) {
145                 return true;
146             }
147         }
148
149         return false;
150     }
151
152     /**
153      * Implements the delegate method to filter the list of entities applying filtering
154      * rules encapsulated by this object.
155      */

156     public List JavaDoc willPortEntities(DataPort portTool, List JavaDoc entities) {
157         return filterEntities(entities);
158     }
159
160     /**
161      * Logs entity porting event using Ant logger.
162      */

163     public GenericSelectQuery willPortEntity(
164             DataPort portTool,
165             DbEntity entity,
166             GenericSelectQuery query) {
167         parentTask.log("Porting '" + entity.getName() + "'");
168         lastEntity = entity;
169         timestamp = System.currentTimeMillis();
170
171         return query;
172     }
173
174     public void didPortEntity(DataPort portTool, DbEntity entity, int rowCount) {
175         String JavaDoc timestampLabel = "";
176         if (lastEntity == entity) {
177             timestampLabel = " in " + (System.currentTimeMillis() - timestamp) + " ms.";
178         }
179
180         String JavaDoc label = (rowCount == 1) ? "1 row transferred" : rowCount
181                 + " rows transferred";
182         parentTask.log("Done porting "
183                 + entity.getName()
184                 + ", "
185                 + label
186                 + timestampLabel, Project.MSG_VERBOSE);
187     }
188
189     public List JavaDoc willCleanData(DataPort portTool, List JavaDoc entities) {
190         return filterEntities(entities);
191     }
192
193     public Query willCleanData(DataPort portTool, DbEntity entity, Query query) {
194         parentTask.log("Deleting " + entity.getName(), Project.MSG_VERBOSE);
195         lastEntity = entity;
196         timestamp = System.currentTimeMillis();
197         return query;
198     }
199
200     public void didCleanData(DataPort portTool, DbEntity entity, int rowCount) {
201         String JavaDoc timestampLabel = "";
202         if (lastEntity == entity) {
203             timestampLabel = " in " + (System.currentTimeMillis() - timestamp) + " ms.";
204         }
205
206         String JavaDoc label = (rowCount == 1) ? "1 row deleted" : rowCount + " rows deleted";
207         parentTask.log("Done deleting "
208                 + entity.getName()
209                 + ", "
210                 + label
211                 + timestampLabel, Project.MSG_VERBOSE);
212     }
213 }
Popular Tags