Dashboard

Class ExportData

java.lang.Object

Dashboard.ExportData

public class ExportData
extends Object

Exports data from record sets, grids, and data sets to an ASCII file that can use various field and record delimiters, as well as diffent string qualifiers.

Field Summary

Fields

Modifier and Type	Field and Description
static BBjString	ClientLocale$ Locale of the client
static BBjString	ProgDirectory$ Program directory
static BBjString	PropDirectory$ Prop directory which contains the resource bundle
static BBjThinClient	ThinClient! BBjThinClient object
static BBTranslator	Translator! Translator used to obtain translations

Constructor Summary

Constructors

Constructor and Description
ExportData()

Method Summary

Modifier and Type	Method and Description
static void	exportToClientFile(BBjRecordSet p_recordSet!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports data from a BBjRecordSet to a client file
static void	exportToClientFile(BBjVector p_colData!, BBjVector p_rowData!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports column and row (grid) data to a client file
static void	exportToClientFile(DefaultCategoryDataset p_categoryDataSet!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports data from a DefaultCategoryDataset to a client file
static void	exportToClientFile(DefaultPieDataset p_pieDataSet!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports data from a DefaultPieDataset to a client file
static void	exportToClientFile(XYSeriesCollection p_xySeriesCollection!, BBjString p_clientFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports data from a XYSeriesCollection to a client file
static void	exportToServerFile(BBjRecordSet p_recordSet!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports data from a BBjRecordSet to a server file
static void	exportToServerFile(BBjVector p_colData!, BBjVector p_rowData!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports column and row (grid) data to a server file
static void	exportToServerFile(DefaultCategoryDataset p_categoryDataSet!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports data from a DefaultCategoryDataset to a server file
static void	exportToServerFile(DefaultPieDataset p_pieDataSet!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports data from a DefaultPieDataset to a server file
static void	exportToServerFile(XYSeriesCollection p_seriesCollection!, BBjString p_serverFile$, BBjString p_fieldDelimiter$, BBjString p_recordDelimiter$, BBjString p_textQualifier$) Exports data from a XYSeriesCollection to a server file
static BBjString	getClientSlash() Returns the last record delimiter used
static BBjString	getLastExportDir() Returns the last export directory used
static BBjString	getLastFieldDelimiter() Returns the last field delimiter used
static BBjString	getLastRecordDelimiter() Returns the last record delimiter used
static BBjNumber	getLastSaveAsDefault() Returns the last save as default value
static BBjString	getLastTextQualifier() Returns the last text qualifier used
static BBjString	getTranslation(BBjString p_translationKey$) Returns a translation value, given a translation key
static void	openExportFile(BBjString p_exportFile$) Opens the passed export file.
static void	setLastExportDir(BBjString p_lastExportDir$) Sets the last export directory used.
static void	setLastFieldDelimiter(BBjString p_lastFieldDelimiter$) Sets the last field delimiter used.
static void	setLastRecordDelimiter(BBjString p_lastRecordDelimiter$) Sets the last record delimiter used.
static void	setLastSaveAsDefault(BBjNumber p_lastSaveAsDefault) Sets the last save as default used.
static void	setLastTextQualifier(BBjString p_lastTextQualifier$) Sets the last text qualifier used.
static void	writeToClientFile(BBjString p_clientFile$, BBjString p_exportString$) Creates a client export file and set it's contents to the passed string
static void	writeToServerFile(BBjString p_serverFile$, BBjString p_exportString$) Creates a server export file and set it's contents to the passed string

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ThinClient!

public static BBjThinClient ThinClient!

BBjThinClient object

ClientLocale$

public static BBjString ClientLocale$

Locale of the client

ProgDirectory$

public static BBjString ProgDirectory$

Program directory

PropDirectory$

public static BBjString PropDirectory$

Prop directory which contains the resource bundle

Translator!

public static BBTranslator Translator!

Translator used to obtain translations

Constructor Detail

ExportData

public ExportData()

Method Detail

exportToServerFile

public static void exportToServerFile(BBjVector p_colData!,
BBjVector p_rowData!,
BBjString p_serverFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports column and row (grid) data to a server file

Parameters:

p_colData! - BBjVector which contains column header data

p_rowData! - BBjVector which contains the row data

p_serverFile$ - Name of the server file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

exportToServerFile

public static void exportToServerFile(BBjRecordSet p_recordSet!,
BBjString p_serverFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports data from a BBjRecordSet to a server file

Parameters:

p_recordSet! - BBjRecordSet which contains the data

p_serverFile$ - Name of the server file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

exportToServerFile

public static void exportToServerFile(DefaultPieDataset p_pieDataSet!,
BBjString p_serverFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports data from a DefaultPieDataset to a server file

Parameters:

p_pieDataSet! - DefaultPieDataset which contains the data

p_serverFile$ - Name of the server file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

exportToServerFile

public static void exportToServerFile(DefaultCategoryDataset p_categoryDataSet!,
BBjString p_serverFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports data from a DefaultCategoryDataset to a server file

Parameters:

p_categoryDataSet! - DefaultCategoryDataset which contains the data

p_serverFile$ - Name of the server file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

exportToServerFile

public static void exportToServerFile(XYSeriesCollection p_seriesCollection!,
BBjString p_serverFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports data from a XYSeriesCollection to a server file

Parameters:

p_categoryDataSet! - XYSeriesCollection which contains the data

p_serverFile$ - Name of the server file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

exportToClientFile

public static void exportToClientFile(BBjVector p_colData!,
BBjVector p_rowData!,
BBjString p_clientFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports column and row (grid) data to a client file

Parameters:

p_colData! - BBjVector which contains column header data

p_rowData! - BBjVector which contains the row data

p_clientFile$ - Name of the client file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

exportToClientFile

public static void exportToClientFile(BBjRecordSet p_recordSet!,
BBjString p_clientFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports data from a BBjRecordSet to a client file

Parameters:

p_recordSet! - BBjRecordSet which contains the data

p_clientFile$ - Name of the client file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

exportToClientFile

public static void exportToClientFile(DefaultPieDataset p_pieDataSet!,
BBjString p_clientFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports data from a DefaultPieDataset to a client file

Parameters:

p_pieDataSet! - DefaultPieDataset which contains the data

p_clientFile$ - Name of the client file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

exportToClientFile

public static void exportToClientFile(DefaultCategoryDataset p_categoryDataSet!,
BBjString p_clientFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports data from a DefaultCategoryDataset to a client file

Parameters:

p_categoryDataSet! - DefaultCategoryDataset which contains the data

p_clientFile$ - Name of the client file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

exportToClientFile

public static void exportToClientFile(XYSeriesCollection p_xySeriesCollection!,
BBjString p_clientFile$,
BBjString p_fieldDelimiter$,
BBjString p_recordDelimiter$,
BBjString p_textQualifier$)

Exports data from a XYSeriesCollection to a client file

Parameters:

p_xySeriesCollection! - XYSeriesCollection which contains the data

p_clientFile$ - Name of the client file to export to

p_fieldDelimiter$ - Delimtier to use to separate fields in the export file. Typical field delimiters inlcude: comma, space, semicolon, or tab

p_recordDelimiter$ - Delimiter to use to separate records in the export file. Typical record delimiters inlcude: CRLF, CR, LF

p_textQualifier$ - Character to use to qualify a text (string) field.

writeToServerFile

public static void writeToServerFile(BBjString p_serverFile$,
BBjString p_exportString$)

Creates a server export file and set it's contents to the passed string

Parameters:

p_serverFile$ - Server file to create (overwrite)

p_exportString$ - Formatted export string to write to the server file

writeToClientFile

public static void writeToClientFile(BBjString p_clientFile$,
BBjString p_exportString$)

Creates a client export file and set it's contents to the passed string

Parameters:

p_clientFile$ - Client file to create (overwrite)

p_exportString$ - Formatted export string to write to the client file

getClientSlash

public static BBjString getClientSlash()

Returns the last record delimiter used

Returns:

Returns the last record delimitier used. The default is a CRLF on Windows, CR on Mac, otherwise LF.

getTranslation

public static BBjString getTranslation(BBjString p_translationKey$)

Returns a translation value, given a translation key

Parameters:

p_translationKey$ - Translation key to get the associated value for

Returns:

Returns the translation for the provided key

getLastExportDir

public static BBjString getLastExportDir()

Returns the last export directory used

Returns:

Returns the last export directory used or the client temp directory. In BUI this will return an empty string.

getLastFieldDelimiter

public static BBjString getLastFieldDelimiter()

Returns the last field delimiter used

Returns:

Returns the last field delimiter used. The default is a comma.

getLastRecordDelimiter

public static BBjString getLastRecordDelimiter()

Returns the last record delimiter used

Returns:

Returns the last record delimitier used. The default is a CRLF on Windows, CR on Mac, otherwise LF.

getLastTextQualifier

public static BBjString getLastTextQualifier()

Returns the last text qualifier used

Returns:

Returns the last text qaulifier used. The default is a double quote.

getLastSaveAsDefault

public static BBjNumber getLastSaveAsDefault()

Returns the last save as default value

Returns:

Returns the last save as default value. The default is a 1 (TRUE).

setLastExportDir

public static void setLastExportDir(BBjString p_lastExportDir$)

Sets the last export directory used. In BUI, this is a NOOP.

Parameters:

p_lastExportDir$ - Specifies the last export diretory

setLastFieldDelimiter

public static void setLastFieldDelimiter(BBjString p_lastFieldDelimiter$)

Sets the last field delimiter used.

Parameters:

p_lastFieldDelimiter$ - Specifies the last field delimiter

setLastRecordDelimiter

public static void setLastRecordDelimiter(BBjString p_lastRecordDelimiter$)

Sets the last record delimiter used.

Parameters:

p_lastRecordDelimiter$ - Specifies the last record delimiter

setLastTextQualifier

public static void setLastTextQualifier(BBjString p_lastTextQualifier$)

Sets the last text qualifier used.

Parameters:

p_lastTextQualifier$ - Specifies the last text qualifier

setLastSaveAsDefault

public static void setLastSaveAsDefault(BBjNumber p_lastSaveAsDefault)

Sets the last save as default used.

Parameters:

p_lastSaveAsDefault - Specify 1 to save as default, otherwise 0

openExportFile

public static void openExportFile(BBjString p_exportFile$)

Opens the passed export file. This is a NOOP in BUI.

Parameters:

p_exportFile$ - Specifies the export file to open