de.esprit.appsuite.database.xml

## Class AbstractDBOCollector<C extends ApplicationContext>

- java.lang.Object
- - de.esprit.common.util.DumpableObject
  - - de.esprit.common.log.SimpleLogSupportAdapter
    - - de.esprit.appsuite.xml.XmlDataCollector<C>
      - - de.esprit.appsuite.database.xml.AbstractDBOCollector<C>

- All Implemented Interfaces:
    DBLoadMonitor<DBRecord>, ApplicationObject<C>, SimpleLogSupport, Dumpable
  Direct Known Subclasses:
    DBODatabaseCollector, DBORecordCollector

      public abstract class AbstractDBOCollector<C extends ApplicationContext>
      extends XmlDataCollector<C>
      implements DBLoadMonitor<DBRecord>

  Collects data from XML database descriptions
  Author:
    Rainer Buesch

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `AbstractDBOCollector()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `void` | `cancel()` Cancels the load
    `void` | `doneRecord()`
    `void` | `doneTable()`
    `void` | `foundDatabase(java.lang.String dbName)`
    `void` | `foundField(java.lang.String fieldName, java.lang.String fieldType, java.lang.String value)`
    `void` | `foundRecord(java.lang.String dboName, java.lang.String dboVersion)`
    `void` | `foundTable(java.lang.String tableName, java.lang.String tablePkg)`
    `XmlTable` | `getCurrentTable()`
    `DBObject` | `getCurrRecord()`
    `XmlDatabase` | `getDatabase()`
    `boolean` | `loadedRecord(DBRecord record)` Is called each time a record was fetched from the underlying ResultSet
    `abstract void` | `printContent(java.io.PrintStream out)`
    `boolean` | `wasCancelled()` Tells whether this load has been cancelled

    - ### Methods inherited from class de.esprit.appsuite.xml.XmlDataCollector

      `getApplicationContext, getParser, getParseTracker, isStopOnError, setParser, toDumpString, toString`

    - ### Methods inherited from class de.esprit.common.log.SimpleLogSupportAdapter

      `getLogChannel, isLogDebug, isLogVerbose, logDebug, logDump, logError, logError, logFatal, logInfo, logVerbose, logWarning, setLogChannel`

    - ### Methods inherited from class de.esprit.common.util.DumpableObject

      `configureDumpHeadlineLength, configureDumpMaxElementsPrinted, copyDumpStringValues, copyToStringValues, createDumpHeader, toDumpString, toString`

    - ### Methods inherited from class java.lang.Object

      `clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait`

- - ### Constructor Detail

    - #### AbstractDBOCollector

          public AbstractDBOCollector()

  - ### Method Detail

    - #### foundDatabase

          public void foundDatabase(java.lang.String dbName)

    - #### foundTable

          public void foundTable(java.lang.String tableName,
                        java.lang.String tablePkg)

    - #### foundRecord

          public void foundRecord(java.lang.String dboName,
                         java.lang.String dboVersion)

    - #### foundField

          public void foundField(java.lang.String fieldName,
                        java.lang.String fieldType,
                        java.lang.String value)

    - #### doneRecord

          public void doneRecord()

    - #### doneTable

          public void doneTable()

    - #### getCurrRecord

          public DBObject getCurrRecord()

    - #### getCurrentTable

          public XmlTable getCurrentTable()

    - #### getDatabase

          public XmlDatabase getDatabase()

    - #### printContent

          public abstract void printContent(java.io.PrintStream out)

    - #### loadedRecord

          public boolean loadedRecord(DBRecord record)

      Description copied from interface: `DBLoadMonitor`
      Is called each time a record was fetched from the underlying ResultSet
      Specified by:
        `loadedRecord` in interface `DBLoadMonitor<DBRecord>`
      Parameters:
        `record` - The record just fetched from the ResultSet
      Returns:
        true if the record could be processed successfully

    - #### wasCancelled

          public boolean wasCancelled()

      Description copied from interface: `DBLoadMonitor`
      Tells whether this load has been cancelled
      Specified by:
        `wasCancelled` in interface `DBLoadMonitor<DBRecord>`

    - #### cancel

          public void cancel()

      Description copied from interface: `DBLoadMonitor`
      Cancels the load
      Specified by:
        `cancel` in interface `DBLoadMonitor<DBRecord>`

Copyright © 2014 EsprIT-Systems. All Rights Reserved.