|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||
java.lang.Objectorg.apache.ibatis.ibator.api.IntrospectedTable
public abstract class IntrospectedTable
Base class for all code generator implementations. This class provides many of the ibator housekeeping methods needed to implement a code generator, with only the actual code generation methods left unimplemented.
| Field Summary | |
|---|---|
protected java.util.List<IntrospectedColumn> |
baseColumns
|
protected java.util.List<IntrospectedColumn> |
blobColumns
|
protected FullyQualifiedTable |
fullyQualifiedTable
|
protected boolean |
hasJDBCDateColumns
|
protected boolean |
hasJDBCTimeColumns
|
protected IbatorContext |
ibatorContext
|
protected java.util.List<IntrospectedColumn> |
primaryKeyColumns
|
protected IbatorRules |
rules
|
protected TableConfiguration |
tableConfiguration
|
| Constructor Summary | |
|---|---|
IntrospectedTable()
|
|
| Method Summary | |
|---|---|
void |
addColumn(IntrospectedColumn introspectedColumn)
|
void |
addPrimaryKeyColumn(java.lang.String columnName)
|
abstract void |
calculateGenerators(java.util.List<java.lang.String> warnings,
ProgressCallback progressCallback)
This method can be used to initialize the generators before they will be called. |
java.util.List<IntrospectedColumn> |
getAllColumns()
Returns all columns in the table (for use by the select by primary key and select by example with BLOBs methods) |
java.util.List<IntrospectedColumn> |
getBaseColumns()
|
FullyQualifiedJavaType |
getBaseRecordType()
|
java.util.List<IntrospectedColumn> |
getBLOBColumns()
|
IntrospectedColumn |
getColumn(java.lang.String columnName)
|
protected java.lang.String |
getDAOImplementationPackage()
|
FullyQualifiedJavaType |
getDAOImplementationType()
|
protected java.lang.String |
getDAOInterfacePackage()
|
FullyQualifiedJavaType |
getDAOInterfaceType()
|
FullyQualifiedJavaType |
getExampleType()
|
FullyQualifiedTable |
getFullyQualifiedTable()
|
abstract java.util.List<GeneratedJavaFile> |
getGeneratedJavaFiles()
This method should return a list of generated Java files related to this table. |
GeneratedKey |
getGeneratedKey()
|
abstract java.util.List<GeneratedXmlFile> |
getGeneratedXmlFiles()
This method should return a list of generated XML files related to this table. |
abstract int |
getGenerationSteps()
This method should return the number of progress messages that will be send during the generation phase. |
protected java.lang.String |
getJavaModelPackage()
|
int |
getNonBLOBColumnCount()
|
java.util.List<IntrospectedColumn> |
getNonBLOBColumns()
Returns all columns except BLOBs (for use by the select by example without BLOBs method) |
java.util.List<IntrospectedColumn> |
getNonPrimaryKeyColumns()
|
java.util.List<IntrospectedColumn> |
getPrimaryKeyColumns()
Returns the columns in the primary key. |
FullyQualifiedJavaType |
getPrimaryKeyType()
|
FullyQualifiedJavaType |
getRecordWithBLOBsType()
|
IbatorRules |
getRules()
|
java.lang.String |
getSelectByExampleQueryId()
|
java.lang.String |
getSelectByPrimaryKeyQueryId()
|
java.lang.String |
getSqlMapFileName()
Calculates an SQL Map file name for the table. |
java.lang.String |
getSqlMapPackage()
Calculates the package for the current table. |
java.lang.String |
getTableConfigurationProperty(java.lang.String property)
|
boolean |
hasAnyColumns()
|
boolean |
hasBaseColumns()
|
boolean |
hasBLOBColumns()
|
boolean |
hasJDBCDateColumns()
Returns true if any of the columns in the table are JDBC Dates (as opposed to timestamps). |
boolean |
hasJDBCTimeColumns()
Returns true if any of the columns in the table are JDBC Times (as opposed to timestamps). |
boolean |
hasPrimaryKeyColumns()
|
abstract boolean |
isJava5Targeted()
Denotes whether generated code is targeted for Java version 5.0 or higher. |
void |
setFullyQualifiedTable(FullyQualifiedTable fullyQualifiedTable)
|
void |
setIbatorContext(IbatorContext ibatorContext)
|
void |
setTableConfiguration(TableConfiguration tableConfiguration)
|
| Methods inherited from class java.lang.Object |
|---|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
| Field Detail |
|---|
protected TableConfiguration tableConfiguration
protected FullyQualifiedTable fullyQualifiedTable
protected IbatorContext ibatorContext
protected IbatorRules rules
protected java.util.List<IntrospectedColumn> primaryKeyColumns
protected java.util.List<IntrospectedColumn> baseColumns
protected java.util.List<IntrospectedColumn> blobColumns
protected boolean hasJDBCDateColumns
protected boolean hasJDBCTimeColumns
| Constructor Detail |
|---|
public IntrospectedTable()
| Method Detail |
|---|
public FullyQualifiedTable getFullyQualifiedTable()
public java.lang.String getSelectByExampleQueryId()
public java.lang.String getSelectByPrimaryKeyQueryId()
public GeneratedKey getGeneratedKey()
public IntrospectedColumn getColumn(java.lang.String columnName)
public boolean hasJDBCDateColumns()
public boolean hasJDBCTimeColumns()
public java.util.List<IntrospectedColumn> getPrimaryKeyColumns()
public boolean hasPrimaryKeyColumns()
public java.util.List<IntrospectedColumn> getBaseColumns()
public java.util.List<IntrospectedColumn> getAllColumns()
public java.util.List<IntrospectedColumn> getNonBLOBColumns()
public int getNonBLOBColumnCount()
public java.util.List<IntrospectedColumn> getNonPrimaryKeyColumns()
public java.util.List<IntrospectedColumn> getBLOBColumns()
public boolean hasBLOBColumns()
public boolean hasBaseColumns()
public IbatorRules getRules()
public java.lang.String getTableConfigurationProperty(java.lang.String property)
public FullyQualifiedJavaType getPrimaryKeyType()
public FullyQualifiedJavaType getBaseRecordType()
public FullyQualifiedJavaType getExampleType()
public FullyQualifiedJavaType getRecordWithBLOBsType()
public java.lang.String getSqlMapFileName()
public java.lang.String getSqlMapPackage()
public FullyQualifiedJavaType getDAOImplementationType()
public FullyQualifiedJavaType getDAOInterfaceType()
public boolean hasAnyColumns()
protected java.lang.String getDAOInterfacePackage()
protected java.lang.String getDAOImplementationPackage()
protected java.lang.String getJavaModelPackage()
public void setTableConfiguration(TableConfiguration tableConfiguration)
public void setFullyQualifiedTable(FullyQualifiedTable fullyQualifiedTable)
public void setIbatorContext(IbatorContext ibatorContext)
public void addColumn(IntrospectedColumn introspectedColumn)
public void addPrimaryKeyColumn(java.lang.String columnName)
public abstract void calculateGenerators(java.util.List<java.lang.String> warnings,
ProgressCallback progressCallback)
warnings - progressCallback - public abstract java.util.List<GeneratedJavaFile> getGeneratedJavaFiles()
public abstract java.util.List<GeneratedXmlFile> getGeneratedXmlFiles()
public abstract boolean isJava5Targeted()
public abstract int getGenerationSteps()
|
||||||||||
| PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
| SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD | |||||||||