IRISLIB database
SQLExportMgr Class Reference

Export Controller for SQL Export. More...

Inheritance diagram for SQLExportMgr:
Collaboration diagram for SQLExportMgr:

Public Member Functions

_.Library.Status CloseExport ()
 Call this at the end of the export operation.
 
_.Library.Status DeleteExportRoutine ()
 Delete the generated export routine.
 
 Export (_.Library.Boolean savertn)
 Do an export from the command line.
 
_.Library.Status ExportRows (_.Library.Integer rows, _.Library.Integer done)
 Exports the next rows rows to the export file. More...
 
_.Library.String GenDataExpr (_.Library.Integer col, _.Library.Integer colno)
 Compute and return the correct expression for column col. More...
 
_.Library.Status GenerateExportRoutine (_.Library.Integer sample)
 Generate the Export routine. More...
 
_.Library.Status GetExportSize (_.Library.Integer rows)
 Returns the number of rows in the export table in rows. More...
 
_.Library.String GetSample (_.Library.Integer rows)
 Exports the first rows rows to a sample variable.
 
_.Library.Status OpenExport ()
 Prepares the start of an export. More...
 
 Reset ()
 Reset the state of this object.
 
- Public Member Functions inherited from RegisteredObject
_.Library.Status OnAddToSaveSet (_.Library.Integer depth, _.Library.Integer insert, _.Library.Integer callcount)
 This callback method is invoked when the current object is added to the SaveSet,. More...
 
_.Library.Status OnClose ()
 This callback method is invoked by the <METHOD>Close</METHOD> method to. More...
 
_.Library.Status OnConstructClone (_.Library.RegisteredObject object, _.Library.Boolean deep, _.Library.String cloned)
 This callback method is invoked by the <METHOD>ConstructClone</METHOD> method to. More...
 
_.Library.Status OnNew ()
 This callback method is invoked by the <METHOD>New</METHOD> method to. More...
 
_.Library.Status OnValidateObject ()
 This callback method is invoked by the <METHOD>ValidateObject</METHOD> method to. More...
 
- Public Member Functions inherited from SQLExImData
 ResetExImData ()
 Reset the export/import data.
 

Public Attributes

 IsExporting
 Private flag set to True when export is underway. More...
 
- Public Attributes inherited from SQLExImData
 ClassName
 Class to use for import/export. More...
 
 ColumnNames
 Names (SQL field names) of columns. More...
 
 ColumnTypes
 Data types of columns. More...
 
 ColumnWidths
 Widths of columns for FixedWidth files. More...
 
 DateFormat
 Format for dates (passed to $ZDT). More...
 
 Delimiter
 Delimiter character or NULL for fixed width fields. More...
 
 FileName
 File (on server) to use for import or export. More...
 
 HasHeaders
 If true, file has column headers in first row. More...
 
 NoCheck
 If true, import will insert with NOCHECK. More...
 
 StringQuote
 Character used to quote strings or NULL for no quoting. More...
 
 TableName
 Table to use for import/export. More...
 

Additional Inherited Members

- Static Public Attributes inherited from RegisteredObject
 CAPTION = None
 Optional name used by the Form Wizard for a class when generating forms. More...
 
 JAVATYPE = None
 The Java type to be used when exported.
 
 PROPERTYVALIDATION = None
 This parameter controls the default validation behavior for the object. More...
 

Detailed Description

Export Controller for SQL Export.

Member Function Documentation

◆ ExportRows()

_.Library.Status ExportRows ( _.Library.Integer  rows,
_.Library.Integer  done 
)

Exports the next rows rows to the export file.

On return, rows contains the number of rows exported or 0 if the export is complete.

◆ GenDataExpr()

_.Library.String GenDataExpr ( _.Library.Integer  col,
_.Library.Integer  colno 
)

Compute and return the correct expression for column col.

colno is the number of the actual exported column (some columns may be skipped.

◆ GenerateExportRoutine()

_.Library.Status GenerateExportRoutine ( _.Library.Integer  sample)

Generate the Export routine.

If sample is 1 then generate code that writes sample data to a local variable.

◆ GetExportSize()

_.Library.Status GetExportSize ( _.Library.Integer  rows)

Returns the number of rows in the export table in rows.

Call this after generating an export routine.

◆ OpenExport()

_.Library.Status OpenExport ( )

Prepares the start of an export.

Call this after generating an export routine.

Member Data Documentation

◆ IsExporting

IsExporting

Private flag set to True when export is underway.