Package weka.core

Class Environment

java.lang.Object
weka.core.Environment
All Implemented Interfaces:
RevisionHandler
Direct Known Subclasses:
JobEnvironment
public class Environment extends Object implements RevisionHandler
This class encapsulates a map of all environment and java system properties. There are methods for adding and removing variables to this Environment object as well as to the system wide global environment. There is also a method for replacing key names (enclosed by ${}) with their associated value in Strings.
Version:
$Revision: 13892 $
Author:
Mark Hall (mhall{[at]}pentaho{[dot]}com)

  • Constructor Details

    • Environment

      public Environment()
      Constructs a new Environment object with all environment variables and java properties set.

    • Environment

      public Environment(Environment other)
      Constructor that makes a new Environment object containing all the entries in the supplied one
      Parameters:
      other - the Environment object to copy to this one

  • Method Details

    • getSystemWide

      public static Environment getSystemWide()
      Get the singleton system-wide (visible to every class in the running VM) set of environment variables.
      Returns:
      the system-wide set of environment variables.

    • containsEnvVariables

      public static boolean containsEnvVariables(String source)
      Tests for the presence of environment variables.
      Parameters:
      source - the string to test
      Returns:
      true if the argument contains one or more environment variables

    • substitute

      public String substitute(String source) throws Exception
      Substitute a variable names for their values in the given string.
      Parameters:
      source - the source string to replace variables in
      Returns:
      a String with all variable names replaced with their values
      Throws:
      Exception - if an unknown variable name is encountered

    • addVariable

      public void addVariable(String key, String value)
      Add a variable to the internal map of this properties object.
      Parameters:
      key - the name of the variable
      value - its value

    • addVariableSystemWide

      public void addVariableSystemWide(String key, String value)
      Add a a variable to the internal map of this properties object and to the global system-wide environment;
      Parameters:
      key - the name of the variable
      value - its value

    • removeVariable

      public void removeVariable(String key)
      Remove a named variable from the map.
      Parameters:
      key - the name of the varaible to remove.

    • getVariableNames

      public Set<String> getVariableNames()
      Get the names of the variables (keys) stored in the internal map.
      Returns:
      a Set of variable names (keys)

    • getVariableValue

      public String getVariableValue(String key)
      Get the value for a particular variable.
      Parameters:
      key - the name of the variable to get
      Returns:
      the associated value or null if this variable is not in the internal map

    • main

      public static void main(String[] args)
      Main method for testing this class.
      Parameters:
      args - a list of strings to replace variables in (e.g. "\${os.name} "\${java.version}")

    • getRevision

      public String getRevision()
      Returns the revision string.
      Specified by:
      getRevision in interface RevisionHandler
      Returns:
      the revision