Java Doc for PlannerOptions.java in  » Workflow-Engines » pegasus-2.1.0 » org » griphyn » cPlanner » classes » Java Source Code / Java DocumentationJava Source Code and Java Documentation

Java Source Code / Java Documentation 1.  6.0 JDK Core 2.  6.0 JDK Modules 3.  6.0 JDK Modules com.sun 4.  6.0 JDK Modules com.sun.java 5.  6.0 JDK Modules sun 6.  6.0 JDK Platform 7.  Ajax 8.  Apache Harmony Java SE 9.  Aspect oriented 10.  Authentication Authorization 11.  Blogger System 12.  Build 13.  Byte Code 14.  Cache 15.  Chart 16.  Chat 17.  Code Analyzer 18.  Collaboration 19.  Content Management System 20.  Database Client 21.  Database DBMS 22.  Database JDBC Connection Pool 23.  Database ORM 24.  Development 25.  EJB Server geronimo 26.  EJB Server GlassFish 27.  EJB Server JBoss 4.2.1 28.  EJB Server resin 3.1.5 29.  ERP CRM Financial 30.  ESB 31.  Forum 32.  GIS 33.  Graphic Library 34.  Groupware 35.  HTML Parser 36.  IDE 37.  IDE Eclipse 38.  IDE Netbeans 39.  Installer 40.  Internationalization Localization 41.  Inversion of Control 42.  Issue Tracking 43.  J2EE 44.  JBoss 45.  JMS 46.  JMX 47.  Library 48.  Mail Clients 49.  Net 50.  Parser 51.  PDF 52.  Portal 53.  Profiler 54.  Project Management 55.  Report 56.  RSS RDF 57.  Rule Engine 58.  Science 59.  Scripting 60.  Search Engine 61.  Security 62.  Sevlet Container 63.  Source Control 64.  Swing Library 65.  Template Engine 66.  Test Coverage 67.  Testing 68.  UML 69.  Web Crawler 70.  Web Framework 71.  Web Mail 72.  Web Server 73.  Web Services 74.  Web Services apache cxf 2.0.1 75.  Web Services AXIS2 76.  Wiki Engine 77.  Workflow Engines 78.  XML 79.  XML UI Java Java Tutorial Java Open Source Jar File Download Java Articles Java Products Java by API Photoshop Tutorials Maya Tutorials Flash Tutorials 3ds-Max Tutorials Illustrator Tutorials GIMP Tutorials C# / C Sharp C# / CSharp Tutorial C# / CSharp Open Source ASP.Net ASP.NET Tutorial JavaScript DHTML JavaScript Tutorial JavaScript Reference HTML / CSS HTML CSS Reference C / ANSI-C C Tutorial C++ C++ Tutorial Ruby PHP Python Python Tutorial Python Open Source SQL Server / T-SQL SQL Server / T-SQL Tutorial Oracle PL / SQL Oracle PL/SQL Tutorial PostgreSQL SQL / MySQL MySQL Tutorial VB.Net VB.Net Tutorial Flash / Flex / ActionScript VBA / Excel / Access / Word XML XML Tutorial Microsoft Office PowerPoint 2007 Tutorial Microsoft Office Excel 2007 Tutorial Microsoft Office Word 2007 Tutorial

Java Source Code / Java Documentation » Workflow Engines » pegasus 2.1.0 » org.griphyn.cPlanner.classes   Source Cross Reference   Class Diagram   Java Document (Java Doc)   java.lang.Object    org.griphyn.cPlanner.classes.Data       org.griphyn.cPlanner.classes.PlannerOptions PlannerOptions public class PlannerOptions extends Data implements Cloneable(Code) Holds the information about thevarious options which user specifies to the Concrete Planner at runtime. author:    Karan Vahi author:    Gaurang Mehta version:    $Revision: 464 $ Constructor Summary public   PlannerOptions()      Default Constructor. Method Summary public  boolean authenticationSet()      Returns the authenticate option for the planner. public  Object clone()      Returns a new copy of the Object. public  boolean generateRandomDirectory()      Returns whether to generate a random directory or not. public  String getBaseSubmitDirectory()      public  String getBasenamePrefix()      Returns the basename prefix for the per workflow files that are to be generated by the planner. public  Set getCacheFiles()      Returns the cache files. public  boolean getCleanup()      Returns the option indicating whether to do cleanup or not. public  String getClusteringTechnique()      Returns the clustering technique to be used for clustering. public  String getDAX()      Returns the path to the dax file being used by the planner. public  String getDateTime(boolean extendedFormat)      Returns the time at which planning started in a ISO 8601 format. Parameters:   extendedFormat - will use the extended ISO 8601 format whichseparates the different timestamp items. public  Collection getExecutionSites()      Returns the names of the execution sites where the concrete workflow can be run. public  boolean getForce()      Returns the force option set for the planner. public  boolean getHelp()      Returns whether to display or not. public  int getLoggingLevel()      Returns the logging level. public  String getMegaDAGMode()      Returns the megadag generation option . public  String getOutputSite()      Returns the output site where to stage the output . public  String getPDAX()      Returns the path to the PDAX file being used by the planner. public  String getPartitioningType()      Returns the partitioning type in case of partition and plan. public  String getRandomDir()      Returns the random directory option. public  String getRelativeSubmitDirectory()      Returns the relative submit directory. public  String getSubmitDirectory()      Returns the path to the directory where the submit files are to be generated. public  List getVDSProperties()      Returns the VDS properties that were set by the user. public  String getVOGroup()      public  void incrementLogging()      Increments the logging level by 1. public  boolean monitorWorkflow()      Returns boolean indicating whether we want to monitor or not. public  boolean optionalArgSet()      Returns the flag to denote whether the optional argument for the random was specified or not. public  boolean partOfDeferredRun()      Returns a boolean indicating whether this invocation is part of a deferred execution or not. public  void setAuthentication(boolean value)      Sets the authenticate flag to the value passed. public  void setBasenamePrefix(String prefix)      Sets the basename prefix for the per workflow files. public  void setCacheFiles(String cacheList)      Sets the caches files. public  void setCacheFiles(Set files)      Sets the caches files. public  void setCleanup(boolean cleanup)      Sets the cleanup option for the planner. public  void setClusteringTechnique(String value)      Sets the clustering option. public  void setDAX(String dax)      Sets the DAX that has to be worked on by the planner. public  void setExecutionSites(String siteList)      Sets the names of the execution sites where the concrete workflow can be run. public  void setExecutionSites(Collection sites)      Sets the names of the execution sites where the concrete workflow can be run. public  void setForce(boolean force)      Sets the force option for the planner. public  void setHelp(boolean help)      Sets the help option for the planner. public  void setLoggingLevel(String level)      Sets the logging level for logging of messages. public  void setMegaDAGMode(String mode)      public  void setMonitoring(boolean value)      Sets the flag to denote whether we want to monitor the workflow or not. public  void setOptionalArg(boolean value)      Sets the flag to denote that the optional argument for the random was specified. public  void setOutputSite(String site)      Sets the output site specified by the user. public  void setPDAX(String pdax)      Sets the PDAX that has to be worked on by the planner. public  void setPartOfDeferredRun(boolean value)      Sets the flag to denote that the run is part of a larger deferred run. public  void setPartitioningType(String type)      Sets the partitioning type in case of partition and plan. public  void setRandomDir(String dir)      Sets the random directory in which the jobs are run. public  void setRelativeSubmitDirectory(String relative)      Sets the path to the directory where the submit files are to be generated. public  void setSubmitDirectory(String dir)      Sets the path to the directory where the submit files are to be generated. public  void setSubmitDirectory(File dir)      Sets the path to the directory where the submit files are to be generated. public  void setSubmitDirectory(String base, String relative)      Sets the path to the directory where the submit files are to be generated. public  void setSubmitToScheduler(boolean submit)      Returns whether to submit the workflow or not. public  void setVDSProperties(List properties)      Sets the VDS properties specifed by the user at the command line. public  void setVOGroup(String group)      public  boolean submitToScheduler()      Returns whether to submit the workflow or not. public  String toJVMOptions()      Converts the vds properties that need to be passed to the jvm as an option. public  String toOptions()      Generates the argument string corresponding to these options that can be used to invoke Pegasus. public  String toString()      Returns the textual description of all the options that were set for the planner. Constructor Detail PlannerOptions public PlannerOptions()(Code) Default Constructor. Method Detail authenticationSet public boolean authenticationSet()(Code) Returns the authenticate option for the planner. boolean indicating if it was set or not. clone public Object clone()(Code) Returns a new copy of the Object. The clone does not clone the internal VDS properties at the moment. the cloned copy. generateRandomDirectory public boolean generateRandomDirectory()(Code) Returns whether to generate a random directory or not. boolean getBaseSubmitDirectory public String getBaseSubmitDirectory()(Code) Returns the base submit directory the path to the directory. getBasenamePrefix public String getBasenamePrefix()(Code) Returns the basename prefix for the per workflow files that are to be generated by the planner. the basename if set, else null. getCacheFiles public Set getCacheFiles()(Code) Returns the cache files. Set of fully qualified paths to the cache files. getCleanup public boolean getCleanup()(Code) Returns the option indicating whether to do cleanup or not. the boolean value indicating the cleanup option. getClusteringTechnique public String getClusteringTechnique()(Code) Returns the clustering technique to be used for clustering. the value of clustering technique if set, else null getDAX public String getDAX()(Code) Returns the path to the dax file being used by the planner. path to DAX file. getDateTime public String getDateTime(boolean extendedFormat)(Code) Returns the time at which planning started in a ISO 8601 format. Parameters:   extendedFormat - will use the extended ISO 8601 format whichseparates the different timestamp items. If false, the basicformat will be used. In UTC and basic format, the 'T' separatorwill be omitted. String getExecutionSites public Collection getExecutionSites()(Code) Returns the names of the execution sites where the concrete workflow can be run. Set of execution site names. getForce public boolean getForce()(Code) Returns the force option set for the planner. the boolean value indicating the force option. getHelp public boolean getHelp()(Code) Returns whether to display or not. help boolean value. getLoggingLevel public int getLoggingLevel()(Code) Returns the logging level. the logging level. getMegaDAGMode public String getMegaDAGMode()(Code) Returns the megadag generation option . the mode if mode is setelse null getOutputSite public String getOutputSite()(Code) Returns the output site where to stage the output . the output site. getPDAX public String getPDAX()(Code) Returns the path to the PDAX file being used by the planner. path to PDAX file. getPartitioningType public String getPartitioningType()(Code) Returns the partitioning type in case of partition and plan. the type of partitioning technique getRandomDir public String getRandomDir()(Code) Returns the random directory option. the directory namenull if not set. getRelativeSubmitDirectory public String getRelativeSubmitDirectory()(Code) Returns the relative submit directory. the relative submit directory getSubmitDirectory public String getSubmitDirectory()(Code) Returns the path to the directory where the submit files are to be generated. the path to the directory. getVDSProperties public List getVDSProperties()(Code) Returns the VDS properties that were set by the user. List of NameValue objects each corresponding to aproperty key and value. getVOGroup public String getVOGroup()(Code) Returns the VO Group to which the user belongs VOGroup incrementLogging public void incrementLogging()(Code) Increments the logging level by 1. monitorWorkflow public boolean monitorWorkflow()(Code) Returns boolean indicating whether we want to monitor or not. boolean indicating whether monitoring was set or not. optionalArgSet public boolean optionalArgSet()(Code) Returns the flag to denote whether the optional argument for the random was specified or not. boolean indicating whether the optional argument was supplied or not. partOfDeferredRun public boolean partOfDeferredRun()(Code) Returns a boolean indicating whether this invocation is part of a deferred execution or not. boolean setAuthentication public void setAuthentication(boolean value)(Code) Sets the authenticate flag to the value passed. Parameters:   value - boolean value passed. setBasenamePrefix public void setBasenamePrefix(String prefix)(Code) Sets the basename prefix for the per workflow files. Parameters:   prefix - the prefix to be set. setCacheFiles public void setCacheFiles(String cacheList)(Code) Sets the caches files. If cache files have been already specified it adds to the existing set of files. It also sanitizes the paths. Tries to resolve the path, if the path given is relative instead of absolute. Parameters:   cacheList - comma separated list of cache files. setCacheFiles public void setCacheFiles(Set files)(Code) Sets the caches files. If cache files have been already specified it adds to the existing set of files. It also sanitizes the paths. Tries to resolve the path, if the path given is relative instead of absolute. Parameters:   files - the set of fully qualified paths to the cache files. setCleanup public void setCleanup(boolean cleanup)(Code) Sets the cleanup option for the planner. Parameters:   cleanup - boolean value. setClusteringTechnique public void setClusteringTechnique(String value)(Code) Sets the clustering option. Parameters:   value - the value to set. setDAX public void setDAX(String dax)(Code) Sets the DAX that has to be worked on by the planner. Parameters:   dax - the path to the DAX file. setExecutionSites public void setExecutionSites(String siteList)(Code) Sets the names of the execution sites where the concrete workflow can be run. Parameters:   siteList - comma separated list of sites. setExecutionSites public void setExecutionSites(Collection sites)(Code) Sets the names of the execution sites where the concrete workflow can be run. Parameters:   sites - Collection of execution site names. setForce public void setForce(boolean force)(Code) Sets the force option for the planner. Parameters:   force - boolean value. setHelp public void setHelp(boolean help)(Code) Sets the help option for the planner. Parameters:   help - boolean value. setLoggingLevel public void setLoggingLevel(String level)(Code) Sets the logging level for logging of messages. Parameters:   level - the logging level. setMegaDAGMode public void setMegaDAGMode(String mode)(Code) Sets the megadag generation option Parameters:   mode - the mode. setMonitoring public void setMonitoring(boolean value)(Code) Sets the flag to denote whether we want to monitor the workflow or not. Parameters:   value - boolean. setOptionalArg public void setOptionalArg(boolean value)(Code) Sets the flag to denote that the optional argument for the random was specified. Parameters:   value - boolean indicating whether the optional argument was givenor not. setOutputSite public void setOutputSite(String site)(Code) Sets the output site specified by the user. Parameters:   site - the output site. setPDAX public void setPDAX(String pdax)(Code) Sets the PDAX that has to be worked on by the planner. Parameters:   pdax - the path to the PDAX file. setPartOfDeferredRun public void setPartOfDeferredRun(boolean value)(Code) Sets the flag to denote that the run is part of a larger deferred run. Parameters:   value - the value setPartitioningType public void setPartitioningType(String type)(Code) Sets the partitioning type in case of partition and plan. Parameters:   type - the type of partitioning technique setRandomDir public void setRandomDir(String dir)(Code) Sets the random directory in which the jobs are run. Parameters:   dir - the basename of the random directory. setRelativeSubmitDirectory public void setRelativeSubmitDirectory(String relative)(Code) Sets the path to the directory where the submit files are to be generated. Parameters:   relative - the directory relative to the base where submit files are generated. setSubmitDirectory public void setSubmitDirectory(String dir)(Code) Sets the path to the directory where the submit files are to be generated. Parameters:   dir - the path to the directory. setSubmitDirectory public void setSubmitDirectory(File dir)(Code) Sets the path to the directory where the submit files are to be generated. Parameters:   dir - the path to the directory. setSubmitDirectory public void setSubmitDirectory(String base, String relative)(Code) Sets the path to the directory where the submit files are to be generated. Parameters:   base - the path to the base directory. Parameters:   relative - the directory relative to the base where submit files are generated. setSubmitToScheduler public void setSubmitToScheduler(boolean submit)(Code) Returns whether to submit the workflow or not. Parameters:   submit - boolean indicating whether to submit or not. setVDSProperties public void setVDSProperties(List properties)(Code) Sets the VDS properties specifed by the user at the command line. Parameters:   properties - List of NameValue objects. setVOGroup public void setVOGroup(String group)(Code) Set the VO Group to which the user belongs Parameters:   group - the VOGroup submitToScheduler public boolean submitToScheduler()(Code) Returns whether to submit the workflow or not. boolean indicating whether to submit or not. toJVMOptions public String toJVMOptions()(Code) Converts the vds properties that need to be passed to the jvm as an option. the jvm options as String. toOptions public String toOptions()(Code) Generates the argument string corresponding to these options that can be used to invoke Pegasus. During its generation it ignores the dax and pdax options as they are specified elsewhere. all the options in a String separated by whitespace. toString public String toString()(Code) Returns the textual description of all the options that were set for the planner. the textual description. Fields inherited from org.griphyn.cPlanner.classes.Data public String mLogMsg(Code)(Java Doc) public LogManager mLogger(Code)(Java Doc) Methods inherited from org.griphyn.cPlanner.classes.Data public String setToString(Set s, String delim)(Code)(Java Doc) abstract public String toString()(Code)(Java Doc) public String vectorToString(String heading, Vector vector)(Code)(Java Doc) Methods inherited from java.lang.Object native protected Object clone() throws CloneNotSupportedException(Code)(Java Doc) public boolean equals(Object obj)(Code)(Java Doc) protected void finalize() throws Throwable(Code)(Java Doc) final native public Class getClass()(Code)(Java Doc) native public int hashCode()(Code)(Java Doc) final native public void notify()(Code)(Java Doc) final native public void notifyAll()(Code)(Java Doc) public String toString()(Code)(Java Doc) final native public void wait(long timeout) throws InterruptedException(Code)(Java Doc) final public void wait(long timeout, int nanos) throws InterruptedException(Code)(Java Doc) final public void wait() throws InterruptedException(Code)(Java Doc)