Java Doc for InvocationRecord.java in  » Workflow-Engines » pegasus-2.1.0 » org » griphyn » vdl » invocation » 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.vdl.invocation 
Source Cross Reference  Class Diagram Java Document (Java Doc) 


org.griphyn.vdl.invocation.Invocation
   org.griphyn.vdl.invocation.InvocationRecord

InvocationRecord
public class InvocationRecord extends Invocation (Code)
This class is the container for an invocation record. The record itself contains information about the job or jobs that ran, the total usage, and information about central files that were used.
author:
   Jens-S. Vöckler
author:
   Yong Zhao
version:
   $Revision: 118 $


Field Summary
final public static  StringSCHEMA_LOCATION
     The "not-so-official" location URL of the invocation record definition.
final public static  StringSCHEMA_NAMESPACE
     The "official" namespace URI of the invocation record schema.

Constructor Summary
public  InvocationRecord()
     Default c'tor: Construct a hollow shell and allow further information to be added later.

Method Summary
public  voidaddJob(Job job)
     Accessor: Appends a job to the list of jobs.
public  voidaddJob(int index, Job job)
     Accessor: Inserts a Job into a specific position of the job list.
public  voidaddStatCall(StatCall stat)
     Accessor: Appends a stat to the list of stats.
public  voidaddStatCall(int index, StatCall stat)
     Accessor: Inserts a StatCall into a specific position of the stat list.
public  ArchitecturegetArchitecture()
    
public  StringgetDerivation()
    
public  doublegetDuration()
    
public  EnvironmentgetEnvironment()
    
public  intgetGID()
    
public  StringgetGroup()
    
public  InetAddressgetHostAddress()
    
public  StringgetHostname()
    
public  JobgetJob(int index)
     Accessor: Obtains a job at a certain position in the job list.
public  intgetJobCount()
     Accessor: Obtains the size of the job list.
public  java.util.ListgetJobList()
     Accessor: Gets an array of all values that constitute the current content.
public  intgetPID()
    
public  StringgetResource()
    
public  DategetStart()
    
public  StatCallgetStatCall(int index)
     Accessor: Obtains a stat at a certain position in the stat list.
public  intgetStatCount()
     Accessor: Obtains the size of the stat list.
public  java.util.ListgetStatList()
     Accessor: Gets an array of all values that constitute the current content.
public  StringgetTransformation()
    
public  intgetUID()
    
public  intgetUMask()
    
public  UsagegetUsage()
    
public  StringgetUser()
    
public  StringgetVersion()
    
public  StringgetWorkflowLabel()
    
public  DategetWorkflowTimestamp()
    
public  WorkingDirgetWorkingDirectory()
    
public  IteratoriterateJob()
     Accessor: Enumerates the internal values that constitute the content of the job list.
public  IteratoriterateStatCall()
     Accessor: Enumerates the internal values that constitute the content of the stat list.
public  ListIteratorlistIterateJob()
     Accessor: Enumerates the internal values that constitute the content of the job list.
public  ListIteratorlistIterateStatCall()
     Accessor: Enumerates the internal values that constitute the content of the stat list.
public  voidremoveAllJob()
     Accessor: Removes all values from the job list.
public  voidremoveAllStatCall()
     Accessor: Removes all values from the stat list.
public  JobremoveJob(int index)
     Accessor: Removes a specific job from the job list.
Parameters:
  index - is the position at which an element is to be removed.
public  StatCallremoveStatCall(int index)
     Accessor: Removes a specific stat from the stat list.
Parameters:
  index - is the position at which an element is to be removed.
public  voidsetArchitecture(Architecture uname)
     Accessor.
public  voidsetDerivation(String derivation)
     Accessor.
public  voidsetDuration(double duration)
     Accessor.
public  voidsetEnvironment(Environment environment)
     Accessor.
public  voidsetGID(int gid)
     Accessor.
public  voidsetGroup(String group)
     Accessor.
public  voidsetHostAddress(InetAddress hostaddr)
     Accessor.
public  voidsetHostname(String hostname)
     Accessor.
public  voidsetJob(int index, Job job)
     Accessor: Overwrites a job at a certain position.
public  voidsetJob(Collection jobs)
     Accessor: Overwrites internal list with an external list representing jobs.
public  voidsetPID(int pid)
     Accessor.
public  voidsetResource(String resource)
     Accessor.
public  voidsetStart(Date start)
     Accessor.
public  voidsetStatCall(int index, StatCall stat)
     Accessor: Overwrites a stat at a certain position.
public  voidsetStatCall(Collection stats)
     Accessor: Overwrites internal list with an external list representing stats.
public  voidsetTransformation(String transformation)
     Accessor.
public  voidsetUID(int uid)
     Accessor.
public  voidsetUMask(int umask)
     Accessor.
public  voidsetUsage(Usage usage)
     Accessor.
public  voidsetUser(String user)
     Accessor.
public  voidsetVersion(String version)
     Accessor.
public  voidsetWorkflowLabel(String label)
     Accessor.
public  voidsetWorkflowTimestamp(Date stamp)
     Accessor.
public  voidsetWorkingDirectory(String cwd)
     Accessor.
public  voidsetWorkingDirectory(WorkingDir cwd)
     Accessor.
public  voidtoString(Writer stream)
     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.
public  voidtoXML(Writer stream, String indent, String namespace)
     Dump the state of the current element as XML output.
public  voidwriteXMLHeader(Writer stream, String indent, String namespace)
     Writes the header of the XML output.

Field Detail
SCHEMA_LOCATION
final public static String SCHEMA_LOCATION(Code)
The "not-so-official" location URL of the invocation record definition.



SCHEMA_NAMESPACE
final public static String SCHEMA_NAMESPACE(Code)
The "official" namespace URI of the invocation record schema.




Constructor Detail
InvocationRecord
public InvocationRecord()(Code)
Default c'tor: Construct a hollow shell and allow further information to be added later.




Method Detail
addJob
public void addJob(Job job)(Code)
Accessor: Appends a job to the list of jobs.
Parameters:
  job - is the job to append to the list.



addJob
public void addJob(int index, Job job)(Code)
Accessor: Inserts a Job into a specific position of the job list.
Parameters:
  index - is the position to insert the item into
Parameters:
  job - is the job to insert into the list.



addStatCall
public void addStatCall(StatCall stat)(Code)
Accessor: Appends a stat to the list of stats.
Parameters:
  stat - is the stat to append to the list.



addStatCall
public void addStatCall(int index, StatCall stat)(Code)
Accessor: Inserts a StatCall into a specific position of the stat list.
Parameters:
  index - is the position to insert the item into
Parameters:
  stat - is the stat to insert into the list.



getArchitecture
public Architecture getArchitecture()(Code)
Accessor
See Also:   InvocationRecord.setArchitecture(Architecture)



getDerivation
public String getDerivation()(Code)
Accessor
See Also:   InvocationRecord.setDerivation(String)



getDuration
public double getDuration()(Code)
Accessor
See Also:   InvocationRecord.setDuration(double)



getEnvironment
public Environment getEnvironment()(Code)
Accessor
See Also:   InvocationRecord.setEnvironment(Environment)



getGID
public int getGID()(Code)
Accessor
See Also:   InvocationRecord.setGID(int)



getGroup
public String getGroup()(Code)
Accessor
See Also:   InvocationRecord.setGroup(String)



getHostAddress
public InetAddress getHostAddress()(Code)
Accessor
See Also:   InvocationRecord.setHostAddress(InetAddress)



getHostname
public String getHostname()(Code)
Accessor
See Also:   InvocationRecord.setHostname(String)



getJob
public Job getJob(int index) throws IndexOutOfBoundsException(Code)
Accessor: Obtains a job at a certain position in the job list.
Parameters:
  index - is the position in the list to obtain a job from the job at that position.
throws:
  IndexOutOfBoundsException - if the index points to an elementin the list that does not contain any elments.



getJobCount
public int getJobCount()(Code)
Accessor: Obtains the size of the job list. number of elements that an external array needs to be sized to.



getJobList
public java.util.List getJobList()(Code)
Accessor: Gets an array of all values that constitute the current content. This list is read-only. a list of jobs.



getPID
public int getPID()(Code)
Accessor
See Also:   InvocationRecord.setPID(int)



getResource
public String getResource()(Code)
Accessor
See Also:   InvocationRecord.setResource(String)



getStart
public Date getStart()(Code)
Accessor
See Also:   InvocationRecord.setStart(Date)



getStatCall
public StatCall getStatCall(int index) throws IndexOutOfBoundsException(Code)
Accessor: Obtains a stat at a certain position in the stat list.
Parameters:
  index - is the position in the list to obtain a stat from the stat at that position.
throws:
  IndexOutOfBoundsException - if the index points to an elementin the list that does not contain any elments.



getStatCount
public int getStatCount()(Code)
Accessor: Obtains the size of the stat list. number of elements that an external array needs to be sized to.



getStatList
public java.util.List getStatList()(Code)
Accessor: Gets an array of all values that constitute the current content. This list is read-only. a list of stats.



getTransformation
public String getTransformation()(Code)
Accessor
See Also:   InvocationRecord.setTransformation(String)



getUID
public int getUID()(Code)
Accessor
See Also:   InvocationRecord.setUID(int)



getUMask
public int getUMask()(Code)
Accessor
See Also:   InvocationRecord.setUMask(int)



getUsage
public Usage getUsage()(Code)
Accessor
See Also:   InvocationRecord.setUsage(Usage)



getUser
public String getUser()(Code)
Accessor
See Also:   InvocationRecord.setUser(String)



getVersion
public String getVersion()(Code)
Accessor
See Also:   InvocationRecord.setVersion(String)



getWorkflowLabel
public String getWorkflowLabel()(Code)
Accessor
See Also:   InvocationRecord.setWorkflowLabel(String)



getWorkflowTimestamp
public Date getWorkflowTimestamp()(Code)
Accessor
See Also:   InvocationRecord.setWorkflowTimestamp(Date)



getWorkingDirectory
public WorkingDir getWorkingDirectory()(Code)
Accessor
See Also:   InvocationRecord.setWorkingDirectory(WorkingDir)
See Also:   InvocationRecord.setWorkingDirectory(String)



iterateJob
public Iterator iterateJob()(Code)
Accessor: Enumerates the internal values that constitute the content of the job list. an iterator to walk the list with.



iterateStatCall
public Iterator iterateStatCall()(Code)
Accessor: Enumerates the internal values that constitute the content of the stat list. an iterator to walk the list with.



listIterateJob
public ListIterator listIterateJob()(Code)
Accessor: Enumerates the internal values that constitute the content of the job list. a list iterator to walk the list with.



listIterateStatCall
public ListIterator listIterateStatCall()(Code)
Accessor: Enumerates the internal values that constitute the content of the stat list. a list iterator to walk the list with.



removeAllJob
public void removeAllJob()(Code)
Accessor: Removes all values from the job list.



removeAllStatCall
public void removeAllStatCall()(Code)
Accessor: Removes all values from the stat list.



removeJob
public Job removeJob(int index)(Code)
Accessor: Removes a specific job from the job list.
Parameters:
  index - is the position at which an element is to be removed. the job that was removed.



removeStatCall
public StatCall removeStatCall(int index)(Code)
Accessor: Removes a specific stat from the stat list.
Parameters:
  index - is the position at which an element is to be removed. the stat that was removed.



setArchitecture
public void setArchitecture(Architecture uname)(Code)
Accessor.
Parameters:
  uname -
See Also:   InvocationRecord.getArchitecture()



setDerivation
public void setDerivation(String derivation)(Code)
Accessor.
Parameters:
  derivation -
See Also:   InvocationRecord.getDerivation()



setDuration
public void setDuration(double duration)(Code)
Accessor.
Parameters:
  duration -
See Also:   InvocationRecord.getDuration()



setEnvironment
public void setEnvironment(Environment environment)(Code)
Accessor.
Parameters:
  environment -
See Also:   InvocationRecord.getEnvironment()



setGID
public void setGID(int gid)(Code)
Accessor.
Parameters:
  gid -
See Also:   InvocationRecord.getGID()



setGroup
public void setGroup(String group)(Code)
Accessor.
Parameters:
  group -
See Also:   InvocationRecord.getGroup()



setHostAddress
public void setHostAddress(InetAddress hostaddr)(Code)
Accessor.
Parameters:
  hostaddr -
See Also:   InvocationRecord.getHostAddress()



setHostname
public void setHostname(String hostname)(Code)
Accessor.
Parameters:
  hostname -
See Also:   InvocationRecord.getHostname()



setJob
public void setJob(int index, Job job) throws IndexOutOfBoundsException(Code)
Accessor: Overwrites a job at a certain position.
Parameters:
  index - position to overwrite an elment in.
Parameters:
  job - is the Job to replace with.
throws:
  IndexOutOfBoundsException - if the position pointed to is invalid.



setJob
public void setJob(Collection jobs)(Code)
Accessor: Overwrites internal list with an external list representing jobs.
Parameters:
  jobs - is the external list of job to overwrite with.



setPID
public void setPID(int pid)(Code)
Accessor.
Parameters:
  pid -
See Also:   InvocationRecord.getPID()



setResource
public void setResource(String resource)(Code)
Accessor.
Parameters:
  resource -
See Also:   InvocationRecord.getResource()



setStart
public void setStart(Date start)(Code)
Accessor.
Parameters:
  start -
See Also:   InvocationRecord.getStart()



setStatCall
public void setStatCall(int index, StatCall stat) throws IndexOutOfBoundsException(Code)
Accessor: Overwrites a stat at a certain position.
Parameters:
  index - position to overwrite an elment in.
Parameters:
  stat - is the StatCall to replace with.
throws:
  IndexOutOfBoundsException - if the position pointed to is invalid.



setStatCall
public void setStatCall(Collection stats)(Code)
Accessor: Overwrites internal list with an external list representing stats.
Parameters:
  stats - is the external list of stat to overwrite with.



setTransformation
public void setTransformation(String transformation)(Code)
Accessor.
Parameters:
  transformation -
See Also:   InvocationRecord.getTransformation()



setUID
public void setUID(int uid)(Code)
Accessor.
Parameters:
  uid -
See Also:   InvocationRecord.getUID()



setUMask
public void setUMask(int umask)(Code)
Accessor.
Parameters:
  m_umask -
See Also:   InvocationRecord.getUMask()



setUsage
public void setUsage(Usage usage)(Code)
Accessor.
Parameters:
  usage -
See Also:   InvocationRecord.getUsage()



setUser
public void setUser(String user)(Code)
Accessor.
Parameters:
  user -
See Also:   InvocationRecord.getUser()



setVersion
public void setVersion(String version)(Code)
Accessor.
Parameters:
  version -
See Also:   InvocationRecord.getVersion()



setWorkflowLabel
public void setWorkflowLabel(String label)(Code)
Accessor.
Parameters:
  label -
See Also:   InvocationRecord.getWorkflowLabel()



setWorkflowTimestamp
public void setWorkflowTimestamp(Date stamp)(Code)
Accessor.
Parameters:
  stamp -
See Also:   InvocationRecord.getResource()



setWorkingDirectory
public void setWorkingDirectory(String cwd)(Code)
Accessor.
Parameters:
  cwd -
See Also:   InvocationRecord.getWorkingDirectory()
See Also:   InvocationRecord.setWorkingDirectory(WorkingDir)



setWorkingDirectory
public void setWorkingDirectory(WorkingDir cwd)(Code)
Accessor.
Parameters:
  cwd -
See Also:   InvocationRecord.getWorkingDirectory()
See Also:   InvocationRecord.setWorkingDirectory(String)



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.



writeXMLHeader
public void writeXMLHeader(Writer stream, String indent, String namespace) throws IOException(Code)
Writes the header of the XML output. The output contains the special strings to start an XML document, some comments, and the root element. The latter points to the XML schema via XML Instances.
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.




www.java2java.com | Contact Us
Copyright 2009 - 12 Demo Source and Support. All rights reserved.
All other trademarks are property of their respective owners.