| org.griphyn.vdl.dax.DAX org.griphyn.vdl.dax.Child
Child | public class Child extends DAX implements Cloneable(Code) | | This class captures the parent-child relationship between any two
nodes in a directed acyclic graph. For ease of external
transportation, the graph is flattened into this two-level form.
Please note that this presentation is slightly less powerful than the
true DAGMan form, because for each child, there can be multiple
parents, but multiple children cannot be grouped.
author: Jens-S. Vöckler author: Yong Zhao version: $Revision: 50 $ |
Constructor Summary | |
public | Child() | public | Child(String child) Ctor: Constructs a child node. | public | Child(Job child) Ctor: Constructs a child node. | public | Child(String child, String parent) Convenience ctor: Constructs a child node with one parent. | public | Child(Job child, Job parent) Convenience ctor: Constructs a child node with one parent. |
Method Summary | |
public void | addParent(String parent) Accessor: Adds a parent job id as dependency to the list of parents. | public void | addParent(Job parent) Accessor: Adds a parent job id as dependency to the list of parents. | public Object | clone() Creates and returns a copy of this object. | public String | getChild() Accessor: Obtains the child identifier. | public boolean | getParent(String name) Accessor: Obtains a parent, iff it is in the bag.
Parameters: name - is the parent id to look up. | public int | getParentCount() Accessor: Obtains the count of parental dependencies. | public Iterator | iterateParent() Accessor: Provides an iterator for the parent list. | public void | removeAllParent() Accessor: Removes all parental dependencies. | public boolean | removeParent(String name) Accessor: Removes a parent name from the bag.
Parameters: name - is the name of the parent ID to remove. | public void | setChild(String id) Accessor: Sets the identifier for this dependency child. | public void | setChild(Job job) Accessor: Sets the identifier for this dependency child. | public void | toString(Writer stream) Converts the active state into something meant for human consumption.
The method will be called when recursively traversing the instance
tree. | public void | toXML(Writer stream, String indent, String namespace) Dump the state of the current element as XML output. | public Child | updateChild(java.util.Map mapping) Updates the identifiers for child and parents from a mapping.
Parameters: mapping - is the mapping between old and new identifier a new instance with mapped identifiers. |
Child | public Child()(Code) | | Default ctor: Constructs a child node w/o any parents
|
Child | public Child(String child)(Code) | | Ctor: Constructs a child node.
Parameters: child - is the job ID of the child node. |
Child | public Child(Job child)(Code) | | Ctor: Constructs a child node.
Parameters: child - is the job reference of the child node. |
Child | public Child(String child, String parent)(Code) | | Convenience ctor: Constructs a child node with one parent.
|
Child | public Child(Job child, Job parent)(Code) | | Convenience ctor: Constructs a child node with one parent.
|
addParent | public void addParent(String parent)(Code) | | Accessor: Adds a parent job id as dependency to the list of parents.
Parameters: parent - is the parent id to add, not the parent reference. See Also: Job |
addParent | public void addParent(Job parent)(Code) | | Accessor: Adds a parent job id as dependency to the list of parents.
Parameters: parent - is the parent reference to add See Also: Job |
clone | public Object clone()(Code) | | Creates and returns a copy of this object.
a new instance. |
getChild | public String getChild()(Code) | | Accessor: Obtains the child identifier.
the name of the current child, or null , ifthe element is hollow. See Also: Child.setChild(String) |
getParent | public boolean getParent(String name)(Code) | | Accessor: Obtains a parent, iff it is in the bag.
Parameters: name - is the parent id to look up. true if the parent is know, false otherwise. |
getParentCount | public int getParentCount()(Code) | | Accessor: Obtains the count of parental dependencies.
the number of parents. See Also: Job |
iterateParent | public Iterator iterateParent()(Code) | | Accessor: Provides an iterator for the parent list.
the iterator for all dependencies. See Also: Job |
removeAllParent | public void removeAllParent()(Code) | | Accessor: Removes all parental dependencies.
See Also: Job |
removeParent | public boolean removeParent(String name)(Code) | | Accessor: Removes a parent name from the bag.
Parameters: name - is the name of the parent ID to remove. true, if the parent was removed, false, if it was not present. See Also: Job See Also: java.util.HashSet.remove(Object) See Also: |
setChild | public void setChild(String id)(Code) | | Accessor: Sets the identifier for this dependency child.
Parameters: id - is the job identifier. See Also: Child.getChild() |
setChild | public void setChild(Job job)(Code) | | Accessor: Sets the identifier for this dependency child.
Parameters: job - is a job reference. See Also: Child.getChild() |
toString | public void toString(Writer stream) throws IOException(Code) | | Converts the active state into something meant for human consumption.
The method will be called when recursively traversing the instance
tree.
Parameters: stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output. |
toXML | public void toXML(Writer stream, String indent, String namespace) throws IOException(Code) | | Dump the state of the current element as XML output. This function
traverses all sibling classes as necessary, and converts the data
into pretty-printed XML output. The stream interface should be able
to handle large output efficiently.
Parameters: stream - is a stream opened and ready for writing. This can alsobe a string stream for efficient output. Parameters: indent - is a String of spaces used for prettyprinting. The initial amount of spaces should be an empty string.The parameter is used internally for the recursive traversal. Parameters: namespace - is the XML schema namespace prefix. If neitherempty nor null, each element will be prefixed with this prefix,and the root element will map the XML namespace. exception: IOException - if something fishy happens to the stream. |
updateChild | public Child updateChild(java.util.Map mapping)(Code) | | Updates the identifiers for child and parents from a mapping.
Parameters: mapping - is the mapping between old and new identifier a new instance with mapped identifiers. If none of theold identifiers in mapping are in the child, the result is thesame as a Child.clone(). |
|
|