|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.apache.torque.engine.database.model.Database
A class for holding application data structures.
Field Summary | |
private java.lang.String |
baseClass
|
private java.lang.String |
basePeer
|
private java.lang.String |
databaseType
|
private AppData |
dbParent
|
private java.lang.String |
defaultIdMethod
|
private java.lang.String |
defaultJavaNamingMethod
|
private java.lang.String |
defaultJavaType
|
private boolean |
heavyIndexing
|
private java.lang.String |
name
|
private java.lang.String |
pkg
|
private java.util.List |
tableList
|
private java.util.Hashtable |
tablesByJavaName
|
private java.util.Hashtable |
tablesByName
|
Constructor Summary | |
Database()
|
Method Summary | |
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()
|
AppData |
getAppData()
Get the parent of the table |
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) |
java.lang.String |
getName()
Get the name of the Database |
java.lang.String |
getPackage()
Get the value of package. |
protected java.lang.String |
getProperty(java.lang.String name)
Returns the value of the named property from this database's db.props file. |
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. |
Table[] |
getTables()
Return an array 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 |
setAppData(AppData parent)
Set the parent of the database |
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 |
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 |
Field Detail |
private java.lang.String databaseType
private java.util.List tableList
private java.lang.String name
private java.lang.String pkg
private java.lang.String baseClass
private java.lang.String basePeer
private java.lang.String defaultIdMethod
private java.lang.String defaultJavaType
private java.lang.String defaultJavaNamingMethod
private AppData dbParent
private java.util.Hashtable tablesByName
private java.util.Hashtable tablesByJavaName
private boolean heavyIndexing
Constructor Detail |
public Database()
Method Detail |
public void loadFromXML(org.xml.sax.Attributes attrib)
attrib
- the xml attributespublic java.lang.String getName()
public void setName(java.lang.String name)
name
- name of the Databasepublic java.lang.String getPackage()
public void setPackage(java.lang.String v)
v
- Value to assign to package.public java.lang.String getBaseClass()
public void setBaseClass(java.lang.String v)
v
- Value to assign to baseClass.public java.lang.String getBasePeer()
public void setBasePeer(java.lang.String v)
v
- Value to assign to basePeer.public java.lang.String getDefaultIdMethod()
public void setDefaultIdMethod(java.lang.String v)
v
- Value to assign to defaultIdMethod.public java.lang.String getDefaultJavaType()
public java.lang.String getDefaultJavaNamingMethod()
public void setDefaultJavaNamingMethod(java.lang.String v)
v
- The default naming conversion for this database to use.public boolean isHeavyIndexing()
public void setHeavyIndexing(boolean v)
v
- Value to assign to heavyIndexing.public Table[] getTables()
public Table getTable(java.lang.String name)
name
- table name
public Table getTableByJavaName(java.lang.String javaName)
javaName
- name of the java object representing the table
public Table addTable(org.xml.sax.Attributes attrib)
attrib
- the xml attributes
public void addTable(Table tbl)
tbl
- the table to addpublic void setAppData(AppData parent)
parent
- the parentpublic AppData getAppData()
protected java.lang.String getDatabaseType()
public void setDatabaseType(java.lang.String databaseType)
protected java.lang.String getProperty(java.lang.String name) throws EngineException
db.props
file.
name
- The name of the property to retrieve the value of.
EngineException
- Couldn't access properties.public boolean requiresIdTable()
IDMethod.ID_BROKER
to create ids for torque OM
objects.
IDMethod.ID_BROKER
method of generating
ids. returns false otherwise.public void doFinalInitialization() throws EngineException
EngineException
public java.lang.String toString()
|
|||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |