1 package org.apache.torque.map;
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19 /***
20 * MapBuilders are wrappers around DatabaseMaps. You use a MapBuilder
21 * to populate a DatabaseMap. You should implement this interface to create
22 * your own MapBuilders. The MapBuilder interface exists to support ease of
23 * casting.
24 *
25 * @author <a href="mailto:jmcnally@collab.net">John D. McNally</a>
26 * @version $Id: MapBuilder.java 239630 2005-08-24 12:25:32Z henning $
27 */
28 public interface MapBuilder
29 {
30 /***
31 * Build up the database mapping.
32 *
33 * @exception Exception Couldn't build mapping.
34 */
35 void doBuild()
36 throws Exception;
37
38 /***
39 * Tells us if the database mapping is built so that we can avoid
40 * re-building it repeatedly.
41 *
42 * @return Whether the DatabaseMap is built.
43 */
44 boolean isBuilt();
45
46 /***
47 * Gets the database mapping this map builder built.
48 *
49 * @return A DatabaseMap.
50 */
51 DatabaseMap getDatabaseMap();
52 }