org.apache.torque.map
Interface MapBuilder

public interface MapBuilder

MapBuilders are wrappers around DatabaseMaps. You use a MapBuilder to populate a DatabaseMap. You should implement this interface to create your own MapBuilders. The MapBuilder interface exists to support ease of casting.

Version:

$Id: MapBuilder.java,v 1.5.6.2 2004/05/20 04:36:07 seade Exp $

Author:

John D. McNally

Method Summary

void	doBuild() Build up the database mapping.
DatabaseMap	getDatabaseMap() Gets the database mapping this map builder built.
boolean	isBuilt() Tells us if the database mapping is built so that we can avoid re-building it repeatedly.

Method Detail

doBuild

public void doBuild()
             throws java.lang.Exception

Build up the database mapping.

Throws:

java.lang.Exception - Couldn't build mapping.

isBuilt

public boolean isBuilt()

Tells us if the database mapping is built so that we can avoid re-building it repeatedly.

Returns:

Whether the DatabaseMap is built.

getDatabaseMap

public DatabaseMap getDatabaseMap()

Gets the database mapping this map builder built.

Returns:

A DatabaseMap.