Class SQLDocument

All Implemented Interfaces:
DTM

public class SQLDocument extends DTMDocument
The SQL Document is the main controlling class the executesa SQL Query
  • Constructor Details

  • Method Details

    • getNewDocument

      public static SQLDocument getNewDocument(ExpressionContext exprContext)
      This static method simplifies the creation of an SQL Document and allows us to embedd the complexity of creating / handling the dtmIdent inside the document. This type of method may better placed inside the DTMDocument code
    • getExpressionContext

      public ExpressionContext getExpressionContext()
      Return the context used to build this document
    • execute

      public void execute(XConnection xconn, SQLQueryParser query) throws SQLException
      Throws:
      SQLException
    • skip

      public void skip(int value)
      Push the record set forward value rows. Used to help in SQL pagination.
      Parameters:
      value -
    • hasErrors

      public boolean hasErrors()
      Used by the XConnection to determine if the Document should handle the document differently.
    • close

      public void close(boolean flushConnPool)
      Close down any resources used by this document. If an SQL Error occure while the document was being accessed, the SQL Connection used to create this document will be released to the Connection Pool on error. This allows the COnnection Pool to give special attention to any connection that may be in a errored state.
    • documentRegistration

      public void documentRegistration()
      Description copied from class: DTMDefaultBase
      A dummy routine to satisify the abstract interface. If the DTM implememtation that extends the default base requires notification of registration, they can override this method.
      Specified by:
      documentRegistration in interface DTM
      Overrides:
      documentRegistration in class DTMDefaultBase
    • documentRelease

      public void documentRelease()
      Description copied from class: DTMDefaultBase
      A dummy routine to satisify the abstract interface. If the DTM implememtation that extends the default base requires notification when the document is being released, they can override this method
      Specified by:
      documentRelease in interface DTM
      Overrides:
      documentRelease in class DTMDefaultBase
    • checkWarnings

      public SQLWarning checkWarnings()