org.apache.ibatis.abator.api
Interface IntrospectedTable

All Known Implementing Classes:
IntrospectedTableImpl

public interface IntrospectedTable

Read only interface for dealing with introspected tables.

Author:
Jeff Butler

Method Summary
 java.util.Iterator getAllColumns()
          Returns all columns in the table (for use by the select by primary key and select by example with BLOBs methods)
 java.util.Iterator getBaseColumns()
           
 java.util.Iterator getBLOBColumns()
           
 ColumnDefinition getColumn(java.lang.String columnName)
           
 GeneratedKey getGeneratedKey()
           
 int getNonBLOBColumnCount()
           
 java.util.Iterator getNonBLOBColumns()
          Returns all columns axcept BLOBs (for use by the select by example without BLOBs method)
 java.util.Iterator getNonPrimaryKeyColumns()
           
 java.util.Iterator getPrimaryKeyColumns()
          Returns the columns in the primary key.
 AbatorRules getRules()
           
 java.lang.String getSelectByExampleQueryId()
           
 java.lang.String getSelectByPrimaryKeyQueryId()
           
 FullyQualifiedTable getTable()
           
 java.lang.String getTableConfigurationProperty(java.lang.String property)
           
 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()
           
 

Method Detail

getTable

public FullyQualifiedTable getTable()

getSelectByExampleQueryId

public java.lang.String getSelectByExampleQueryId()

getSelectByPrimaryKeyQueryId

public java.lang.String getSelectByPrimaryKeyQueryId()

getGeneratedKey

public GeneratedKey getGeneratedKey()

getColumn

public ColumnDefinition getColumn(java.lang.String columnName)

hasJDBCDateColumns

public boolean hasJDBCDateColumns()
Returns true if any of the columns in the table are JDBC Dates (as opposed to timestamps).

Returns:
true if the table contains DATE columns

hasJDBCTimeColumns

public boolean hasJDBCTimeColumns()
Returns true if any of the columns in the table are JDBC Times (as opposed to timestamps).

Returns:
true if the table contains TIME columns

getPrimaryKeyColumns

public java.util.Iterator getPrimaryKeyColumns()
Returns the columns in the primary key. If the generatePrimaryKeyClass() method returns false, then these columns will be iterated as the parameters of the selectByPrimaryKay and deleteByPrimaryKey methods

Returns:
an Iterator of ColumnDefinition objects for columns in the primary key

hasPrimaryKeyColumns

public boolean hasPrimaryKeyColumns()

getBaseColumns

public java.util.Iterator getBaseColumns()

getAllColumns

public java.util.Iterator getAllColumns()
Returns all columns in the table (for use by the select by primary key and select by example with BLOBs methods)

Returns:
an Iterator of ColumnDefinition objects for all columns in the table

getNonBLOBColumns

public java.util.Iterator getNonBLOBColumns()
Returns all columns axcept BLOBs (for use by the select by example without BLOBs method)

Returns:
an Iterator of ColumnDefinition objects for columns in the table that are non BLOBs

getNonBLOBColumnCount

public int getNonBLOBColumnCount()

getNonPrimaryKeyColumns

public java.util.Iterator getNonPrimaryKeyColumns()

getBLOBColumns

public java.util.Iterator getBLOBColumns()

hasBLOBColumns

public boolean hasBLOBColumns()

getRules

public AbatorRules getRules()

getTableConfigurationProperty

public java.lang.String getTableConfigurationProperty(java.lang.String property)