01: package org.apache.torque.map;
02:
03: /*
04: * Licensed to the Apache Software Foundation (ASF) under one
05: * or more contributor license agreements. See the NOTICE file
06: * distributed with this work for additional information
07: * regarding copyright ownership. The ASF licenses this file
08: * to you under the Apache License, Version 2.0 (the
09: * "License"); you may not use this file except in compliance
10: * with the License. You may obtain a copy of the License at
11: *
12: * http://www.apache.org/licenses/LICENSE-2.0
13: *
14: * Unless required by applicable law or agreed to in writing,
15: * software distributed under the License is distributed on an
16: * "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
17: * KIND, either express or implied. See the License for the
18: * specific language governing permissions and limitations
19: * under the License.
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: * Build up the database mapping.
34: *
35: * @exception Exception Couldn't build mapping.
36: */
37: void doBuild() throws Exception;
38:
39: /**
40: * Tells us if the database mapping is built so that we can avoid
41: * re-building it repeatedly.
42: *
43: * @return Whether the DatabaseMap is built.
44: */
45: boolean isBuilt();
46:
47: /**
48: * Gets the database mapping this map builder built.
49: *
50: * @return A DatabaseMap.
51: */
52: DatabaseMap getDatabaseMap();
53: }
|