Class MJAutil

java.lang.Object
  |
  +--MJAbase
        |
        +--MJAutil

public class MJAutil

extends MJAbase

MAExplorer Open Java API class to access MJAutil methods and data structures. This class contains common utility functions used by the rest of MAExplorer. These include, several string-numeric converters, access to the three message lines in the top page as well as special string array parsing, font string name to int size, ratio color setting, zoom toggle mapping, etc.

List of methods available to Plugin-writers

 maeRepaint() - repaint MAExplorer main window.
 showMsg() - display string in text field 1 in main window.
 showMsg1() - display string in text field 1 in main window.  
 showMsg2() - display string in text field 2 in main window. 
 showMsg3() - display string in text field 3 in main window. 
 logDRYROTerr() - notify MAExplorer of a fatal dryrot message
 popupAlertMsgLine() - popup alert message window. 
 popupAlertMsg() - popup alert message in a scrollable text area.
 popupDryrotMsgsAndQuit() - test if fatal dryrot messages, do Dryrot exit
 displayURL() - popup web browser on current URL.
 popupViewer() - popup web browser on current URL.
 displayPDF() - popup adobe Acrobat for PDF file.
 checkImagesDirExists() - return true if images directory exists.
 createMontageTableOfCurGene() - create montage table of current gene.
 cvtBackslash2Fwdslash() - convert '\\' to '/' in the string
 addQuotesIfSpace() - add "..." around string if it contains a space
 cvf2s() - convert float to string with precision  # of digits
 cvd2s() - convert double to string with precision  # of digits
 cvs2d() - convert String to double
 cvs2f() - convert String to float
 cvs2d() - convert String to double
 cvs2f() - convert String to float
 cvs2i() - convert String to int
 cvs2iArray() - convert String arg list "1,4,3,6,..."  to int[]
 cvs2Array() - convert String arg list "1,4,3,6,..."  to String[]
 cvtValueToStars() - cvt val in[0:valMax] to "****"+"   " string
 getRatioStr() - get "F1/F2", "Cy3/Cy5" or "Cy5/Cy3", etc. string.
 createMontageTableOfGene() - create montage sample table of gene data 
 sleepMsec() - sleep nMsec where nMsec must be >= 0 milliseconds.
 rmvRtnChars() - return String with '\r' characters remove and map \r\n to \n.
 cvtSpacesToUnderscores() - replace spaces and other illegal file name chars
 copyFile() - binary copy of one file or URL toa local file
 deleteLocalFile() - delete local file.
 cvtEnvPaths2Properties() - get all system ENV variables as separate Java properties
 getListOfMenuStubNames() - get list of menu stub names

This work was produced by Peter Lemkin of the National Cancer Institute, an agency of the United States Government. As a work of the United States Government there is no associated copyright. It is offered as open source software under the Mozilla Public License (version 1.1) subject to the limitations noted in the accompanying LEGAL file. This notice must be included with the code. The MAExplorer Mozilla and Legal files are available on http://maexplorer.sourceforge.net/.

Version:

$Date: 2003/05/28 14:01:55 $ $Revision: 1.17 $

Author:

P.Lemkin (NCI), J. Evans (CIT), C.Santos(CIT), G. Thornwall (SAIC), NCI-Frederick, Frederick, MD

See Also:

MAExplorer Home

Fields inherited from class MJAbase

COMPARE_ALL, COMPARE_ANY, COMPARE_AT_LEAST, COMPARE_AT_MOST, COMPARE_PRODUCT, COMPARE_SUM, DATA_F1TOT, DATA_F2TOT, DATA_MEAN_F1F2TOT, DATA_RATIO_F1F2TOT, DRAW_BIN, DRAW_BOX, DRAW_CIRCLE, DRAW_PLUS, EDIT_ADD, EDIT_NOP, EDIT_RMV, GENE_ATCC_ID, GENE_BAD_DATA, GENE_BAD_LOCAL_SPOT_BKGRD, GENE_BAD_MID, GENE_BAD_SPOT, GENE_BAD_SPOT_GEOMETRY, GENE_DUP_SPOT, GENE_GOOD_MID, GENE_IMAGE_ID, GENE_IS_CUR_GENE, GENE_IS_EGL_GENE, GENE_IS_FILTERED, GENE_IS_KMEANS, GENE_IS_NOT_FILTERED, GENE_LOW_SPOT_REF_SIGNAL, GENE_MARGINAL_SPOT, GENE_USE_GBID_FOR_CLONEID, HIER_CLUST_NEXT_MIN_LNKG, HIER_CLUST_PGMA_LNKG, HIER_CLUST_PGMC_LNKG, MARKER_CIRCLE, MARKER_CURRENT, MARKER_GENES, MARKER_KMEANS_CLUSTER, MARKER_NONE, MARKER_PLUS, MARKER_SQUARE, MASTER_CLONE_ID, MASTER_DBEST3, MASTER_DBEST5, MASTER_GENBANK, MASTER_GENBANK3, MASTER_GENBANK5, MASTER_GENE_NAME, MASTER_GENERIC_ID, MASTER_LOCUSLINK, MASTER_SWISS_PROT, MASTER_UG_ID, MASTER_UG_NAME, MAX_COLORS, PLOT_CLUSTER_GENES, PLOT_CLUSTER_HIER, PLOT_CLUSTER_HYBSAMPLES, PLOT_CLUSTERGRAM, PLOT_EXPR_PROFILE, PLOT_F1_F2_INTENS, PLOT_F1_F2_MVSA, PLOT_HIST_F1F2_RATIO, PLOT_HIST_HP_XY_RATIO, PLOT_HIST_HP_XY_SETS_RATIO, PLOT_HP_XY_INTENS, PLOT_INTENS_HIST, PLOT_KMEANS_CLUSTERGRAM, PLOT_PSEUDO_F1F2_IMG, PLOT_PSEUDO_F1F2_RYG_IMG, PLOT_PSEUDO_HP_XY_IMG, PLOT_PSEUDO_HP_XY_RYG_IMG, PLOT_PSEUDOIMG, PRPROP_CUR_GENE, PRPROP_FILTER, PRPROP_LABEL, PRPROP_SLIDER, PRPROP_TIMEOUT, PRPROP_UNIQUE, QUALTYPE_ALPHA, QUALTYPE_PROP_CODE, QUALTYPE_THR, RANGE_INSIDE, RANGE_OUTSIDE, RPT_FMT_DYN, RPT_FMT_TAB_DELIM, RPT_NONE, RPT_TBL_ALL_GENES_CLUSTER, RPT_TBL_CALIB_DNA_STAT, RPT_TBL_CUR_GENE_CLUSTER, RPT_TBL_EDITED_GENE_LIST, RPT_TBL_EXPR_PROFILE, RPT_TBL_FILTERED_GENES, RPT_TBL_GENE_CLASS, RPT_TBL_HIER_CLUSTER, RPT_TBL_HIGH_F1F2, RPT_TBL_HIGH_RATIO, RPT_TBL_HP_DB_INFO, RPT_TBL_HP_HP_CORR, RPT_TBL_HP_MN_VAR_STAT, RPT_TBL_HP_XY_SET_STAT, RPT_TBL_KMEANS_CLUSTER, RPT_TBL_LOW_F1F2, RPT_TBL_LOW_RATIO, RPT_TBL_MAE_PRJ_DB, RPT_TBL_MN_KMEANS_CLUSTER, RPT_TBL_NAMED_GENES, RPT_TBL_NORMALIZATION_GENE_LIST, RPT_TBL_OCL_STAT, RPT_TBL_SAMPLES_DB_INFO, RPT_TBL_SAMPLES_WEB_LINKS, SS_MODE_ELIST, SS_MODE_MS, SS_MODE_XANDY_SETS, SS_MODE_XORY_SETS, SS_MODE_XSET, SS_MODE_XY, SS_MODE_YSET

Method Summary

boolean	checkImagesDirExists() checkImagesDirExists() - return true if images directory exists.<
boolean	copyFile(java.lang.String srcName, java.lang.String dstName, java.lang.String optUpdateMsg, int optEstInputFileLth) copyFile() - binary copy of one file or URL toa local file
static SimpleTable	createMontageTableOfCurGene(boolean addImgPath) createMontageTableOfCurGene() - create montage table of current gene.
static SimpleTable	createMontageTableOfGene(int gid, boolean addFullImagePathFlag) createMontageTableOfGene() - create montage table of gene data across the HP-E sample conditions.
java.lang.String	cvd2s(double v, int precision) cvd2s() - convert double to string with precision # of digits
java.lang.String	cvf2s(float v, int precision) cvf2s() - convert float to string with precision # of digits
static java.lang.String	cvFileNameWithMod(java.lang.String fileName, java.lang.String mod) cvFileNameWithMod() - insert modifier string before file extension
java.lang.String[]	cvs2Array(java.lang.String str, int maxExpected, java.lang.String delimChr) cvs2Array() - convert String arg list "1,4,3,6,..." to String[] If there are more than maxExpected number of args in string, ignore them and just return what has been parsed so far.
double	cvs2d(java.lang.String str) cvs2d() - convert String to double
double	cvs2d(java.lang.String str, double defaultValue) cvs2d() - convert String to double
float	cvs2f(java.lang.String str) cvs2f() - convert String to float
float	cvs2f(java.lang.String str, float defaultValue) cvs2f() - convert String to float
int	cvs2i(java.lang.String str) cvs2i() - convert String to int
int	cvs2i(java.lang.String str, int defaultValue) cvs2i() - convert String to int
int[]	cvs2iArray(java.lang.String str, int maxExpected, java.lang.String delimChr) cvs2iArray() - convert String arg list "1,4,3,6,..." to int[] If there are more than maxExpected number of args in string, ignore them and just return what has been parsed so far.
java.lang.String	cvtBackslash2Fwdslash(java.lang.String sInput) cvtBackslash2Fwdslash() - convert '\\' to '/' in the string
static boolean	cvtEnvPaths2Properties() cvtEnvPaths2Properties() - get all system ENV variables and set them as separate Java properties so we can get them individually from System.getProperty(var) calls.
java.lang.String	cvtSpacesToUnderscores(java.lang.String str) cvtSpacesToUnderscores() - replace spaces and other illegal file name characters with '_' chars to make file names highly portable.
java.lang.String	cvtValueToStars(float val, float valMax, int maxStars, boolean rightFillFlag) cvtValueToStars() - cvt val in[0:valMax] to "****"+" " string where the maximum # of stars for v==vMax is specified.
boolean	deleteLocalFile(java.lang.String fileName) deleteLocalFile() - delete local file.
void	displayPDF(java.lang.String pdfFile) displayPDF() - popup Adobe Acrobat for PDF file.
void	displayURL(java.lang.String urlStr) displayURL() - popup web browser on current URL.
int	et_defaultInt() get_defaultInt() - default int value for conversions
float	get_defaultFloat() get_defaultFloat() - default float value for conversions
static java.lang.String[]	getListOfMenuStubNames() getListOfMenuStubNames() - get list of menu stub names
java.lang.String	getRatioStr() getRatioStr() - get "F1/F2", "Cy3/Cy5" or "Cy5/Cy3", etc.
void	logDRYROTerr(java.lang.String value) logDRYROTerr() - notify MAExplorer of a fatal dryrot message
void	maeRepaint() maeRepaint() - repaint MAExplorer main window.
void	popupAlertMsg(java.lang.String title, java.lang.String msg, int nRows, int nCols) popupAlertMsg() - popup alert message in a scrollable text area.
void	popupAlertMsgLine(java.lang.String msg) popupAlertMsgLine() - popup alert message line window.
void	popupDryrotMsgsAAndQuit() popupDryrotMsgsAndQuit() - test if fatal dryrot messages, then generate Dryrot exit sequence.
void	popupViewer(java.net.URL urlBase, java.lang.String fileIn, java.lang.String windowName) popupViewer() - popup web browser on current URL.
java.lang.String	rmvRtnChars(java.lang.String str) rmvRtnChars() - remove return chars.
void	saveCmdHistory(java.lang.String msg) saveCmdHistory() - print msg to showMsg1() and also save in command history and message logs if logging is enabled.
static void	saveCmdHistory(java.lang.String msg, boolean doShowMsgFlag) saveCmdHistory() - save msg in command history and message logs if logging is enabled.
void	saveMsgHistory(java.lang.String msg, boolean flag) saveMsgHistory() - save msg in message logs if logging is enabled.
void	showMsg(java.lang.String str) showMsg() - display string in text field 1 in main window.
void	showMsg1(java.lang.String str) showMsg1() - display string in text field 1 in main window.
void	showMsg1(java.lang.String str, java.awt.Color foregrdColor, java.awt.Color bkgrdColor) showMsg1() - display string in text field 1 in main window.
void	showMsg2(java.lang.String str) showMsg2() - display string in text field 2 in main window.
void	showMsg2(java.lang.String str, java.awt.Color foregrdColor, java.awt.Color bkgrdColor) showMsg2() - display string in text field 2 in main window.
void	showMsg3(java.lang.String str) showMsg3() - display string in text field 3 in main window.
void	showMsg3(java.lang.String str, java.awt.Color foregrdColor, java.awt.Color bkgrdColor) showMsg3() - display string in text field 3 in main window.
void	sleepMsec(int sleepMsec) sleepMsec() - sleep nMsec where nMsec must be >= 0 milliseconds.

Methods inherited from class MJAbase

cvtHashtable2SimpleTable, cvtTable2Hashtable

Methods inherited from class java.lang.Object

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

Method Detail

et_defaultInt

public final int et_defaultInt()

get_defaultInt() - default int value for conversions

get_defaultFloat

public final float get_defaultFloat()

get_defaultFloat() - default float value for conversions

maeRepaint

public final void maeRepaint()

maeRepaint() - repaint MAExplorer main window.

saveCmdHistory

public final void saveCmdHistory(java.lang.String msg)

saveCmdHistory() - print msg to showMsg1() and also save in command history and message logs if logging is enabled.

Parameters:

msg - string to display

saveCmdHistory

public static final void saveCmdHistory(java.lang.String msg,
                                        boolean doShowMsgFlag)

saveCmdHistory() - save msg in command history and message logs if logging is enabled.

Parameters:

msg - is the command message to log

doShowMsgFlag - if set is set, then print msg to showMsg1() as well.

saveMsgHistory

public final void saveMsgHistory(java.lang.String msg,
                                 boolean flag)

saveMsgHistory() - save msg in message logs if logging is enabled. If doShowMsgFlag is set, then print msg to showMsg1().

Parameters:

isVisibleFlag - makes the message logging window visible.

msg - string to display

showMsg

public final void showMsg(java.lang.String str)

showMsg() - display string in text field 1 in main window.

Parameters:

str - string to display

showMsg1

public final void showMsg1(java.lang.String str)

showMsg1() - display string in text field 1 in main window.

Parameters:

str - string to display

showMsg2

public final void showMsg2(java.lang.String str)

showMsg2() - display string in text field 2 in main window.

Parameters:

str - string to display

showMsg3

public final void showMsg3(java.lang.String str)

showMsg3() - display string in text field 3 in main window.

Parameters:

str - string to display

showMsg1

public final void showMsg1(java.lang.String str,
                           java.awt.Color foregrdColor,
                           java.awt.Color bkgrdColor)

showMsg1() - display string in text field 1 in main window.

Parameters:

str - string to display

foregrdColor - foreground color if not null else black

bkgrdColor - background color if not null else white

showMsg2

public final void showMsg2(java.lang.String str,
                           java.awt.Color foregrdColor,
                           java.awt.Color bkgrdColor)

showMsg2() - display string in text field 2 in main window.

Parameters:

str - string to display

foregrdColor - foreground color if not null else black

bkgrdColor - background color if not null else white

showMsg3

public final void showMsg3(java.lang.String str,
                           java.awt.Color foregrdColor,
                           java.awt.Color bkgrdColor)

showMsg3() - display string in text field 3 in main window.

Parameters:

str - string to display

foregrdColor - foreground color if not null else black

bkgrdColor - background color if not null else white

logDRYROTerr

public final void logDRYROTerr(java.lang.String value)

logDRYROTerr() - notify MAExplorer of a fatal dryrot message

Parameters:

errMsg - error message for dryrot

popupAlertMsgLine

public final void popupAlertMsgLine(java.lang.String msg)

popupAlertMsgLine() - popup alert message line window. Press close to continue.

Parameters:

msg - message to put into popup

popupAlertMsg

public void popupAlertMsg(java.lang.String title,
                          java.lang.String msg,
                          int nRows,
                          int nCols)

popupAlertMsg() - popup alert message in a scrollable text area. Press close to continue. If the auto popdown is set (Edit menu | Preferences submenut) then popdown the window after a timeout else it requires manually pressing the Close button.

Parameters:

title - is the optional title for the popup window

msg - is the message for the popup window

nRows - is the # of rows for the popup window, 20 if specify 0

nCols - is the # of columns for the popup window, 80 if specify 0

See Also:

ShowStringPopup, ShowStringPopup#updateText, sleepMsec(int)

rmvRtnChars

public java.lang.String rmvRtnChars(java.lang.String str)

rmvRtnChars() - remove return chars. Map '\r' or "\r\n" to '\n' chars.

Parameters:

String - str to process

Returns:

String with '\r' removed.

popupDryrotMsgsAAndQuit

public final void popupDryrotMsgsAAndQuit()

popupDryrotMsgsAndQuit() - test if fatal dryrot messages, then generate Dryrot exit sequence.

displayURL

public final void displayURL(java.lang.String urlStr)

displayURL() - popup web browser on current URL.

Parameters:

urlStr - to use when popup a Web brower.

popupViewer

public final void popupViewer(java.net.URL urlBase,
                              java.lang.String fileIn,
                              java.lang.String windowName)

popupViewer() - popup web browser on current URL.

Parameters:

urlBase - is the base URL

fileIn - is the file to display

windowName - is the window to use if not null

displayPDF

public final void displayPDF(java.lang.String pdfFile)

displayPDF() - popup Adobe Acrobat for PDF file.

Parameters:

pdfFile - pdf file name

checkImagesDirExists

public final boolean checkImagesDirExists()

checkImagesDirExists() - return true if images directory exists.<

Returns:

true if MAE maeDir/Images/ subdirectory exists.

createMontageTableOfCurGene

public static final SimpleTable createMontageTableOfCurGene(boolean addImgPath)

createMontageTableOfCurGene() - create montage table of current gene.

 Verify that the data exists before process:
    1) has gene to make montage on
    2) make sure have .quant (X,Y) data
    3) has Database_ID data corresponding to xxxx in images
    4) has maeDir/Images/xxxx.jpg.
 

Parameters:

addFullImagePathFlag - causes the full image path to be generated in the table.

Returns:

If succeed then return the table else if fail then return Table with tRows= -1 and the error string in the SimpleTable tMsg field.

cvtBackslash2Fwdslash

public final java.lang.String cvtBackslash2Fwdslash(java.lang.String sInput)

cvtBackslash2Fwdslash() - convert '\\' to '/' in the string

Parameters:

sInput - is input string

return - converted string

cvf2s

public final java.lang.String cvf2s(float v,
                                    int precision)

cvf2s() - convert float to string with precision # of digits

Parameters:

v - is value to cvt. If abs(v) < pow(10.0,-p) then return "+0" or "-0"

precision - of conversion. If precision > 0 then limit # of digits in fraction

Returns:

string approximating "%0.pd"

cvd2s

public final java.lang.String cvd2s(double v,
                                    int precision)

cvd2s() - convert double to string with precision # of digits

Parameters:

v - is value to cvt. If abs(v) < pow(10.0,-p) then return "+0" or "-0"

precision - of conversion. If precision > 0 then limit # of digits in fraction

Returns:

string approximating "%0.pd"

cvs2d

public final double cvs2d(java.lang.String str)

cvs2d() - convert String to double

Parameters:

str - numeric string to convert

Returns:

double else defaultFloat if bad numeric string

cvs2d

public final double cvs2d(java.lang.String str,
                          double defaultValue)

cvs2d() - convert String to double

Parameters:

str - numeric string to convert

defaultValue - is value to use if bad numeric string

Returns:

value else defaultValue if bad numeric string

cvs2f

public final float cvs2f(java.lang.String str)

cvs2f() - convert String to float

Parameters:

str - numeric string to convert

Returns:

value else defaultFloat if bad numeric string

cvs2f

public final float cvs2f(java.lang.String str,
                         float defaultValue)

cvs2f() - convert String to float

Parameters:

str - numeric string to convert

defaultValue - is value to use if bad numeric string

Returns:

value else defaultFloat if bad numeric string

cvs2i

public final int cvs2i(java.lang.String str)

cvs2i() - convert String to int

Parameters:

str - numeric string to convert

Returns:

value else defaultInt if bad numeric string

cvs2i

public final int cvs2i(java.lang.String str,
                       int defaultValue)

cvs2i() - convert String to int

Parameters:

str - numeric string to convert

defaultValue - is value to use if bad numeric string

Returns:

value else defaultInt if bad numeric string

cvs2iArray

public final int[] cvs2iArray(java.lang.String str,
                              int maxExpected,
                              java.lang.String delimChr)

cvs2iArray() - convert String arg list "1,4,3,6,..." to int[] If there are more than maxExpected number of args in string, ignore them and just return what has been parsed so far.

Parameters:

str - string containt a list of integers

maxExpected - # of numbers to be parsed

delimChr - delimiter to be used

Returns:

array of integers else null if problem

cvs2Array

public final java.lang.String[] cvs2Array(java.lang.String str,
                                          int maxExpected,
                                          java.lang.String delimChr)

cvs2Array() - convert String arg list "1,4,3,6,..." to String[] If there are more than maxExpected number of args in string, ignore them and just return what has been parsed so far.

Parameters:

str - string containt a list of Strings

maxExpected - # of numbers to be parsed

delimChr - delimiter to be used

Returns:

array of Strings else null if problem

cvtValueToStars

public final java.lang.String cvtValueToStars(float val,
                                              float valMax,
                                              int maxStars,
                                              boolean rightFillFlag)

cvtValueToStars() - cvt val in[0:valMax] to "****"+" " string where the maximum # of stars for v==vMax is specified. The rest of the string is filled with spaces. maxStars is clipped at 30.

Parameters:

val - is value to be converted to starts

valMax - is maximum value expected

maxStars - is max # of stars to use for largest value

rightFillFlag - if true will right fill the string with spaces

Returns:

list of "*********"

getRatioStr

public final java.lang.String getRatioStr()

getRatioStr() - get "F1/F2", "Cy3/Cy5" or "Cy5/Cy3", etc. string. Analyze the mae.useRatioDataFlag and mae.useCy5OverCy3Flag

Returns:

the new string and set it into mae.reportRatioStr.

createMontageTableOfGene

public static final SimpleTable createMontageTableOfGene(int gid,
                                                         boolean addFullImagePathFlag)

createMontageTableOfGene() - create montage table of gene data across the HP-E sample conditions.

 Verify that the data exists before process:
    1) has gene to make montage on
    2) make sure have .quant (X,Y) data
    3) has Database_ID data corresponding to xxxx in images
    4) has maeDir/Images/xxxx.jpg.
 Table fields include:
 "Sample#", "X", "Y", "SampleName", "ImagePath", "DatabaseID", "HP-set",
  "ratioData", "intensData1", "intensData2", "ClassName", "f1Lbl",
 "f2Lbl", "database", "dbSubset", "GeneName", "MasterID", "dataType"

Parameters:

gid - Grid Index (GID). If -1, use the current Gene if defined.

addFullImagePathFlag - is set then output full path of image files.

Returns:

If succeed then return the table else if fail then return Table with tRows= -1 and the error string in the Table tMsg.

sleepMsec

public final void sleepMsec(int sleepMsec)

sleepMsec() - sleep nMsec where nMsec must be >= 0 milliseconds.

Parameters:

sleepMsec - is the number of milliseconds to sleep

cvtSpacesToUnderscores

public final java.lang.String cvtSpacesToUnderscores(java.lang.String str)

cvtSpacesToUnderscores() - replace spaces and other illegal file name characters with '_' chars to make file names highly portable.

      : space ( ) ; " { } < > = , ? \ / % * ! @ & | ' ` \t
 

Parameters:

str - to convert

Returns:

string with all special illegal charactes converted to '_' chars

copyFile

public final boolean copyFile(java.lang.String srcName,
                              java.lang.String dstName,
                              java.lang.String optUpdateMsg,
                              int optEstInputFileLth)

copyFile() - binary copy of one file or URL toa local file

Parameters:

srcName - is either a full path local file name or a http:// prefixed URL string of the source file.

dstName - is the full path of the local destination file name

optUpdateMsg - (opt) will display message in showMsg() and increasing ... in showMsg2(). One '.' for every 10K bytes read. This only is used when reading a URL. Set to null if not used.

optEstInputFileLth - is the estimate size of the in;ut file if known else 0. Used in progress bar.

Returns:

true if succeed.

deleteLocalFile

public final boolean deleteLocalFile(java.lang.String fileName)

deleteLocalFile() - delete local file.

Parameters:

fileName - to be deleted on the local file system.

Returns:

false if failed.

cvtEnvPaths2Properties

public static final boolean cvtEnvPaths2Properties()

cvtEnvPaths2Properties() - get all system ENV variables and set them as separate Java properties so we can get them individually from System.getProperty(var) calls.

Returns:

true if succeed

cvFileNameWithMod

public static final java.lang.String cvFileNameWithMod(java.lang.String fileName,
                                                       java.lang.String mod)

cvFileNameWithMod() - insert modifier string before file extension

Parameters:

fileName - (with file extension)

mod - to insert before file extension

Returns:

new file name

getListOfMenuStubNames

public static final java.lang.String[] getListOfMenuStubNames()

getListOfMenuStubNames() - get list of menu stub names

Returns:

list of Menu Stub Names