net.maizegenetics.plugindef

Class ParameterCache

net.maizegenetics.plugindef.ParameterCache

public class ParameterCache

This class is for storing a cache of parameters retrieved from a java.util.Properties file that is available to all plugins on the command line. This is used when run_pipeline.pl -configParameters config.txt... is used. config.txt example entries as follow... First five are using by GetDBConnectionPlugin -config config.txt but that should be refactored to individual PluginParameters. Then entry example would be GetDBConnectionPlugin.DBType=sqlite KinshipPlugin.method=TYPE is the standard. PLUGIN_NAME.COMMAND_LINE_NAME=VALUE host=localHost user=sqlite password=sqlite DB=/tempFileDir/outputDir/phgTestDB.db DBtype=sqlite KinshipPlugin.method=Normalized_IBS

Method Detail

load

public static void load(java.lang.String filename)

Loads the parameter cache with the values in the given java.util.Properties file.

Parameters:

filename - file name

value

public static java.util.Optional<java.lang.String> value(Plugin plugin,
                                                         java.lang.String parameter)

value

public static java.util.Optional<java.lang.String> value(java.lang.String plugin,
                                                         java.lang.String parameter)

Returns the value if any for the given plugin and parameter. Value for PluginClassName.parameter will be returned if it exists. If not, value for parameter will be returned. Otherwise, an empty optional.

Parameters:

plugin - plugin

parameter - parameter

Returns:

org.jetbrains.dokka.NodeRenderContent@24c1d50f: value if exists

value

public static java.util.Optional<java.lang.String> value(java.lang.String key)

Returns the value if any for the given key.

Parameters:

key - key

Returns:

org.jetbrains.dokka.NodeRenderContent@44f1651d: value if exists

hasValues

public static boolean hasValues()

Returns true if this cache has been loaded with values.

Returns:

org.jetbrains.dokka.NodeRenderContent@322a31a3: true if this cache has been loaded with values.

keys

public static java.util.Enumeration<?> keys()