X-Git-Url: http://source.jalview.org/gitweb/?a=blobdiff_plain;f=website%2Ffull_javadoc%2Fcompbio%2Fengine%2Fclient%2FUtil.html;fp=website%2Ffull_javadoc%2Fcompbio%2Fengine%2Fclient%2FUtil.html;h=c765a1760dff016abdf26a7d6b0a76c0af991663;hb=da8c820a7fb2edecb190589f3dc9c362e57a2f24;hp=0000000000000000000000000000000000000000;hpb=0bbebf27d045b1345bc042bdf24ef2e6808df251;p=jabaws.git diff --git a/website/full_javadoc/compbio/engine/client/Util.html b/website/full_javadoc/compbio/engine/client/Util.html new file mode 100644 index 0000000..c765a17 --- /dev/null +++ b/website/full_javadoc/compbio/engine/client/Util.html @@ -0,0 +1,588 @@ + + + + + + +Util + + + + + + + + + + + + +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ +

+ +compbio.engine.client +
+Class Util

+
+java.lang.Object
+  extended by compbio.engine.client.Util
+
+
+
+
public final class Util
extends Object
+ + +

+

+ +

+ + + + + + + + + + + +
+Constructor Summary
Util() + +
+           
+  + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+Method Summary
+static StringconvertToAbsolute(String relativePath) + +
+           
+static StringgetCommand(Executable.ExecProvider provider, + Class<?> clazz) + +
+           
+static StringgetExecProperty(String propertySpec, + Class<?> clazz) + +
+           
+static StringgetExecProperty(String propertySpec, + Executable<?> exec) + +
+           
+static StringgetFullPath(String workDirectory, + String fileName) + +
+           
+static StringgetJava() + +
+          Returns the absolute path to the Java executable from JAVA_HOME
+static + + + + +
+<T> LimitsManager<T>
+		getLimits(Class<T> clazz) + +
+          For now just assume that all parameters which came in needs setting it + will be a client responsibility to prepare RunnerConfig object then
+static Executable.ExecProvidergetSupportedRuntimes(Class<?> clazz) + +
+           
+static booleanisJavaLibrary(Class<?> clazz) + +
+          Returns true of executableName.jar.file property has some value in the + Executable.properties file, false otherwise.
+static booleanisMarked(String workDirectory, + JobStatus marker) + +
+           
+static booleanisValidJobId(String key) + +
+           
+static ConfiguredExecutable<?>loadExecutable(String taskId) + +
+           
+static Map<String,String>mergeEnvVariables(Map<String,String> sysEnvTobeModified, + Map<String,String> variables) + +
+           
+static voidwriteFile(String workDirectory, + String fileAndEventName, + String content, + boolean override) + +
+           
+static booleanwriteMarker(String workDirectory, + JobStatus fileType) + +
+           
+static voidwriteStatFile(String workDirectory, + String fileAndEventName) + +
+           
+  + + + + + + + +
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
+  +

+ + + + + + + + +
+Constructor Detail
+ +

+Util

+
+public Util()
+
+
+ + + + + + + + +
+Method Detail
+ +

+isValidJobId

+
+public static boolean isValidJobId(String key)
+
+
+
+
+
+
+ +

+writeStatFile

+
+public static void writeStatFile(String workDirectory,
+                                 String fileAndEventName)
+
+
+
+
+
+
+ +

+writeFile

+
+public static void writeFile(String workDirectory,
+                             String fileAndEventName,
+                             String content,
+                             boolean override)
+
+
+
+
+
+
+ +

+writeMarker

+
+public static final boolean writeMarker(String workDirectory,
+                                        JobStatus fileType)
+
+
+
+
+
+
+ +

+isMarked

+
+public static boolean isMarked(String workDirectory,
+                               JobStatus marker)
+
+
+
+
+
+
+ +

+mergeEnvVariables

+
+public static Map<String,String> mergeEnvVariables(Map<String,String> sysEnvTobeModified,
+                                                   Map<String,String> variables)
+
+
+
+
+
+
+ +

+convertToAbsolute

+
+public static String convertToAbsolute(String relativePath)
+
+
+
+
+
+
+ +

+getExecProperty

+
+public static String getExecProperty(String propertySpec,
+                                     Executable<?> exec)
+
+
+
+
+
+
+ +

+getExecProperty

+
+public static String getExecProperty(String propertySpec,
+                                     Class<?> clazz)
+
+
+
+
+
+
+ +

+getFullPath

+
+public static String getFullPath(String workDirectory,
+                                 String fileName)
+
+
+
+
+
+
+ +

+getCommand

+
+public static String getCommand(Executable.ExecProvider provider,
+                                Class<?> clazz)
+
+
+
+
+
+
+ +

+isJavaLibrary

+
+public static boolean isJavaLibrary(Class<?> clazz)
+
+
Returns true of executableName.jar.file property has some value in the + Executable.properties file, false otherwise. +

+

+
Parameters:
clazz - +
Returns:
+
+
+
+ +

+getJava

+
+public static String getJava()
+
+
Returns the absolute path to the Java executable from JAVA_HOME +

+

+ +
Returns:
returns the absolute path to the Java executable from JAVA_HOME
+
+
+
+ +

+getSupportedRuntimes

+
+public static Executable.ExecProvider getSupportedRuntimes(Class<?> clazz)
+
+
+
+
+
+
+ +

+loadExecutable

+
+public static ConfiguredExecutable<?> loadExecutable(String taskId)
+                                              throws ResultNotAvailableException
+
+
+ +
Throws: +
ResultNotAvailableException
+
+
+
+ +

+getLimits

+
+public static <T> LimitsManager<T> getLimits(Class<T> clazz)
+
+
For now just assume that all parameters which came in needs setting it + will be a client responsibility to prepare RunnerConfig object then +

+

+
Parameters:
rconfig - +
Returns:
public static List toOptionString(RunnerConfig + rconfig) { String option = ""; List options = new + ArrayList(); for (Parameter par : + rconfig.getParameters()) { if (par.getPossibleValues().isEmpty()) + { option = par.getOptionName(); } else { option = + par.getOptionName() + "=" + par.getPossibleValues().get(0); } // + separate options options.add(option); } return options; }
+
+
+ +
+ + + + + + + + + + + + + + + + + + + +
+ + + + + + + + + + + + +
Overview  Package   Class  Use  Tree  Deprecated  Index  Help 
+		 + +
+ PREV CLASS  + NEXT CLASS + FRAMES   + NO FRAMES   +  + + + +
+ SUMMARY: NESTED | FIELD | CONSTR | METHOD +DETAIL: FIELD | CONSTR | METHOD
+ + + +
+ + +