SORTIE Java Interface  1
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | List of all members
sortie.tools.batchoutput.FileAnalysisBackgroundProcess Class Reference

This class performs the file analysis of output files in a background thread so that it can be reported on with the progress bar or canceled. More...

Inheritance diagram for sortie.tools.batchoutput.FileAnalysisBackgroundProcess:

Public Member Functions

Integer doInBackground ()
 Background work thread for assembling chart options from a list of detailed output files. More...
 

Protected Member Functions

void done ()
 This function is called when the work in the background thread is done. More...
 

Private Member Functions

MenuElement [] mergeMenus (MenuElement[] jMenu1, MenuElement[] jMenu2)
 Merges two menus, retaining all values from both without duplicates. More...
 

Private Attributes

ProgressDialog m_oDialog
 The progress bar dialog. More...
 
int m_iErrorCode = 0
 Error code. More...
 
BatchDetailedOutput m_oBatchMaster
 Master batch class. More...
 
Object [] mp_jFiles
 Files to process. More...
 
OptionChoosingWindow m_oWindow
 The window with the next step on the wizard. More...
 

Detailed Description

This class performs the file analysis of output files in a background thread so that it can be reported on with the progress bar or canceled.

The file analysis consists of getting all of the options available for chosen output files so the user can choose charts in the next step of the wizard.

Member Function Documentation

◆ doInBackground()

Integer sortie.tools.batchoutput.FileAnalysisBackgroundProcess.doInBackground ( )

Background work thread for assembling chart options from a list of detailed output files.

This will get all of the choices and merge them union (as opposed to an intersection). The results are set back into the batch master.

◆ done()

void sortie.tools.batchoutput.FileAnalysisBackgroundProcess.done ( )
protected

This function is called when the work in the background thread is done.

We do window closing and opening here because this is guaranteed to wait until the background thread has completed.

◆ mergeMenus()

MenuElement [] sortie.tools.batchoutput.FileAnalysisBackgroundProcess.mergeMenus ( MenuElement []  jMenu1,
MenuElement []  jMenu2 
)
private

Merges two menus, retaining all values from both without duplicates.

Common sub menus are merged recursively.

Parameters
jMenu1First menu, a combination of JMenu and SortieMenuItem items
jMenu2Second menu, a combination of JMenu and SortieMenuItem items
Returns
Merged menus, a combination of JMenu and SortieMenuItem items

Member Data Documentation

◆ m_iErrorCode

int sortie.tools.batchoutput.FileAnalysisBackgroundProcess.m_iErrorCode = 0
private

Error code.

0 = no error, 1 = processing error, 2 = user canceled.

◆ m_oBatchMaster

BatchDetailedOutput sortie.tools.batchoutput.FileAnalysisBackgroundProcess.m_oBatchMaster
private

Master batch class.

◆ m_oDialog

ProgressDialog sortie.tools.batchoutput.FileAnalysisBackgroundProcess.m_oDialog
private

The progress bar dialog.

◆ m_oWindow

OptionChoosingWindow sortie.tools.batchoutput.FileAnalysisBackgroundProcess.m_oWindow
private

The window with the next step on the wizard.

Create it so we can register it as an action listener on all menu items.

◆ mp_jFiles

Object [] sortie.tools.batchoutput.FileAnalysisBackgroundProcess.mp_jFiles
private

Files to process.

Array of "File" objects.


The documentation for this class was generated from the following file: