Constructor Detail

• TableObjectMediator

  public TableObjectMediator()
  

Method Detail

• init

  public void init()
            throws DataLoadException
  

  This method will perform initialization required for the table object mediator and call the super class init() method.

  Specified by:

  init in interface BusinessObjectMediator

  Overrides:

  init in class AbstractBusinessObjectMediator

  Throws:

  DataLoadException - An application exception will be thrown if there was a problem initializing the business object mediator.

  See Also:

  BusinessObjectMediator.init(), AbstractBusinessObjectMediator.init()

• close

  public void close()
             throws DataLoadException
  

  This method will perform de-initialization required for the table object mediator and call the super class close() method.

  Specified by:

  close in interface BusinessObjectMediator

  Overrides:

  close in class AbstractBusinessObjectMediator

  Throws:

  DataLoadException - An application exception will be thrown if there was a problem closing the business object mediator.

  See Also:

  BusinessObjectMediator.close(), AbstractBusinessObjectMediator.close()

• transform

  protected void transform(java.lang.Object listOfDataObjects,
               boolean deleteFlag)
                    throws DataLoadException
  

  This method will transform the data object passed in into a set of physical objects which represent table rows in the data base.

  Specified by:

  transform in class AbstractBusinessObjectMediator

  Parameters:

  listOfDataObjects - The data object which will be transformed into a set of physical objects which represent table rows in the data base. The data object should be a List containing object of type ExtendedTableDataObject.

  deleteFlag - A flag indicating whether to delete the data contained in the supplied data object.

  Throws:

  DataLoadException - An application error will be throw if there was a problem transforming the data object.

  See Also:

  AbstractBusinessObjectMediator.transform(Object, boolean), ExtendedTableDataObject

• populateTableDataObject

  protected TableDataObject populateTableDataObject(ExtendedTableDataObject extendedTableDataObject)
                                             throws DataLoadException
  

  This method will populate the table data object using the configured column and data mapping information. This method is passed the pre-populated table data object that was processed by the table object builder as well as the configured table information.

  This method will also cache previously ID resolved keys and values so that they do not have to be looked up again. This will ease the amount of configuration needed in the business object configuration file.

  This method should be overridden by a subclass if the behavior of the options below is not sufficient to determine the data needed to be set for a column in a table.

  For example, if it is desired to add additional 'valueFrom' support, or override the behavior of the 'valueFrom' options below.

  Current support for the column data mapping (valueFrom attribute):

  • InputData (Default): The value will be retrieved from the data read by the data reader.
  • Fixed: The value is a fixed value, defined with the 'value' attribute.
  • BusinessContext: The value should be resolved from the business context.
  • IDResolve: It means that the column value will be resolved by the ID resolver. In this case, the column may have an optional element to indicate how to resolve the ID. If the element is not defined for this column, the value must be resolved before and will be assigned here.

  For the 'valueFrom' support for InputData and Fixed, the values are assumed to be determined already for the table data object. This method will only resolve the values who's 'valueFrom' attribute is BusinessContext and IDResolve.

  Parameters:

  extendedTableDataObject - The pre-populated table data object that will be further populated.

  Throws:

  DataLoadException - An application exception will be thrown if there is a problem populating the table object.

  See Also:

  TableDataObject, ExtendedTableDataObject, ColumnConfigProperties, DataLoadException, TableObjectBuilder

• resolveValueFromBusinessContext

  protected java.lang.String resolveValueFromBusinessContext(java.lang.String businessContextKey)
                                                      throws DataLoadException
  

  This method will determine a value for a business context property by requesting it from the business context service. If the value cannot be resolved a null value will be returned.

  Parameters:

  businessContextKey - The business context key to retrieve a value for.

  Returns:

  String The value retrieved from the business context service.

  Throws:

  DataLoadException - An application exception will be thrown if there was a problem retrieving the business context property value from the business context service.

• isPhysicalObjectSortRequired

  protected boolean isPhysicalObjectSortRequired()
  

  Check if the list of physical objects need to be sorted before passed to the data writer. This class overrides the method in the super class and always returns true.

  Overrides:

  isPhysicalObjectSortRequired in class AbstractBusinessObjectMediator

  Returns:

  true.

• sortPhysicalObjects

  protected java.util.List sortPhysicalObjects(java.util.List aListOfPhysicalObjects)
                                        throws DataLoadException
  

  Sort the list of physical objects. It overrides the method in the super class to provide a cache for the sorted list. The cache only works if the business object builder is the TableObjectBuilder which will reuse the list of ExtendedTableDataObject. If using another business object builder, this method should be overwritten in the subclass.

  Overrides:

  sortPhysicalObjects in class AbstractBusinessObjectMediator

  Parameters:

  aListOfPhysicalObjects - A list of table data objects.

  Returns:

  List - A sorted table data object list.

  Throws:

  DataLoadException - throw this exception when there are errors sorting the list.