Constructor Detail

• AbstractTableHandler

  public AbstractTableHandler()
  

Method Detail

• init

  public void init()
            throws DataLoadException
  

  It does nothing. The subclass can overwrite this method to do some initialization, such as creating some prepared statements to access the database.

  Specified by:

  init in interface TableHandler

  Throws:

  DataLoadException - if there are some errors.

• preProcess

  public void preProcess(ExtendedTableDataObject extendedTableDataObject)
                  throws DataLoadException
  

  It does nothing. The subclass can overwrite it to provide some addition handling.

  Specified by:

  preProcess in interface TableHandler

  Parameters:

  extendedTableDataObject - an extended table data object.

  Throws:

  DataLoadException - if there are some errors to execute the custom logic.

• close

  public void close()
  

  It does nothing. The subclass can overwrite this method to release any resources it used, such as JDBC prepared statements.

  Specified by:

  close in interface TableHandler

• createTableDataObject

  protected TableDataObject createTableDataObject(java.lang.String tableName)
  

  Creates a table data object.

  Parameters:

  tableName - a database table name.

  Returns:

  the created table data object.

• createTableDataObjectWithUniqueIndex

  protected TableDataObject createTableDataObjectWithUniqueIndex(java.lang.String tableName,
                                                     java.util.Map uniqueIndexValueMap)
                                                          throws DataLoadException
  

  It creates a table data object with the input unique index map. The generate new key flag will be true when it calls the ID resolver to resolve primary key. The unique index data and the resolved primary key data will be populated in the table data object and the operation mode for the table data object will also be populated with insert or update depending on the key is resolved in the database or a new key is generated. This method does not support the startKey and endKey specified in the data load configuration. This is, it will always use the KEYS table to generate new key if the key cannot be resolved in the database.

  Parameters:

  tableName - a database table name

  uniqueIndexValueMap - a map contains the unique index data.

  Returns:

  the created table data object.

  Throws:

  DataLoadException - if the DataLoadHelper.resolveIds() throws exception.

• createTableDataObjectWithPrimary

  protected TableDataObject createTableDataObjectWithPrimary(java.lang.String tableName,
                                                 java.util.Map primaryKeyValueMap)
                                                      throws DataLoadException
  

  Create a table data object with the primary key data.

  Parameters:

  tableName - the table name

  primaryKeyValueMap - a map contains the primary key data.

  Returns:

  the table data object.

  Throws:

  DataLoadException - this exception is thrown if there are problems to create the table data object.

• setDeleteFlag

  public void setDeleteFlag(boolean deleteFlag)
  

  Sets the delete flag. This flag will be used in the methods createTableDataObjectWithPrimary() and createTableDataObjectWithUniqueIndex() to indicate whether we need to set the operational mode to delete for the created table data object.

  Specified by:

  setDeleteFlag in interface TableHandler

  Parameters:

  deleteFlag - a boolean flag.

• isDelete

  protected boolean isDelete()
  

  Checks if the delete flag is true or not.

  Returns:

  the delete flag.