Class Parameters


  • public class Parameters
    extends java.lang.Object
    The Parameters class contains the machine parameters. These are the user name, the install directory and the parameters for running the Java applications. These are inherited from the parent entity (e.g. the machine inherits the Parameters from the PhysicalLocation), then overwrites its own specified variables.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.lang.String getArchiveDatabaseDirValue()
      For retrieving the directory for the archive database.
      java.util.List<org.dom4j.Element> getClassPaths()
      For retrieving the list of class paths.
      java.lang.String getHarvestDatabaseDirValue()
      For retrieving the directory for the database.
      java.lang.String getInstallDirValue()
      For retrieving the install directory parameter.
      org.dom4j.Element getMachineUserName()
      For retrieving the machine user name parameter.
      void newParameters​(org.dom4j.Element root)
      Overwrites the inherited parameters, if the root has new specified.
      java.lang.String writeJavaOptions()
      Makes all the java options into a single String.
      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • Parameters

        public Parameters​(XmlStructure root)
                   throws ArgumentNotValid
        Constructor. Retrieves the parameters from the XML tree.
        Parameters:
        root - The root of the branch for the parent instance. This retrieves the variables in the branch.
        Throws:
        ArgumentNotValid - If the root is null.
    • Method Detail

      • newParameters

        public void newParameters​(org.dom4j.Element root)
                           throws ArgumentNotValid
        Overwrites the inherited parameters, if the root has new specified.
        Parameters:
        root - The root of the current instance.
        Throws:
        ArgumentNotValid - If the root is null.
      • writeJavaOptions

        public java.lang.String writeJavaOptions()
        Makes all the java options into a single String.
        Returns:
        All the java options.
      • getInstallDirValue

        public java.lang.String getInstallDirValue()
        For retrieving the install directory parameter.
        Returns:
        The install directory element, or empty string if install dir is null.
      • getHarvestDatabaseDirValue

        public java.lang.String getHarvestDatabaseDirValue()
        For retrieving the directory for the database.
        Returns:
        The database directory element, or empty string if install dir is null.
      • getArchiveDatabaseDirValue

        public java.lang.String getArchiveDatabaseDirValue()
        For retrieving the directory for the archive database.
        Returns:
        The archive database install directory element, or empty string if install dir is null.
      • getMachineUserName

        public org.dom4j.Element getMachineUserName()
        For retrieving the machine user name parameter.
        Returns:
        The machine user name.
      • getClassPaths

        public java.util.List<org.dom4j.Element> getClassPaths()
        For retrieving the list of class paths.
        Returns:
        The list of class paths.