Class MJAstate

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

public class MJAstate
extends MJAbase

MAExplorer Open Java API class to access MJAstate methods and data structures. Access get and save state, get additional state info

List of methods available to Plugin-writers

 ------------------- GET FLAGS ------------------------
 get_useDichromasyDisplayFlag() - get "useDichromasyDisplay" flag status
 get_gangSpotDuplicatesFlag) - get "gangSpotDuplicates" flag status
 get_presentationViewFlag() - get "presentationView" flag status
 get_viewFilteredSpotsFlag() - get "viewFilteredSpots" flag status
 get_useCy5OverCy3Flag() - get "useCy5OverCy3Flag" flag status
 get_useMouseOverFlag() - get "useMouseOver" flag status
 get_isZscoreNormFlag() - get "isZscoreNorm" flag status
 get_useExprProfileOverlayFlag() - get "useExprProfileOverlay" flag status
 get_updatePseudoArrayImageFlag() - get "updatePseudoArrayImage" flag status
 get_useRatioDataFlag() - get "useRatioData" flag status
 get_allowNegQuantDataFlag() - get "allowNegQuantData" flag status
 get_useHPxySetsDataFlag() - get "useHPxySetsData" flag status
 get_useHP_E_ListDataFlag() - get "useMeanHP_EdataFlag" flag status
 get_abortFlag() - get "abortFlag" flag status
 get_doGCflag() - get "doGCflag" flag status
 --------------------- SET FLAGS --------------------------------
 set_useRatioDataFlag() - set "useRatioData" flag status
 set_updatePseudoArrayImageFlag() - set "updatePseudoArrayImage" flag status
 set_isZscoreNormFlag() - set "isZscoreNorm" flag status
 set_abortFlag() - set "abortFlag" flag status
 set_doGCflag() - set "doGCflag" flag status
 --------------------- Change Database ---------------------------
 openNewFileDB() - open a new .mae database file
 --------------------- MAEPlugins hash state storage -------------
 getPluginHashState() - get state object value from MAEPlugin hash state storage.
 setPluginHashState() - set state object value from MAEPlugin hash state storage.
 flushPluginHashState() - flush the MAEPlugin hash state storage to the disk.

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/03/03 16:15:16 $ $Revision: 1.9 $
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 flushPluginHashState()
          flushPluginHashState() - flush the MAEPlugin hash state storage to the disk.
 boolean get_abortFlag()
          get_abortFlag() - get "abortFlag" flag status
 boolean get_allowNegQuantDataFlag()
          get_allowNegQuantDataFlag() - get "allowNegQuantData" flag status allow Negative Quantified intensity data
 boolean get_doGCFlag()
          get_doGCFlag() - get "doGCflag" flag status invoke the Garbage Collector when have time as determined by the main idle loop
 boolean get_gangSpotDuplicatesFlag()
          get_gangSpotDuplicatesFlag() - get "gangSpotDuplicates" flag status display and report ganged (F1,F2) data else just F1 data
 boolean get_isZscoreNormFlag()
          get_isZscoreNormFlag() - get "isZscoreNorm" flag status using one of the Zscore normalizations
 boolean get_presentationViewFlag()
          get_presentationViewFlag() - get "presentationView" flag status use larger fonts and graphics for presentations
 boolean get_updatePseudoImgFlag()
          get_updatePseudoArrayImageFlag() - get "updatePseudoArrayImage" flag status.
 boolean get_useCy5OverCy3Flag()
          get_useCy5OverCy3Flag() - get "useCy5OverCy3Flag" flag status Swap Cy3/Cy to Cy5/Cy3 for reporting purposes
 boolean get_useDichromasyDisplayFlag()
          get_useDichromasyDisplayFlag() - get "useDichromasyDisplay" flag status enable Dichromasy color-blindness display options
 boolean get_useExprProfileOverlayFlag()
          get_useExprProfileOverlayFlag() - get "useExprProfileOverlay" flag status Plot EP list as overlay 2Dplot else scrollable EP list
 boolean get_useHP_E_ListDataFlag()
          get_useHP_E_ListDataFlag() - get "useMeanHPeListDataFlag" flag status use mean HP-E 'list' data else single current HP sample data
 boolean get_useHPxySetsDataFlag()
          get_useHPxySetsDataFlag() - get "useHPxySetsData" flag status use mean HP-X,Y 'sets' data else HP-X,HP-Y single samples data
 boolean get_useMouseOverFlag()
          get_useMouseOverFlag() - get "useMouseOver" flag status
 boolean get_useRatioDataFlag()
          get_useRatioDataFlag() - get "useRatioData" flag status data is Cy3/Cy5 ratio else Intensity
 boolean get_viewFilteredSpotsFlag()
          get_viewFilteredSpotsFlag() - get "viewFilteredSpots" flag status in PseudoArray image show Filtered spots else don't show overlays
 java.lang.String getDbEstURL()
          getDbEstURL() - get the current url value
 java.lang.String getGbid2LocusLinkURL()
          getGbid2LocusLinkURL() - get the current url value
 java.lang.String getGenBankCloneURL()
          getGenBankCloneURL() - get the current url value
 java.lang.String getGenBankCloneURLepilogue()
          getGenBankCloneURLepilogue() - get the current url value
 java.lang.String getGeneBankAccURL()
          getGenBankAccURL() - get the current url value
 java.lang.String getGeneCardURL()
          getGeneCardURL() - get the current url value
 java.lang.String getIMAGE2GenBankURL()
          getIMAGE2GenBankURL() - get the current url value
 java.lang.String getIMAGE2unigeneURL()
          getIMAGE2unigeneURL() - get the current url value
 java.lang.String getLocusLinkURL()
          getLocusLinkURL() - get the current url value
 java.lang.String getMAdbURL()
          getMAdbURL() - get the current url value
 java.lang.String getMedMinerURL()
          getMedMinerURL() - get the current url value
 java.lang.String getMedMinerURLepilogue()
          getMedMinerURLepilogue() - get the current url value
 java.lang.String getPirURL()
          getPirURL() - get the current url value
 java.lang.Object getPluginHashState(java.lang.String pluginName, java.lang.String varName)
          getPluginHashState() - get state object value from MAEPlugin hash state storage.
 boolean getPluginHashState(java.lang.String pluginName, java.lang.String varName, boolean defValue)
          getPluginHashState() - get boolean state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
 byte getPluginHashState(java.lang.String pluginName, java.lang.String varName, byte defValue)
          getPluginHashState() - get byte state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
 double getPluginHashState(java.lang.String pluginName, java.lang.String varName, double defValue)
          getPluginHashState() - get double state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
 float getPluginHashState(java.lang.String pluginName, java.lang.String varName, float defValue)
          getPluginHashState() - get float state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
 int getPluginHashState(java.lang.String pluginName, java.lang.String varName, int defValue)
          getPluginHashState() - get int state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
 long getPluginHashState(java.lang.String pluginName, java.lang.String varName, long defValue)
          getPluginHashState() - get long state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
 java.lang.String getPluginHashStateFileName()
          getPluginHashStateFileName() - get the MAEPlugin hash state disk file name.
 java.lang.String getSwissProtURL()
          getSwissProtURL() - get the current url value
 java.lang.String getUniGeneClusterIdURL()
          getUniGeneClusterIdURL() - get the current url value
 java.lang.String getUniGeneURL()
          getUniGeneURL() - get the current url value
 boolean openNewFileDB(java.lang.String dbMAEdir, java.lang.String maeFilename, boolean saveOldDBfileFlag)
          openNewFileDB() - open a new .mae database file.
 void set_abortFlag(boolean flag)
          set_abortFlag() - set "abortFlag" flag status
 void set_doGCflag(boolean flag)
          set_doGCFlag() - set "doGCflag" flag status to invoke the Garbage Collector when have time as determined by main idle loop.
 void set_isZscoreNorm(boolean flag)
          set_isZscoreNormFlag() - set "isZscoreNorm" flag status using one of the Zscore normalizations.
 void set_updatePseudoImgFlag(boolean flag)
          set_updatePseudoArrayImageFlag() - set "updatePseudoArrayImage" flag status.
 void setDbEstURL(java.lang.String url)
          setDbEstURL() - set the url
 void setGbid2LocusLinkURL(java.lang.String url)
          setGbid2LocusLinkURL() - set the url
 void setGenBankAccURL(java.lang.String url)
          setGenBankAccURL() - set the url
 void setGenBankCloneURL(java.lang.String url)
          setGenBankCloneURL() - set the url
 void setGenBankCloneURLepilogue(java.lang.String url)
          setGenBankCloneURLepilogue() - set the url
 void setGeneCardURL(java.lang.String url)
          setGeneCardURL() - set the url
 void setIMAGE2GenBankURL(java.lang.String url)
          setIMAGE2GenBankURL() - set the url
 void setIMAGE2unigeneURL(java.lang.String url)
          setIMAGE2unigeneURL() - set the url
 void setLocusLinkURL(java.lang.String url)
          setLocusLinkURL() - set the url
 void setMAdbURL(java.lang.String url)
          setMAdbURL() - set the url
 void setMedMinerURL(java.lang.String url)
          setMedMinerURL() - set the url
 void setMedMinerURLepilogue(java.lang.String url)
          setMedMinerURLepilogue() - set the url
 void setPirURL(java.lang.String url)
          setPirURL() - set the url
 boolean setPluginHashState(java.lang.String pluginName, java.lang.String varName, java.lang.Object value)
          setPluginHashState() - set state object value from MAEPlugin hash state storage.
 void setSwissProtURL(java.lang.String url)
          setSwissProtURL() - set the url
 void setUniGeneClusterIdURL(java.lang.String url)
          setUniGeneClusterIdURL() - set the url
 void setUniGeneURL(java.lang.String url)
          setUniGeneURL() - set the url
 
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

get_useDichromasyDisplayFlag

public final boolean get_useDichromasyDisplayFlag()
get_useDichromasyDisplayFlag() - get "useDichromasyDisplay" flag status enable Dichromasy color-blindness display options
Returns:
value

get_gangSpotDuplicatesFlag

public final boolean get_gangSpotDuplicatesFlag()
get_gangSpotDuplicatesFlag() - get "gangSpotDuplicates" flag status display and report ganged (F1,F2) data else just F1 data
Returns:
value

get_presentationViewFlag

public final boolean get_presentationViewFlag()
get_presentationViewFlag() - get "presentationView" flag status use larger fonts and graphics for presentations
Returns:
value

get_viewFilteredSpotsFlag

public final boolean get_viewFilteredSpotsFlag()
get_viewFilteredSpotsFlag() - get "viewFilteredSpots" flag status in PseudoArray image show Filtered spots else don't show overlays
Returns:
value

get_useCy5OverCy3Flag

public final boolean get_useCy5OverCy3Flag()
get_useCy5OverCy3Flag() - get "useCy5OverCy3Flag" flag status Swap Cy3/Cy to Cy5/Cy3 for reporting purposes
Returns:
value

get_useMouseOverFlag

public final boolean get_useMouseOverFlag()
get_useMouseOverFlag() - get "useMouseOver" flag status

get_isZscoreNormFlag

public final boolean get_isZscoreNormFlag()
get_isZscoreNormFlag() - get "isZscoreNorm" flag status using one of the Zscore normalizations
Returns:
value

get_useExprProfileOverlayFlag

public final boolean get_useExprProfileOverlayFlag()
get_useExprProfileOverlayFlag() - get "useExprProfileOverlay" flag status Plot EP list as overlay 2Dplot else scrollable EP list
Returns:
value

get_useRatioDataFlag

public final boolean get_useRatioDataFlag()
get_useRatioDataFlag() - get "useRatioData" flag status data is Cy3/Cy5 ratio else Intensity
Returns:
value

get_allowNegQuantDataFlag

public final boolean get_allowNegQuantDataFlag()
get_allowNegQuantDataFlag() - get "allowNegQuantData" flag status allow Negative Quantified intensity data
Returns:
value

get_useHPxySetsDataFlag

public final boolean get_useHPxySetsDataFlag()
get_useHPxySetsDataFlag() - get "useHPxySetsData" flag status use mean HP-X,Y 'sets' data else HP-X,HP-Y single samples data
Returns:
value

get_useHP_E_ListDataFlag

public final boolean get_useHP_E_ListDataFlag()
get_useHP_E_ListDataFlag() - get "useMeanHPeListDataFlag" flag status use mean HP-E 'list' data else single current HP sample data
Returns:
value

get_updatePseudoImgFlag

public final boolean get_updatePseudoImgFlag()
get_updatePseudoArrayImageFlag() - get "updatePseudoArrayImage" flag status. If true, it causes an update of pseudoarray image
Returns:
value

get_abortFlag

public final boolean get_abortFlag()
get_abortFlag() - get "abortFlag" flag status
Returns:
value

get_doGCFlag

public final boolean get_doGCFlag()
get_doGCFlag() - get "doGCflag" flag status invoke the Garbage Collector when have time as determined by the main idle loop
Returns:
value

set_updatePseudoImgFlag

public final void set_updatePseudoImgFlag(boolean flag)
set_updatePseudoArrayImageFlag() - set "updatePseudoArrayImage" flag status. This causes an update of the pseudoarray image

set_isZscoreNorm

public final void set_isZscoreNorm(boolean flag)
set_isZscoreNormFlag() - set "isZscoreNorm" flag status using one of the Zscore normalizations. [DEPRICATED] there are various side-effects since this may make the state inconsistent. So this method should be avoided.
Returns:
value

set_abortFlag

public final void set_abortFlag(boolean flag)
set_abortFlag() - set "abortFlag" flag status
Returns:
value

set_doGCflag

public final void set_doGCflag(boolean flag)
set_doGCFlag() - set "doGCflag" flag status to invoke the Garbage Collector when have time as determined by main idle loop.
Returns:
value

openNewFileDB

public final boolean openNewFileDB(java.lang.String dbMAEdir,
                                   java.lang.String maeFilename,
                                   boolean saveOldDBfileFlag)
openNewFileDB() - open a new .mae database file.
Parameters:
dbMAEdir - - full path of the new database MAE/ 'project' directory. E.g. "C:/user/test/MAE/" (with appropriate delimiters for the OS you are using).
maeFilename - - name of the .mae startup file to be started E.g. "Start.mae"
saveOldDBfileFlag - - if set, then save the old DB first
Returns:
true if succeed

setGenBankAccURL

public final void setGenBankAccURL(java.lang.String url)
setGenBankAccURL() - set the url
Parameters:
url - to set

getGeneBankAccURL

public final java.lang.String getGeneBankAccURL()
getGenBankAccURL() - get the current url value
Returns:
the current url value

setDbEstURL

public final void setDbEstURL(java.lang.String url)
setDbEstURL() - set the url
Parameters:
url - to set

getDbEstURL

public final java.lang.String getDbEstURL()
getDbEstURL() - get the current url value
Returns:
the current url value

setGenBankCloneURL

public final void setGenBankCloneURL(java.lang.String url)
setGenBankCloneURL() - set the url
Parameters:
url - to set

getGenBankCloneURL

public final java.lang.String getGenBankCloneURL()
getGenBankCloneURL() - get the current url value
Returns:
the current url value

setGenBankCloneURLepilogue

public final void setGenBankCloneURLepilogue(java.lang.String url)
setGenBankCloneURLepilogue() - set the url
Parameters:
url - to set

getGenBankCloneURLepilogue

public final java.lang.String getGenBankCloneURLepilogue()
getGenBankCloneURLepilogue() - get the current url value
Returns:
the current url value

setIMAGE2GenBankURL

public final void setIMAGE2GenBankURL(java.lang.String url)
setIMAGE2GenBankURL() - set the url
Parameters:
url - to set

getIMAGE2GenBankURL

public final java.lang.String getIMAGE2GenBankURL()
getIMAGE2GenBankURL() - get the current url value
Returns:
the current url value

setIMAGE2unigeneURL

public final void setIMAGE2unigeneURL(java.lang.String url)
setIMAGE2unigeneURL() - set the url
Parameters:
url - to set

getIMAGE2unigeneURL

public final java.lang.String getIMAGE2unigeneURL()
getIMAGE2unigeneURL() - get the current url value
Returns:
the current url value

setMAdbURL

public final void setMAdbURL(java.lang.String url)
setMAdbURL() - set the url
Parameters:
url - to set

getMAdbURL

public final java.lang.String getMAdbURL()
getMAdbURL() - get the current url value
Returns:
the current url value

setUniGeneURL

public final void setUniGeneURL(java.lang.String url)
setUniGeneURL() - set the url
Parameters:
url - to set

getUniGeneURL

public final java.lang.String getUniGeneURL()
getUniGeneURL() - get the current url value
Returns:
the current url value

setUniGeneClusterIdURL

public final void setUniGeneClusterIdURL(java.lang.String url)
setUniGeneClusterIdURL() - set the url
Parameters:
url - to set

getUniGeneClusterIdURL

public final java.lang.String getUniGeneClusterIdURL()
getUniGeneClusterIdURL() - get the current url value
Returns:
the current url value

setGeneCardURL

public final void setGeneCardURL(java.lang.String url)
setGeneCardURL() - set the url
Parameters:
url - to set

getGeneCardURL

public final java.lang.String getGeneCardURL()
getGeneCardURL() - get the current url value
Returns:
the current url value

setGbid2LocusLinkURL

public final void setGbid2LocusLinkURL(java.lang.String url)
setGbid2LocusLinkURL() - set the url
Parameters:
url - to set

getGbid2LocusLinkURL

public final java.lang.String getGbid2LocusLinkURL()
getGbid2LocusLinkURL() - get the current url value
Returns:
the current url value

setLocusLinkURL

public final void setLocusLinkURL(java.lang.String url)
setLocusLinkURL() - set the url
Parameters:
url - to set

getLocusLinkURL

public final java.lang.String getLocusLinkURL()
getLocusLinkURL() - get the current url value
Returns:
the current url value

setSwissProtURL

public final void setSwissProtURL(java.lang.String url)
setSwissProtURL() - set the url
Parameters:
url - to set

getSwissProtURL

public final java.lang.String getSwissProtURL()
getSwissProtURL() - get the current url value
Returns:
the current url value

setPirURL

public final void setPirURL(java.lang.String url)
setPirURL() - set the url
Parameters:
url - to set

getPirURL

public final java.lang.String getPirURL()
getPirURL() - get the current url value
Returns:
the current url value

setMedMinerURL

public final void setMedMinerURL(java.lang.String url)
setMedMinerURL() - set the url
Parameters:
url - to set

getMedMinerURL

public final java.lang.String getMedMinerURL()
getMedMinerURL() - get the current url value
Returns:
the current url value

setMedMinerURLepilogue

public final void setMedMinerURLepilogue(java.lang.String url)
setMedMinerURLepilogue() - set the url
Parameters:
url - to set

getMedMinerURLepilogue

public final java.lang.String getMedMinerURLepilogue()
getMedMinerURLepilogue() - get the current url value
Returns:
the current url value

getPluginHashState

public int getPluginHashState(java.lang.String pluginName,
                              java.lang.String varName,
                              int defValue)
getPluginHashState() - get int state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
Parameters:
pluginName - of plugin
varName - of variable in the plugin
defValue - is the default value of variable if not found in hash store
Returns:
Object for the variable if it exists, else return null

getPluginHashState

public byte getPluginHashState(java.lang.String pluginName,
                               java.lang.String varName,
                               byte defValue)
getPluginHashState() - get byte state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
Parameters:
pluginName - of plugin
varName - of variable in the plugin
defValue - is the default value of variable if not found in hash store
Returns:
Object for the variable if it exists, else return null

getPluginHashState

public boolean getPluginHashState(java.lang.String pluginName,
                                  java.lang.String varName,
                                  boolean defValue)
getPluginHashState() - get boolean state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
Parameters:
pluginName - of plugin
varName - of variable in the plugin
defValue - is the default value of variable if not found in hash store
Returns:
Object for the variable if it exists, else return null

getPluginHashState

public long getPluginHashState(java.lang.String pluginName,
                               java.lang.String varName,
                               long defValue)
getPluginHashState() - get long state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
Parameters:
pluginName - of plugin
varName - of variable in the plugin
defValue - is the default value of variable if not found in hash store
Returns:
Object for the variable if it exists, else return null

getPluginHashState

public float getPluginHashState(java.lang.String pluginName,
                                java.lang.String varName,
                                float defValue)
getPluginHashState() - get float state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
Parameters:
pluginName - of plugin
varName - of variable in the plugin
defValue - is the default value of variable if not found in hash store
Returns:
Object for the variable if it exists, else return null

getPluginHashState

public double getPluginHashState(java.lang.String pluginName,
                                 java.lang.String varName,
                                 double defValue)
getPluginHashState() - get double state value from MAEPlugin hash state storage This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
Parameters:
pluginName - of plugin
varName - of variable in the plugin
defValue - is the default value of variable if not found in hash store
Returns:
Object for the variable if it exists, else return null

getPluginHashState

public java.lang.Object getPluginHashState(java.lang.String pluginName,
                                           java.lang.String varName)
getPluginHashState() - get state object value from MAEPlugin hash state storage. This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
Parameters:
pluginName - of plugin
varName - of variable in the plugin
Returns:
Object for the variable if it exists, else return null

setPluginHashState

public boolean setPluginHashState(java.lang.String pluginName,
                                  java.lang.String varName,
                                  java.lang.Object value)
setPluginHashState() - set state object value from MAEPlugin hash state storage. This looks for a symbol with the name (pluginName + "." + varName) in the global hash store.
Parameters:
pluginName - of plugin
varName - of variable in the plugin
value - of object to save
Returns:
true if succeeds

getPluginHashStateFileName

public java.lang.String getPluginHashStateFileName()
getPluginHashStateFileName() - get the MAEPlugin hash state disk file name. The MJAPlugins hash storage database name is based on the MAEPlugins DB name. It is saved in State/dbStartupName + ".hash"
[TODO]
Returns:
file name if succeeds, else null

flushPluginHashState

public boolean flushPluginHashState()
flushPluginHashState() - flush the MAEPlugin hash state storage to the disk. The MJAPlugins hash storage database name is based on the MAEPlugins DB name. It is saved in State/dbStartupName + ".hash"
[TODO]
Returns:
true if succeeds