org.apache.torque.engine.database.model
Class Database

java.lang.Object
  extended byorg.apache.torque.engine.database.model.Database

public class Database
extends java.lang.Object

A class for holding application data structures.

Version:
$Id: Database.java 239626 2005-08-24 12:19:51Z henning $
Author:
John McNally, Daniel Rall,
Constructor Summary
Database(java.lang.String databaseType)
          Creates a new instance for the specified database type.
 
Method Summary
 void addDomain(Domain domain)
           
 Table addTable(org.xml.sax.Attributes attrib)
          An utility method to add a new table from an xml attribute.
 void addTable(Table tbl)
          Add a table to the list and sets the Database property to this Database
 void doFinalInitialization()
          Initializes the model.
 java.lang.String getBaseClass()
          Get the value of baseClass.
 java.lang.String getBasePeer()
          Get the value of basePeer.
protected  java.lang.String getDatabaseType()
           
 java.lang.String getDefaultIdMethod()
          Get the value of defaultIdMethod.
 java.lang.String getDefaultJavaNamingMethod()
          Get the value of defaultJavaNamingMethod which specifies the method for converting schema names for table and column to Java names.
 java.lang.String getDefaultJavaType()
          Get type to use in Java sources (primitive || object)
 Domain getDomain(java.lang.String domainName)
           
 java.lang.String getFileName()
           
 java.lang.String getName()
          Get the name of the Database
 java.lang.String getPackage()
          Get the value of package.
 Platform getPlatform()
          Returns the Platform implementation for this database.
 Table getTable(java.lang.String name)
          Return the table with the specified name.
 Table getTableByJavaName(java.lang.String javaName)
          Return the table with the specified javaName.
 java.util.List getTables()
          Return an List of all tables
 boolean isHeavyIndexing()
          Get the value of heavyIndexing.
 void loadFromXML(org.xml.sax.Attributes attrib)
          Load the database object from an xml tag.
 boolean requiresIdTable()
          Determines if this database will be using the IDMethod.ID_BROKER to create ids for torque OM objects.
 void setBaseClass(java.lang.String v)
          Set the value of baseClass.
 void setBasePeer(java.lang.String v)
          Set the value of basePeer.
 void setDatabaseType(java.lang.String databaseType)
           
 void setDefaultIdMethod(java.lang.String v)
          Set the value of defaultIdMethod.
 void setDefaultJavaNamingMethod(java.lang.String v)
          Set the value of defaultJavaNamingMethod.
 void setFileName(java.lang.String name)
           
 void setHeavyIndexing(boolean v)
          Set the value of heavyIndexing.
 void setName(java.lang.String name)
          Set the name of the Database
 void setPackage(java.lang.String v)
          Set the value of package.
 java.lang.String toString()
          Creats a string representation of this Database.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
 

Constructor Detail

Database

public Database(java.lang.String databaseType)
Creates a new instance for the specified database type.

Parameters:
databaseType - The default type for this database.
Method Detail

loadFromXML

public void loadFromXML(org.xml.sax.Attributes attrib)
Load the database object from an xml tag.

Parameters:
attrib - the xml attributes

getName

public java.lang.String getName()
Get the name of the Database

Returns:
name of the Database

setName

public void setName(java.lang.String name)
Set the name of the Database

Parameters:
name - name of the Database

getFileName

public java.lang.String getFileName()

setFileName

public void setFileName(java.lang.String name)

getPackage

public java.lang.String getPackage()
Get the value of package.

Returns:
value of package.

setPackage

public void setPackage(java.lang.String v)
Set the value of package.

Parameters:
v - Value to assign to package.

getBaseClass

public java.lang.String getBaseClass()
Get the value of baseClass.

Returns:
value of baseClass.

setBaseClass

public void setBaseClass(java.lang.String v)
Set the value of baseClass.

Parameters:
v - Value to assign to baseClass.

getBasePeer

public java.lang.String getBasePeer()
Get the value of basePeer.

Returns:
value of basePeer.

setBasePeer

public void setBasePeer(java.lang.String v)
Set the value of basePeer.

Parameters:
v - Value to assign to basePeer.

getDefaultIdMethod

public java.lang.String getDefaultIdMethod()
Get the value of defaultIdMethod.

Returns:
value of defaultIdMethod.

setDefaultIdMethod

public void setDefaultIdMethod(java.lang.String v)
Set the value of defaultIdMethod.

Parameters:
v - Value to assign to defaultIdMethod.

getDefaultJavaType

public java.lang.String getDefaultJavaType()
Get type to use in Java sources (primitive || object)

Returns:
the type to use

getDefaultJavaNamingMethod

public java.lang.String getDefaultJavaNamingMethod()
Get the value of defaultJavaNamingMethod which specifies the method for converting schema names for table and column to Java names.

Returns:
The default naming conversion used by this database.

setDefaultJavaNamingMethod

public void setDefaultJavaNamingMethod(java.lang.String v)
Set the value of defaultJavaNamingMethod.

Parameters:
v - The default naming conversion for this database to use.

isHeavyIndexing

public boolean isHeavyIndexing()
Get the value of heavyIndexing.

Returns:
value of heavyIndexing.

setHeavyIndexing

public void setHeavyIndexing(boolean v)
Set the value of heavyIndexing.

Parameters:
v - Value to assign to heavyIndexing.

getTables

public java.util.List getTables()
Return an List of all tables

Returns:
List of all tables

getTable

public Table getTable(java.lang.String name)
Return the table with the specified name.

Parameters:
name - table name
Returns:
A Table object. If it does not exist it returns null

getTableByJavaName

public Table getTableByJavaName(java.lang.String javaName)
Return the table with the specified javaName.

Parameters:
javaName - name of the java object representing the table
Returns:
A Table object. If it does not exist it returns null

addTable

public Table addTable(org.xml.sax.Attributes attrib)
An utility method to add a new table from an xml attribute.

Parameters:
attrib - the xml attributes
Returns:
the created Table

addTable

public void addTable(Table tbl)
Add a table to the list and sets the Database property to this Database

Parameters:
tbl - the table to add

addDomain

public void addDomain(Domain domain)

getDomain

public Domain getDomain(java.lang.String domainName)

getDatabaseType

protected java.lang.String getDatabaseType()

setDatabaseType

public void setDatabaseType(java.lang.String databaseType)

getPlatform

public Platform getPlatform()
Returns the Platform implementation for this database.

Returns:
a Platform implementation

requiresIdTable

public boolean requiresIdTable()
Determines if this database will be using the IDMethod.ID_BROKER to create ids for torque OM objects.

Returns:
true if there is at least one table in this database that uses the IDMethod.ID_BROKER method of generating ids. returns false otherwise.

doFinalInitialization

public void doFinalInitialization()
                           throws EngineException
Initializes the model.

Throws:
EngineException

toString

public java.lang.String toString()
Creats a string representation of this Database. The representation is given in xml format.

Returns:
string representation in xml


Copyright © 2000-2006 Apache Software Foundation. All Rights Reserved.