FileCreation Class Reference

This class is a place to create File Creation & Formatting methods used by the PTools Application Package, which was designed to gather performance statistics for any type of Routine, Code Block or SQL Statement. More...

Inheritance diagram for FileCreation:

Static Public Member Functions
	CSVtabHead (metadata, delim)
	CSV Table Header.
	CSVtabRow (metadata, delim)
	CSV Table Data Row.
	DLMtabHead (metadata, delim)
	DLM Table Header.
	DLMtabRow (metadata, delim)
	DLM Table Data Row.
	HTMLtabHead (aTag, title, metadata)
	HTML Table Header.
	HTMLtabRow (metadata)
	HTML Table Row.
	TXTtabHead (metadata, delim)
	Text Table Header.
	TXTtabRow (metadata, delim)
	Text Table Data Row.
	XMLcolAuto ()
	XML Column AutoFit Width Element.
	XMLcolWidth (width)
	XML Column Width Element.
	XMLrowHeader (metadata)
	XML Header Row Element.
	XMLsheet (name)
	XML Worksheet Element.
	XMLsort (sortColList, sortOrderList)
	XML Sorting Element.
	XMLtabRow (metadata)
	XML Table Data Row Element.
	XMLtable (colCnt, rowCnt)
	XML Table Element.
_.Library.Status	condsMatch (conds, d, condValExp)
	Check Conditional Matches.
_.Library.Status	createAndOpenFile (file, timeout)
	Create & Open File.
_.Library.String	createOrderByList (orderBy, d)
	Create a valid SQL <order-by-list>
	fileBody (file, format, metadata)
	File Body.
_.Library.Status	fileFooter (file, format, footerMsg, metadata, elapseTime, rowCnt)
	File Footer.
_.Library.Status	fileHeader (file, format, title, class, method, version, metadata, bcFlag)
	File Header.
_.Library.String	getOutputFile (file, className, methodName, format, hDate, tSC)
	Get the 'outputFile'.
_.Library.Status	openFileForRead (file, timeout)
	Open File For Read.

Detailed Description

This class is a place to create File Creation & Formatting methods used by the PTools Application Package, which was designed to gather performance statistics for any type of Routine, Code Block or SQL Statement.

The following methods are written to be used within Class Definitions, and the equivalent methods within the SYS.PTools.FileCreation.INC file are written to be used within MAC Routines and are written as pure COS methods.

The file formatted that these methods support are driven by the 'format' parameter and support the following formats:

format - The output format of the Export/Reporting file This parameter has the following structure of constituent elements: format=<data-format>[:$LB(<delim>,<csv-header>,<csv-footer>)] Where the constituent elements have the following values: <data-format> - The format of the Export/Reporting file:

• P = Printable/Viewable report file (.txt file, no pagination)
• D = Comma-delimited data file (.csv file) which can be read into a spreadsheet
• X = Microsoft Excel XML markup file suitable for import into Excel (.xml file)
• H = HTML page file (.html file)
• Z = User-defined delimiter "P" formatted file (.dlm file) NOTE: The <delim> element is required or defaulted to $C(9) (TAB) Optional Elements: <delim> - User-defined delimiter [DEFAULT: $C(9) (TAB)] NOTE: This is generally used for <data-format>="Z" <csv-header> - .csv file header for <data-format>="D":
• 0 = Don't add non-standard information header to file [DEFAULT]
• 1 = Add non-standard information header to file <csv-footer> - .csv file footer for <data-format>="D":
• 0 = Don't add non-standard information footer to file [DEFAULT]
• 1 = Add non-standard information footer to file

EXAMPLES: Valid 'format' values:

• "H" // HTML file
• "D" // CSV file with No information header or footer
• "D:"_$LB(,1,1) // CSV file with information header & footer
• "Z:"_$LB("^") // User-defined delimiter file (delim="^")

This class is Super-Class, and is used as part of the EXTENDS directive for the following classes:

• SYS.PTools.SQLQuery
• SYS.PTools.Stats
  • SYS.PTools.StatsSQL
  • SYS.PTools.SQLStats