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
21
22 /***
23 * MapBuilders are wrappers around DatabaseMaps. You use a MapBuilder
24 * to populate a DatabaseMap. You should implement this interface to create
25 * your own MapBuilders. The MapBuilder interface exists to support ease of
26 * casting.
27 *
28 * @author <a href="mailto:jmcnally@collab.net">John D. McNally</a>
29 * @version $Id: MapBuilder.java 473821 2006-11-11 22:37:25Z tv $
30 */
31 public interface MapBuilder
32 {
33 /***
34 * Build up the database mapping.
35 *
36 * @exception Exception Couldn't build mapping.
37 */
38 void doBuild()
39 throws Exception;
40
41 /***
42 * Tells us if the database mapping is built so that we can avoid
43 * re-building it repeatedly.
44 *
45 * @return Whether the DatabaseMap is built.
46 */
47 boolean isBuilt();
48
49 /***
50 * Gets the database mapping this map builder built.
51 *
52 * @return A DatabaseMap.
53 */
54 DatabaseMap getDatabaseMap();
55 }