ADAG (PEGASUS)

java.lang.Object
- edu.isi.pegasus.planner.dax.ADAG

public class ADAG
extends Object

 This class provides the Java API to create Abstract Workflow files.
 Starting 5.0 Release, this class by default writes out YAML formatted abstract
 workflow file. The information included in the generated abstract workflow is a
 subset of the Pegasus Workflow YAML schema that is available at
 http://pegasus.isi.edu/schema/wf-5.0.yml

 In particular, it is missing options to create a Site Catalog, and associate
 Containers with user executables. If you need this information, we recommend you
 use the python Pegasus workflow API.


 The Abstract Workflow consists of 6 parts the first 4 are optional and the last is optional.

file:Used as "In Abstract Workflow" Replica Catalog (Optional)
executable: Used as "In Abstract Workflow" Transformation Catalog (Optional)
transformation: Used to describe compound executables. i.e. Executable depending on other executables (Optional)
job|dax|dag: Used to describe a single job or sub dax or sub dax. Atleast 1 required.
child: The dependency section to describe dependencies between job|dax|dag elements.

To generate an example DIAMOND Abstract Workflow run the ADAG Class as shown below java ADAG filename NOTE: This is an illustrative example only. Please see examples directory for a working example

Here is sample java code that illustrates how to use the Java Abstract Workflow API

      java.io.File cwdFile = new java.io.File (".");
 String cwd = cwdFile.getCanonicalPath();

 String pegasusHome = "/usr";
 String site = "TestCluster";

 ADAG dax = new ADAG("diamond");
 dax.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
 dax.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
 dax.addMetadata( "name", "diamond");
 dax.addMetadata( "createdBy", "Karan Vahi");

 File fa = new File("f.a");
 fa.addPhysicalFile("file://" + cwd + "/f.a", "local");
 fa.addMetaData( "size", "1024" );
 dax.addFile(fa);

 File fb1 = new File("f.b1");
 File fb2 = new File("f.b2");
 File fc1 = new File("f.c1");
 File fc2 = new File("f.c2");
 File fd = new File("f.d");
 fd.setRegister(true);

 Executable preprocess = new Executable("pegasus", "preprocess", "4.0");
 preprocess.setArchitecture(Executable.ARCH.X86).setOS(Executable.OS.LINUX);
 preprocess.setInstalled(true);
 preprocess.addMetaData( "size", "2048" );
 preprocess.addPhysicalFile("file://" + pegasus_location + "/bin/keg", site_handle);

 Executable findrange = new Executable("pegasus", "findrange", "4.0");
 findrange.setArchitecture(Executable.ARCH.X86).setOS(Executable.OS.LINUX);
 findrange.setInstalled(true);
 findrange.addPhysicalFile("file://" + pegasus_location + "/bin/keg", site_handle);

 Executable analyze = new Executable("pegasus", "analyze", "4.0");
 analyze.setArchitecture(Executable.ARCH.X86).setOS(Executable.OS.LINUX);
 analyze.setInstalled(true);
 analyze.addPhysicalFile("file://" + pegasus_location + "/bin/keg", site_handle);

 dax.addExecutable(preprocess).addExecutable(findrange).addExecutable(analyze);

 // Add a preprocess job
 Job j1 = new Job("j1", "pegasus", "preprocess", "4.0");
 j1.addArgument("-a preprocess -T 60 -i ").addArgument(fa);
 j1.addArgument("-o ").addArgument(fb1);
 j1.addArgument(" ").addArgument(fb2);
 j1.addMetadata( "time", "60" );
 j1.uses(fa, File.LINK.INPUT);
 j1.uses(fb1, File.LINK.OUTPUT);
 j1.uses(fb2, File.LINK.OUTPUT);
 j1.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
 j1.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
 dax.addJob(j1);

 // Add left Findrange job
 Job j2 = new Job("j2", "pegasus", "findrange", "4.0");
 j2.addArgument("-a findrange -T 60 -i ").addArgument(fb1);
 j2.addArgument("-o ").addArgument(fc1);
 j2.addMetadata( "time", "60" );
 j2.uses(fb1, File.LINK.INPUT);
 j2.uses(fc1, File.LINK.OUTPUT);
 j2.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
 j2.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
 dax.addJob(j2);

 // Add right Findrange job
 Job j3 = new Job("j3", "pegasus", "findrange", "4.0");
 j3.addArgument("-a findrange -T 60 -i ").addArgument(fb2);
 j3.addArgument("-o ").addArgument(fc2);
 j3.addMetadata( "time", "60" );
 j3.uses(fb2, File.LINK.INPUT);
 j3.uses(fc2, File.LINK.OUTPUT);
 j3.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
 j3.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
 dax.addJob(j3);

 // Add analyze job
 Job j4 = new Job("j4", "pegasus", "analyze", "4.0");
 j4.addArgument("-a analyze -T 60 -i ").addArgument(fc1);
 j4.addArgument(" ").addArgument(fc2);
 j4.addArgument("-o ").addArgument(fd);
 j4.addMetadata( "time", "60" );
 j4.uses(fc1, File.LINK.INPUT);
 j4.uses(fc2, File.LINK.INPUT);
 j4.uses(fd, File.LINK.OUTPUT);
 j4.addNotification(Invoke.WHEN.start,"/pegasus/libexec/notification/email -t notify@example.com");
 j4.addNotification(Invoke.WHEN.at_end,"/pegasus/libexec/notification/email -t notify@example.com");
 dax.addJob(j4);

 dax.addDependency("j1", "j2");
 dax.addDependency("j1", "j3");
 dax.addDependency("j2", "j4");
 dax.addDependency("j3", "j4");
 dax.writeToSTDOUT();

Version:: $Revision$
Author:: Gaurang Mehta gmehta at isi dot edu, Karan Vahi, Ryan Tanaka

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`ADAG.FORMAT` Enum to indicate how the generated dax file should be formatted
`(package private) static class`	`ADAG.JsonSerializer` Custom serializer for YAML representation of ADAG

Field Summary

Fields
Modifier and Type	Field and Description
`static ADAG.FORMAT`	`DEFAULT_FORMAT` The default format to use for writing out the Abstract Workflow.
`private int`	`mCount` The Count of the number of dax objects : N
`private Map<String,Set<Edge>>`	`mDependencies` Map of Dependencies between Job,DAX,DAG objects.
`private Set<Executable>`	`mExecutables` The list of Executable objects
`private List<File>`	`mFiles` The list of edu.isi.pegasus.planner.dax.File objects
`private int`	`mIndex` The Index of the dax object.
`private List<Invoke>`	`mInvokes` List of Notification objects
`private Map<String,AbstractJob>`	`mJobs` The List of Job,DAX and DAG objects
`private List<DAG>`	`mLDAGs`
`private List<DAX>`	`mLDAXs`
`private List<Job>`	`mLJobs`
`private edu.isi.pegasus.common.logging.LogManager`	`mLogger`
`private Set<MetaData>`	`mMetaDataAttributes` The metadata attributes associated with the whole workflow.
`private String`	`mName` The Name / Label of the DAX
`private Set<Transformation>`	`mTransformations` The List of Transformation objects
`private edu.isi.pegasus.common.util.XMLWriter`	`mWriter` Handle the XML writer
`static String`	`PEGASUS_VENDOR_EXTENSION_KEY`
`static String`	`SCHEMA_LOCATION` The "not-so-official" location URL of the DAX schema definition.
`static String`	`SCHEMA_NAMESPACE` The "official" namespace URI of the site catalog schema.
`static String`	`SCHEMA_NAMESPACE_XSI` XSI SCHEMA NAMESPACE
`static String`	`SCHEMA_VERSION` The version to report.
`private static String`	`WF_API_KEY` The type of Abstract Workflow API generated

Constructor Summary

Constructors
Constructor and Description

ADAG(String name)
The Simple constructor for the DAX object

ADAG(String name, int index, int count)
DAX Constructor

Constructors
Constructor and Description
`ADAG(String name)` The Simple constructor for the DAX object
`ADAG(String name, int index, int count)` DAX Constructor

Method Summary

All Methods Static Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method and Description
`private ADAG`	`addAbstractJob(AbstractJob ajob)` Add AbstractJob to the DAX
`private ADAG`	`addAbstractJobs(List<AbstractJob> ajobs)` Add AbstractJobs to the DAX
`ADAG`	`addDAG(DAG dag)` Add a DAG job to the DAX
`ADAG`	`addDAGs(List<DAG> dags)` Add multiple DAG jobs to the DAX
`ADAG`	`addDAX(DAX dax)` Add a DAX job to the DAX
`ADAG`	`addDAXs(List<DAX> daxs)` Add multiple DAX jobs to the DAX
`ADAG`	`addDependency(AbstractJob parent, AbstractJob child)` Add a parent child dependency between two jobs,dax,dag
`ADAG`	`addDependency(AbstractJob parent, AbstractJob child, String label)` Add a parent child dependency with a dependency label
`ADAG`	`addDependency(String parent, String child)` Add a parent child dependency between two jobs,dax,dag
`ADAG`	`addDependency(String parent, String child, String label)` Add a parent child dependency with a dependency label
`ADAG`	`addExecutable(Executable executable)` Add Executable to the DAX
`ADAG`	`addExecutables(List<Executable> executables)` Add Multiple Executable objects to the DAX
`ADAG`	`addFile(File file)` Add a RC File object to the top of the DAX.
`ADAG`	`addFiles(List<File> files)` Add Files to the RC Section on top of the DAX
`ADAG`	`addInvoke(Invoke.WHEN when, String what)` Add a Notification for this Workflow
`ADAG`	`addInvoke(Invoke invoke)` Add a Notification for this Workflow
`ADAG`	`addInvokes(List<Invoke> invokes)` Add a List of Notifications for this Workflow
`ADAG`	`addJob(Job job)` Add Job to the DAX
`ADAG`	`addJobs(List<Job> jobs)` Add multiple Jobs to the DAX
`ADAG`	`addMetaData(String key, String value)` Adds metadata to the workflow
`ADAG`	`addNotification(Invoke.WHEN when, String what)` Add a Notification for this Workflow
`ADAG`	`addNotification(Invoke invoke)` Add a Notification for this Workflow
`ADAG`	`addNotifications(List<Invoke> invokes)` Add a List of Notifications for this Workflow
`ADAG`	`addTransformation(Transformation transformation)` Add Transformation to the DAX
`ADAG`	`addTransformations(List<Transformation> transformations)` Add Multiple Transformation to the DAX
`private boolean`	`containsAbstractJob(AbstractJob ajob)` Check if an abstractjob exists in the DAX
`private boolean`	`containsAbstractJobId(String ajobid)` Check if a jobid exists in the DAX
`boolean`	`containsDAG(DAG dag)` Check if a DAG job exists in the DAX
`boolean`	`containsDAGId(String dagid)` Check if a DAG job id exists in the DAX
`boolean`	`containsDAX(DAX dax)` Check if a DAX job exists in the DAX
`boolean`	`containsDAXId(String daxid)` Check if a DAX job id exists in the DAX
`boolean`	`containsExecutable(Executable executable)` Checks if a given executable exists in the DAX based Transformation Catalog
`boolean`	`containsJob(Job job)` Check if a job exists in the DAX
`boolean`	`containsJobId(String jobid)` Check if a jobid exists in the DAX
`boolean`	`containsTransformation(Transformation transformation)` Checks if a given Transformation exists in the DAX based Transformation Catalog
`private static ADAG`	`Diamond()`
`private AbstractJob`	`getAbstractJob(String ajobid)` Returns an abstract Job with id ajobid if present otherwise null.
`int`	`getCount()` Returns the total count of the dax collection.
`DAG`	`getDAG(String dagid)` Returns a DAG object with id dagid if present otherwise null.
`List<DAG>`	`getDAGs()` Get a list of all the DAG jobs.
`DAX`	`getDAX(String daxid)` Returns a DAX object with id daxid if present otherwise null.
`List<DAX>`	`getDAXs()` Get a list of all the DAX jobs.
`Set<Edge>`	`getEdges()` Returns a Set of all the Edge objects for the DAX.Returns empty if no dependencies.
`Set<Edge>`	`getEdges(String child)` Returns a list of Edge objects for a child job/dax/dag id.
`Set<Executable>`	`getExecutables()` Returns a set of Executable Objects stored as part of the inDAX Transformation Catalog;
`List<File>`	`getFiles()` Returns a list of File objects defined as the inDax Replica Catalog
`int`	`getIndex()`
`List<Invoke>`	`getInvoke()` Returns a list of Invoke objects associated with the workflow
`Job`	`getJob(String jobid)` Returns a Job object with id jobid if present otherwise null.
`List<Job>`	`getJobs()` Get a list of all the DAG jobs.
`String`	`getMetaData(String key)` Returns the metadata associated for a key if exists, else null
`String`	`getName()` Return the name/label of the dax
`List<Invoke>`	`getNotification()` Returns a list of Invoke objects associated with the workflow.
`private Map<String,String>`	`getPegasusVendorExtensions()` Returns pegasus vendor extensions that we encode in each workflow
`Set<Transformation>`	`getTransformations()` Returns a set of Transformation Objects (complex executables) stored in the DAX based Transformation Catalog
`static void`	`main(String[] args)` Create an example DIAMOND DAX
`void`	`toXML(edu.isi.pegasus.common.util.XMLWriter writer)` Generates a DAX representation.
`String`	`toYAML()` Generates the YAML representation of a workflow.
`void`	`writeTo(Writer writer, ADAG.FORMAT format)` Generate a DAX File out of this object;
`void`	`writeToFile(String daxfile)` Generate a DAX File out of this object in YAML format.
`void`	`writeToFile(String daxfile, ADAG.FORMAT format)` Generate a DAX File out of this object;
`void`	`writeToSTDOUT()` Convenience function to write out the generated DAX to stdout in YAML format
`void`	`writeToSTDOUT(ADAG.FORMAT format)` Convenience function to write out the generated DAX to stdout
`void`	`writeToWriter(Writer writer, boolean close)` Deprecated.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - SCHEMA_NAMESPACE
```
public static final String SCHEMA_NAMESPACE
```
    The "official" namespace URI of the site catalog schema.
    
    See Also:
    
    Constant Field Values
  - SCHEMA_NAMESPACE_XSI
```
public static final String SCHEMA_NAMESPACE_XSI
```
    XSI SCHEMA NAMESPACE
    
    See Also:
    
    Constant Field Values
  - SCHEMA_LOCATION
```
public static final String SCHEMA_LOCATION
```
    The "not-so-official" location URL of the DAX schema definition.
    
    See Also:
    
    Constant Field Values
  - SCHEMA_VERSION
```
public static final String SCHEMA_VERSION
```
    The version to report.
    
    See Also:
    
    Constant Field Values
  - PEGASUS_VENDOR_EXTENSION_KEY
```
public static final String PEGASUS_VENDOR_EXTENSION_KEY
```
    See Also:
    
    Constant Field Values
  - DEFAULT_FORMAT
```
public static ADAG.FORMAT DEFAULT_FORMAT
```
    The default format to use for writing out the Abstract Workflow.
  - WF_API_KEY
```
private static final String WF_API_KEY
```
    The type of Abstract Workflow API generated
    
    See Also:
    
    Constant Field Values
  - mName
```
private String mName
```
    The Name / Label of the DAX
  - mIndex
```
private int mIndex
```
    The Index of the dax object. I out of N
  - mCount
```
private int mCount
```
    The Count of the number of dax objects : N
  - mJobs
```
private Map<String,AbstractJob> mJobs
```
    The List of Job,DAX and DAG objects
    
    See Also:
    
    DAG, DAX, Job, AbstractJob
  - mLJobs
```
private List<Job> mLJobs
```
  - mLDAGs
```
private List<DAG> mLDAGs
```
  - mLDAXs
```
private List<DAX> mLDAXs
```
  - mTransformations
```
private Set<Transformation> mTransformations
```
    The List of Transformation objects
    
    See Also:
    
    Transformation
  - mExecutables
```
private Set<Executable> mExecutables
```
    The list of Executable objects
    
    See Also:
    
    Executable
  - mFiles
```
private List<File> mFiles
```
    The list of edu.isi.pegasus.planner.dax.File objects
    
    See Also:
    
    File
  - mDependencies
```
private Map<String,Set<Edge>> mDependencies
```
    Map of Dependencies between Job,DAX,DAG objects. Map key is a string that holds the child element reference, the value is a List of Parent objects
    
    See Also:
    
    Edge
  - mInvokes
```
private List<Invoke> mInvokes
```
    List of Notification objects
  - mMetaDataAttributes
```
private Set<MetaData> mMetaDataAttributes
```
    The metadata attributes associated with the whole workflow.
  - mWriter
```
private edu.isi.pegasus.common.util.XMLWriter mWriter
```
    Handle the XML writer
  - mLogger
```
private edu.isi.pegasus.common.logging.LogManager mLogger
```
- Constructor Detail
  - ADAG
```
public ADAG(String name)
```
    The Simple constructor for the DAX object
    
    Parameters:
    
    name - DAX LABEL
  - ADAG
```
public ADAG(String name,
            int index,
            int count)
```
    DAX Constructor
    
    Parameters:
    
    name - DAX Label
    
    index - Index of DAX out of N DAX's
    
    count - Number of DAXS in a group
- Method Detail
  - getPegasusVendorExtensions
```
private Map<String,String> getPegasusVendorExtensions()
```
    Returns pegasus vendor extensions that we encode in each workflow
    
    Returns:
    
    Map
  - getName
```
public String getName()
```
    Return the name/label of the dax
    
    Returns:
    
    the name
  - getIndex
```
public int getIndex()
```
  - getCount
```
public int getCount()
```
    Returns the total count of the dax collection. (legacy)
    
    Returns:
    
    int
  - addInvoke
```
public ADAG addInvoke(Invoke.WHEN when,
                      String what)
```
    Add a Notification for this Workflow
    
    Parameters:
    
    when - when to do the notification
    
    what - executable and arguments to invoke
    
    Returns:
    
    ADAG
  - addNotification
```
public ADAG addNotification(Invoke.WHEN when,
                            String what)
```
    Add a Notification for this Workflow
    
    Parameters:
    
    when - when to do the notification
    
    what - executable and arguments to invoke
    
    Returns:
    
    ADAG
  - addInvoke
```
public ADAG addInvoke(Invoke invoke)
```
    Add a Notification for this Workflow
    
    Parameters:
    
    invoke - the invoke object
    
    Returns:
    
    ADAG
  - addNotification
```
public ADAG addNotification(Invoke invoke)
```
    Add a Notification for this Workflow
    
    Parameters:
    
    invoke - the invoke object
    
    Returns:
    
    ADAG
  - addInvokes
```
public ADAG addInvokes(List<Invoke> invokes)
```
    Add a List of Notifications for this Workflow
    
    Parameters:
    
    invokes - List of Invoke objects
    
    Returns:
    
    ADAG
  - addNotifications
```
public ADAG addNotifications(List<Invoke> invokes)
```
    Add a List of Notifications for this Workflow
    
    Parameters:
    
    invokes - List of Invoke objects
    
    Returns:
    
    ADAG
  - getInvoke
```
public List<Invoke> getInvoke()
```
    Returns a list of Invoke objects associated with the workflow
    
    Returns:
    
    list of notifications
  - getNotification
```
public List<Invoke> getNotification()
```
    Returns a list of Invoke objects associated with the workflow. Same as getInvoke()
    
    Returns:
    
    list of notifications
  - addMetaData
```
public ADAG addMetaData(String key,
                        String value)
```
    Adds metadata to the workflow
    
    Parameters:
    
    key - key name for metadata
    
    value - value
    
    Returns:
    
    ADAG
  - getMetaData
```
public String getMetaData(String key)
```
    Returns the metadata associated for a key if exists, else null
    
    Parameters:
    
    key - the key
    
    Returns:
    
    String
  - addFile
```
public ADAG addFile(File file)
```
    Add a RC File object to the top of the DAX.
    
    Parameters:
    
    file - File object to be added to the RC section
    
    Returns:
    
    ADAG
    
    See Also:
    
    File
  - addFiles
```
public ADAG addFiles(List<File> files)
```
    Add Files to the RC Section on top of the DAX
    
    Parameters:
    
    files - List of File objects to be added to the RC Section
    
    Returns:
    
    ADAG
    
    See Also:
    
    File
  - getFiles
```
public List<File> getFiles()
```
    Returns a list of File objects defined as the inDax Replica Catalog
    
    Returns:
    
    List of Files
  - addExecutable
```
public ADAG addExecutable(Executable executable)
```
    Add Executable to the DAX
    
    Parameters:
    
    executable - Executable to be added
    
    Returns:
    
    ADAG
    
    See Also:
    
    Executable
  - addExecutables
```
public ADAG addExecutables(List<Executable> executables)
```
    Add Multiple Executable objects to the DAX
    
    Parameters:
    
    executables - List of Executable objects to be added
    
    Returns:
    
    ADAG
    
    See Also:
    
    Executable
  - getExecutables
```
public Set<Executable> getExecutables()
```
    Returns a set of Executable Objects stored as part of the inDAX Transformation Catalog;
    
    Returns:
    
    Set of executables stored in TC
  - containsExecutable
```
public boolean containsExecutable(Executable executable)
```
    Checks if a given executable exists in the DAX based Transformation Catalog
    
    Parameters:
    
    executable - the executable
    
    Returns:
    
    boolean
  - addTransformation
```
public ADAG addTransformation(Transformation transformation)
```
    Add Transformation to the DAX
    
    Parameters:
    
    transformation - Transformation object to be added
    
    Returns:
    
    ADAG
    
    See Also:
    
    Transformation
  - addTransformations
```
public ADAG addTransformations(List<Transformation> transformations)
```
    Add Multiple Transformation to the DAX
    
    Parameters:
    
    transformations - List of Transformation objects
    
    Returns:
    
    ADAG
    
    See Also:
    
    Transformation
  - containsTransformation
```
public boolean containsTransformation(Transformation transformation)
```
    Checks if a given Transformation exists in the DAX based Transformation Catalog
    
    Parameters:
    
    transformation - Transformation
    
    Returns:
    
    boolean
  - getTransformations
```
public Set<Transformation> getTransformations()
```
    Returns a set of Transformation Objects (complex executables) stored in the DAX based Transformation Catalog
    
    Returns:
    
    Set of Transformation stored in the DAX
  - addAbstractJob
```
private ADAG addAbstractJob(AbstractJob ajob)
```
    Add AbstractJob to the DAX
    
    Parameters:
    
    ajob - AbstractJob
    
    Returns:
    
    ADAG
    
    See Also:
    
    Job, DAG, DAX, AbstractJob
  - addAbstractJobs
```
private ADAG addAbstractJobs(List<AbstractJob> ajobs)
```
    Add AbstractJobs to the DAX
    
    Parameters:
    
    ajobs - AbstractJob
    
    Returns:
    
    ADAG
    
    See Also:
    
    Job, DAG, DAX, AbstractJob
  - getAbstractJob
```
private AbstractJob getAbstractJob(String ajobid)
```
    Returns an abstract Job with id ajobid if present otherwise null.
    
    Parameters:
    
    ajobid - abstract job id
    
    Returns:
    
    AbstractJob
  - containsAbstractJob
```
private boolean containsAbstractJob(AbstractJob ajob)
```
    Check if an abstractjob exists in the DAX
    
    Parameters:
    
    ajob - the abstract job
    
    Returns:
    
    boolean
  - containsAbstractJobId
```
private boolean containsAbstractJobId(String ajobid)
```
    Check if a jobid exists in the DAX
    
    Parameters:
    
    ajobid - the job id
    
    Returns:
    
    boolean
  - addJob
```
public ADAG addJob(Job job)
```
    Add Job to the DAX
    
    Parameters:
    
    job - the job
    
    Returns:
    
    ADAG
    
    See Also:
    
    Job, AbstractJob
  - addJobs
```
public ADAG addJobs(List<Job> jobs)
```
    Add multiple Jobs to the DAX
    
    Parameters:
    
    jobs - List of jobs to add
    
    Returns:
    
    ADAG
    
    See Also:
    
    Job, AbstractJob
  - containsJob
```
public boolean containsJob(Job job)
```
    Check if a job exists in the DAX
    
    Parameters:
    
    job - the job to check
    
    Returns:
    
    boolean
  - containsJobId
```
public boolean containsJobId(String jobid)
```
    Check if a jobid exists in the DAX
    
    Parameters:
    
    jobid - the job id
    
    Returns:
    
    boolean
  - getJob
```
public Job getJob(String jobid)
```
    Returns a Job object with id jobid if present otherwise null.
    
    Parameters:
    
    jobid - the job id
    
    Returns:
    
    the Job
  - getJobs
```
public List<Job> getJobs()
```
    Get a list of all the DAG jobs.
    
    Returns:
    
    List of Job
  - getDAXs
```
public List<DAX> getDAXs()
```
    Get a list of all the DAX jobs.
    
    Returns:
    
    List of DAX jobs
  - getDAX
```
public DAX getDAX(String daxid)
```
    Returns a DAX object with id daxid if present otherwise null.
    
    Parameters:
    
    daxid - the dax id
    
    Returns:
    
    DAX
  - getDAGs
```
public List<DAG> getDAGs()
```
    Get a list of all the DAG jobs.
    
    Returns:
    
    List of DAG objects
  - getDAG
```
public DAG getDAG(String dagid)
```
    Returns a DAG object with id dagid if present otherwise null.
    
    Parameters:
    
    dagid - the dagid
    
    Returns:
    
    the DAG
  - addDAG
```
public ADAG addDAG(DAG dag)
```
    Add a DAG job to the DAX
    
    Parameters:
    
    dag - the DAG to be added
    
    Returns:
    
    ADAG
    
    See Also:
    
    DAG, AbstractJob
  - addDAGs
```
public ADAG addDAGs(List<DAG> dags)
```
    Add multiple DAG jobs to the DAX
    
    Parameters:
    
    dags - List of DAG jobs to be added
    
    Returns:
    
    ADAG
    
    See Also:
    
    DAG, AbstractJob
  - containsDAG
```
public boolean containsDAG(DAG dag)
```
    Check if a DAG job exists in the DAX
    
    Parameters:
    
    dag - the dag
    
    Returns:
    
    boolean
  - containsDAGId
```
public boolean containsDAGId(String dagid)
```
    Check if a DAG job id exists in the DAX
    
    Parameters:
    
    dagid - the dagid
    
    Returns:
    
    boolean
  - addDAX
```
public ADAG addDAX(DAX dax)
```
    Add a DAX job to the DAX
    
    Parameters:
    
    dax - DAX to be added
    
    Returns:
    
    ADAG
    
    See Also:
    
    DAX, AbstractJob
  - addDAXs
```
public ADAG addDAXs(List<DAX> daxs)
```
    Add multiple DAX jobs to the DAX
    
    Parameters:
    
    daxs - LIST of DAX jobs to be added
    
    Returns:
    
    ADAG
    
    See Also:
    
    DAX, AbstractJob
  - containsDAX
```
public boolean containsDAX(DAX dax)
```
    Check if a DAX job exists in the DAX
    
    Parameters:
    
    dax - the dax
    
    Returns:
    
    boolean
  - containsDAXId
```
public boolean containsDAXId(String daxid)
```
    Check if a DAX job id exists in the DAX
    
    Parameters:
    
    daxid - the dax id
    
    Returns:
    
    boolean
  - addDependency
```
public ADAG addDependency(String parent,
                          String child)
```
    Add a parent child dependency between two jobs,dax,dag
    
    Parameters:
    
    parent - String job,dax,dag id
    
    child - String job,dax,dag,id
    
    Returns:
    
    ADAG
  - addDependency
```
public ADAG addDependency(AbstractJob parent,
                          AbstractJob child)
```
    Add a parent child dependency between two jobs,dax,dag
    
    Parameters:
    
    parent - Job|DAX|DAG object
    
    child - Job|DAX|DAG object
    
    Returns:
    
    ADAG
  - addDependency
```
public ADAG addDependency(String parent,
                          String child,
                          String label)
```
    Add a parent child dependency with a dependency label
    
    Parameters:
    
    parent - String job,dax,dag id
    
    child - String job,dax,dag id
    
    label - String dependency label
    
    Returns:
    
    ADAG
  - getEdges
```
public Set<Edge> getEdges(String child)
```
    Returns a list of Edge objects for a child job/dax/dag id. Returns an empty set if the child does not have any parents Returns null if the child is not a valid job/dax/dag id
    
    Parameters:
    
    child - the child
    
    Returns:
    
    Set of Edges
  - getEdges
```
public Set<Edge> getEdges()
```
    Returns a Set of all the Edge objects for the DAX.Returns empty if no dependencies.
    
    Returns:
    
    set of all edges
  - addDependency
```
public ADAG addDependency(AbstractJob parent,
                          AbstractJob child,
                          String label)
```
    Add a parent child dependency with a dependency label
    
    Parameters:
    
    parent - Job|DAX|DAG object
    
    child - Job|DAX|DAG object
    
    label - String label for annotation
    
    Returns:
    
    ADAG
  - writeToFile
```
public void writeToFile(String daxfile)
```
    Generate a DAX File out of this object in YAML format.
    
    Parameters:
    
    daxfile - The file to write the DAX to
  - writeToFile
```
public void writeToFile(String daxfile,
                        ADAG.FORMAT format)
```
    Generate a DAX File out of this object;
    
    Parameters:
    
    daxfile - The file to write the DAX to
    
    format - how should the file be formatted
  - writeTo
```
public void writeTo(Writer writer,
                    ADAG.FORMAT format)
```
    Generate a DAX File out of this object;
    
    Parameters:
    
    writer - the writer to the dax file
    
    format - how should the file be formatted
  - writeToSTDOUT
```
public void writeToSTDOUT()
```
    Convenience function to write out the generated DAX to stdout in YAML format
  - writeToSTDOUT
```
public void writeToSTDOUT(ADAG.FORMAT format)
```
    Convenience function to write out the generated DAX to stdout
    
    Parameters:
    
    format - how should the file be formatted
  - writeToWriter
```
public void writeToWriter(Writer writer,
                          boolean close)
```
    Deprecated.
    
    Generate a DAX representation and pipe it into the Writer
    
    Parameters:
    
    writer - A Writer object
    
    close - Whether writer should be closed on return.
  - toYAML
```
public String toYAML()
```
    Generates the YAML representation of a workflow.
    
    Returns:
    
    YAML representation of this ADAG as a String
  - toXML
```
public void toXML(edu.isi.pegasus.common.util.XMLWriter writer)
```
    Generates a DAX representation.
    
    Parameters:
    
    writer - the xml writer
  - main
```
public static void main(String[] args)
```
    Create an example DIAMOND DAX
    
    Parameters:
    
    args - main args
  - Diamond
```
private static ADAG Diamond()
```

Class ADAG

Nested Class Summary

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

SCHEMA_NAMESPACE

SCHEMA_NAMESPACE_XSI

SCHEMA_LOCATION

SCHEMA_VERSION

PEGASUS_VENDOR_EXTENSION_KEY

DEFAULT_FORMAT

WF_API_KEY

mName

mIndex

mCount

mJobs

mLJobs

mLDAGs

mLDAXs

mTransformations

mExecutables

mFiles

mDependencies

mInvokes

mMetaDataAttributes

mWriter

mLogger

Constructor Detail

ADAG

ADAG

Method Detail

getPegasusVendorExtensions

getName

getIndex

getCount

addInvoke

addNotification

addInvoke

addNotification

addInvokes

addNotifications

getInvoke

getNotification

addMetaData

getMetaData

addFile

addFiles

getFiles

addExecutable

addExecutables

getExecutables

containsExecutable

addTransformation

addTransformations

containsTransformation

getTransformations

addAbstractJob

addAbstractJobs

getAbstractJob

containsAbstractJob

containsAbstractJobId

addJob

addJobs

containsJob

containsJobId

getJob

getJobs

getDAXs

getDAX

getDAGs

getDAG

addDAG

addDAGs

containsDAG

containsDAGId

addDAX

addDAXs

containsDAX