|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectorg.mybatis.generator.api.IntrospectedTable
public abstract class IntrospectedTable
Base class for all code generator implementations. This class provides many of the housekeeping methods needed to implement a code generator, with only the actual code generation methods left unimplemented.
Nested Class Summary | |
---|---|
protected static class |
IntrospectedTable.InternalAttribute
|
static class |
IntrospectedTable.TargetRuntime
|
Field Summary | |
---|---|
protected java.util.Map<java.lang.String,java.lang.Object> |
attributes
Attributes may be used by plugins to capture table related state between the different plugin calls. |
protected java.util.List<IntrospectedColumn> |
baseColumns
|
protected java.util.List<IntrospectedColumn> |
blobColumns
|
protected Context |
context
|
protected FullyQualifiedTable |
fullyQualifiedTable
|
protected java.util.Map<IntrospectedTable.InternalAttribute,java.lang.String> |
internalAttributes
Internal attributes are used to store commonly accessed items by all code generators |
protected java.util.List<IntrospectedColumn> |
primaryKeyColumns
|
protected Rules |
rules
|
protected TableConfiguration |
tableConfiguration
|
protected IntrospectedTable.TargetRuntime |
targetRuntime
|
Constructor Summary | |
---|---|
IntrospectedTable(IntrospectedTable.TargetRuntime targetRuntime)
|
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. |
protected java.lang.String |
calculateIbatis2SqlMapFileName()
|
protected java.lang.String |
calculateIbatis2SqlMapNamespace()
|
protected java.lang.String |
calculateIbatis2SqlMapPackage()
|
protected void |
calculateJavaClientAttributes()
|
protected java.lang.String |
calculateJavaClientImplementationPackage()
|
protected java.lang.String |
calculateJavaClientInterfacePackage()
|
protected java.lang.String |
calculateJavaModelPackage()
|
protected void |
calculateModelAttributes()
|
protected java.lang.String |
calculateMyBatis3XmlMapperFileName()
|
protected java.lang.String |
calculateSqlMapAliasedFullyQualifiedRuntimeTableName()
|
protected java.lang.String |
calculateSqlMapFullyQualifiedRuntimeTableName()
|
protected void |
calculateXmlAttributes()
|
java.lang.String |
getAliasedFullyQualifiedTableNameAtRuntime()
|
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.lang.Object |
getAttribute(java.lang.String name)
|
java.lang.String |
getBaseColumnListId()
|
java.util.List<IntrospectedColumn> |
getBaseColumns()
|
java.lang.String |
getBaseRecordType()
|
java.lang.String |
getBaseResultMapId()
|
java.lang.String |
getBlobColumnListId()
|
java.util.List<IntrospectedColumn> |
getBLOBColumns()
|
IntrospectedColumn |
getColumn(java.lang.String columnName)
|
java.lang.String |
getCountByExampleStatementId()
|
java.lang.String |
getDAOImplementationType()
|
java.lang.String |
getDAOInterfaceType()
|
java.lang.String |
getDeleteByExampleStatementId()
|
java.lang.String |
getDeleteByPrimaryKeyStatementId()
|
java.lang.String |
getExampleType()
|
java.lang.String |
getExampleWhereClauseId()
|
FullyQualifiedTable |
getFullyQualifiedTable()
|
java.lang.String |
getFullyQualifiedTableNameAtRuntime()
|
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. |
java.lang.String |
getIbatis2SqlMapFileName()
Calculates an SQL Map file name for the table. |
java.lang.String |
getIbatis2SqlMapNamespace()
|
java.lang.String |
getIbatis2SqlMapPackage()
Calculates the package for the current table. |
java.lang.String |
getInsertSelectiveStatementId()
|
java.lang.String |
getInsertStatementId()
|
java.lang.String |
getMyBatis3JavaMapperType()
|
java.lang.String |
getMyBatis3SqlProviderType()
|
java.lang.String |
getMyBatis3UpdateByExampleWhereClauseId()
|
java.lang.String |
getMyBatis3XmlMapperFileName()
|
java.lang.String |
getMyBatis3XmlMapperPackage()
|
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. |
java.lang.String |
getPrimaryKeyType()
|
java.lang.String |
getRecordWithBLOBsType()
|
java.lang.String |
getResultMapWithBLOBsId()
|
Rules |
getRules()
|
java.lang.String |
getSelectByExampleQueryId()
|
java.lang.String |
getSelectByExampleStatementId()
|
java.lang.String |
getSelectByExampleWithBLOBsStatementId()
|
java.lang.String |
getSelectByPrimaryKeyQueryId()
|
java.lang.String |
getSelectByPrimaryKeyStatementId()
|
TableConfiguration |
getTableConfiguration()
|
java.lang.String |
getTableConfigurationProperty(java.lang.String property)
|
IntrospectedTable.TargetRuntime |
getTargetRuntime()
|
java.lang.String |
getUpdateByExampleSelectiveStatementId()
|
java.lang.String |
getUpdateByExampleStatementId()
|
java.lang.String |
getUpdateByExampleWithBLOBsStatementId()
|
java.lang.String |
getUpdateByPrimaryKeySelectiveStatementId()
|
java.lang.String |
getUpdateByPrimaryKeyStatementId()
|
java.lang.String |
getUpdateByPrimaryKeyWithBLOBsStatementId()
|
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()
|
void |
initialize()
|
boolean |
isConstructorBased()
|
boolean |
isImmutable()
|
abstract boolean |
isJava5Targeted()
Denotes whether generated code is targeted for Java version 5.0 or higher. |
void |
removeAttribute(java.lang.String name)
|
abstract boolean |
requiresXMLGenerator()
Should return true if an XML generator is required for this table. |
void |
setAttribute(java.lang.String name,
java.lang.Object value)
|
void |
setBaseColumnListId(java.lang.String s)
|
void |
setBaseRecordType(java.lang.String baseRecordType)
|
void |
setBaseResultMapId(java.lang.String s)
|
void |
setBlobColumnListId(java.lang.String s)
|
void |
setContext(Context context)
|
void |
setCountByExampleStatementId(java.lang.String s)
|
void |
setDAOImplementationType(java.lang.String DAOImplementationType)
|
void |
setDAOInterfaceType(java.lang.String DAOInterfaceType)
|
void |
setDeleteByExampleStatementId(java.lang.String s)
|
void |
setDeleteByPrimaryKeyStatementId(java.lang.String s)
|
void |
setExampleType(java.lang.String exampleType)
|
void |
setExampleWhereClauseId(java.lang.String s)
|
void |
setFullyQualifiedTable(FullyQualifiedTable fullyQualifiedTable)
|
void |
setIbatis2SqlMapFileName(java.lang.String sqlMapFileName)
|
void |
setIbatis2SqlMapNamespace(java.lang.String sqlMapNamespace)
|
void |
setIbatis2SqlMapPackage(java.lang.String sqlMapPackage)
|
void |
setInsertSelectiveStatementId(java.lang.String s)
|
void |
setInsertStatementId(java.lang.String s)
|
void |
setMyBatis3JavaMapperType(java.lang.String mybatis3JavaMapperType)
|
void |
setMyBatis3SqlProviderType(java.lang.String mybatis3SqlProviderType)
|
void |
setMyBatis3UpdateByExampleWhereClauseId(java.lang.String s)
|
void |
setMyBatis3XmlMapperFileName(java.lang.String mybatis3XmlMapperFileName)
|
void |
setMyBatis3XmlMapperPackage(java.lang.String mybatis3XmlMapperPackage)
|
void |
setPrimaryKeyType(java.lang.String primaryKeyType)
|
void |
setRecordWithBLOBsType(java.lang.String recordWithBLOBsType)
|
void |
setResultMapWithBLOBsId(java.lang.String s)
|
void |
setRules(Rules rules)
This method exists to give plugins the opportunity to replace the calculated rules if necessary. |
void |
setSelectByExampleStatementId(java.lang.String s)
|
void |
setSelectByExampleWithBLOBsStatementId(java.lang.String s)
|
void |
setSelectByPrimaryKeyStatementId(java.lang.String s)
|
void |
setSqlMapAliasedFullyQualifiedRuntimeTableName(java.lang.String aliasedFullyQualifiedRuntimeTableName)
|
void |
setSqlMapFullyQualifiedRuntimeTableName(java.lang.String fullyQualifiedRuntimeTableName)
|
void |
setTableConfiguration(TableConfiguration tableConfiguration)
|
void |
setUpdateByExampleSelectiveStatementId(java.lang.String s)
|
void |
setUpdateByExampleStatementId(java.lang.String s)
|
void |
setUpdateByExampleWithBLOBsStatementId(java.lang.String s)
|
void |
setUpdateByPrimaryKeySelectiveStatementId(java.lang.String s)
|
void |
setUpdateByPrimaryKeyStatementId(java.lang.String s)
|
void |
setUpdateByPrimaryKeyWithBLOBsStatementId(java.lang.String s)
|
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 Context context
protected Rules rules
protected java.util.List<IntrospectedColumn> primaryKeyColumns
protected java.util.List<IntrospectedColumn> baseColumns
protected java.util.List<IntrospectedColumn> blobColumns
protected IntrospectedTable.TargetRuntime targetRuntime
protected java.util.Map<java.lang.String,java.lang.Object> attributes
protected java.util.Map<IntrospectedTable.InternalAttribute,java.lang.String> internalAttributes
Constructor Detail |
---|
public IntrospectedTable(IntrospectedTable.TargetRuntime targetRuntime)
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 Rules getRules()
public java.lang.String getTableConfigurationProperty(java.lang.String property)
public java.lang.String getPrimaryKeyType()
public java.lang.String getBaseRecordType()
public java.lang.String getExampleType()
public java.lang.String getRecordWithBLOBsType()
public java.lang.String getIbatis2SqlMapFileName()
public java.lang.String getIbatis2SqlMapNamespace()
public java.lang.String getIbatis2SqlMapPackage()
public java.lang.String getDAOImplementationType()
public java.lang.String getDAOInterfaceType()
public boolean hasAnyColumns()
public void setTableConfiguration(TableConfiguration tableConfiguration)
public void setFullyQualifiedTable(FullyQualifiedTable fullyQualifiedTable)
public void setContext(Context context)
public void addColumn(IntrospectedColumn introspectedColumn)
public void addPrimaryKeyColumn(java.lang.String columnName)
public java.lang.Object getAttribute(java.lang.String name)
public void removeAttribute(java.lang.String name)
public void setAttribute(java.lang.String name, java.lang.Object value)
public void initialize()
protected void calculateXmlAttributes()
public void setBlobColumnListId(java.lang.String s)
public void setBaseColumnListId(java.lang.String s)
public void setExampleWhereClauseId(java.lang.String s)
public void setMyBatis3UpdateByExampleWhereClauseId(java.lang.String s)
public void setResultMapWithBLOBsId(java.lang.String s)
public void setBaseResultMapId(java.lang.String s)
public void setUpdateByPrimaryKeyWithBLOBsStatementId(java.lang.String s)
public void setUpdateByPrimaryKeySelectiveStatementId(java.lang.String s)
public void setUpdateByPrimaryKeyStatementId(java.lang.String s)
public void setUpdateByExampleWithBLOBsStatementId(java.lang.String s)
public void setUpdateByExampleSelectiveStatementId(java.lang.String s)
public void setUpdateByExampleStatementId(java.lang.String s)
public void setSelectByPrimaryKeyStatementId(java.lang.String s)
public void setSelectByExampleWithBLOBsStatementId(java.lang.String s)
public void setSelectByExampleStatementId(java.lang.String s)
public void setInsertSelectiveStatementId(java.lang.String s)
public void setInsertStatementId(java.lang.String s)
public void setDeleteByPrimaryKeyStatementId(java.lang.String s)
public void setDeleteByExampleStatementId(java.lang.String s)
public void setCountByExampleStatementId(java.lang.String s)
public java.lang.String getBlobColumnListId()
public java.lang.String getBaseColumnListId()
public java.lang.String getExampleWhereClauseId()
public java.lang.String getMyBatis3UpdateByExampleWhereClauseId()
public java.lang.String getResultMapWithBLOBsId()
public java.lang.String getBaseResultMapId()
public java.lang.String getUpdateByPrimaryKeyWithBLOBsStatementId()
public java.lang.String getUpdateByPrimaryKeySelectiveStatementId()
public java.lang.String getUpdateByPrimaryKeyStatementId()
public java.lang.String getUpdateByExampleWithBLOBsStatementId()
public java.lang.String getUpdateByExampleSelectiveStatementId()
public java.lang.String getUpdateByExampleStatementId()
public java.lang.String getSelectByPrimaryKeyStatementId()
public java.lang.String getSelectByExampleWithBLOBsStatementId()
public java.lang.String getSelectByExampleStatementId()
public java.lang.String getInsertSelectiveStatementId()
public java.lang.String getInsertStatementId()
public java.lang.String getDeleteByPrimaryKeyStatementId()
public java.lang.String getDeleteByExampleStatementId()
public java.lang.String getCountByExampleStatementId()
protected java.lang.String calculateJavaClientImplementationPackage()
protected java.lang.String calculateJavaClientInterfacePackage()
protected void calculateJavaClientAttributes()
protected java.lang.String calculateJavaModelPackage()
protected void calculateModelAttributes()
protected java.lang.String calculateIbatis2SqlMapPackage()
protected java.lang.String calculateIbatis2SqlMapFileName()
protected java.lang.String calculateMyBatis3XmlMapperFileName()
protected java.lang.String calculateIbatis2SqlMapNamespace()
protected java.lang.String calculateSqlMapFullyQualifiedRuntimeTableName()
protected java.lang.String calculateSqlMapAliasedFullyQualifiedRuntimeTableName()
public java.lang.String getFullyQualifiedTableNameAtRuntime()
public java.lang.String getAliasedFullyQualifiedTableNameAtRuntime()
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()
public void setRules(Rules rules)
rules
- public TableConfiguration getTableConfiguration()
public void setDAOImplementationType(java.lang.String DAOImplementationType)
public void setDAOInterfaceType(java.lang.String DAOInterfaceType)
public void setPrimaryKeyType(java.lang.String primaryKeyType)
public void setBaseRecordType(java.lang.String baseRecordType)
public void setRecordWithBLOBsType(java.lang.String recordWithBLOBsType)
public void setExampleType(java.lang.String exampleType)
public void setIbatis2SqlMapPackage(java.lang.String sqlMapPackage)
public void setIbatis2SqlMapFileName(java.lang.String sqlMapFileName)
public void setIbatis2SqlMapNamespace(java.lang.String sqlMapNamespace)
public void setSqlMapFullyQualifiedRuntimeTableName(java.lang.String fullyQualifiedRuntimeTableName)
public void setSqlMapAliasedFullyQualifiedRuntimeTableName(java.lang.String aliasedFullyQualifiedRuntimeTableName)
public java.lang.String getMyBatis3XmlMapperPackage()
public void setMyBatis3XmlMapperPackage(java.lang.String mybatis3XmlMapperPackage)
public java.lang.String getMyBatis3XmlMapperFileName()
public void setMyBatis3XmlMapperFileName(java.lang.String mybatis3XmlMapperFileName)
public java.lang.String getMyBatis3JavaMapperType()
public void setMyBatis3JavaMapperType(java.lang.String mybatis3JavaMapperType)
public java.lang.String getMyBatis3SqlProviderType()
public void setMyBatis3SqlProviderType(java.lang.String mybatis3SqlProviderType)
public IntrospectedTable.TargetRuntime getTargetRuntime()
public boolean isImmutable()
public boolean isConstructorBased()
public abstract boolean requiresXMLGenerator()
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | |||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |