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


org.griphyn.vdl.classes.VDL
   org.griphyn.vdl.classes.Definition
      org.griphyn.vdl.classes.Transformation

Transformation
public class Transformation extends Definition implements Serializable(Code)
Transformation is an implementation of an abstract VDL Definition. A transformation describes the immutable template of an input, processing, and output (IPO) application. The environment is part of the capture. The template can be parametrized using formal arguments, which are part of the transformation definition. Think of a transformation as something similar to a C function definition. Mutable parts are hidden in the arguments, and instantiated in Derivation.

FIXME: The mixing of compounds with simple transformations within the same class instead of hierarchy needs some serious redesigning. Unfortunately, this entails a redesign of just about everything...
author:
   Jens-S. Vöckler
author:
   Yong Zhao
version:
   $Revision: 50 $
See Also:   Definition
See Also:   Definitions
See Also:   Derivation
See Also:   




Constructor Summary
public  Transformation()
     Default ctor: This ctor will frequently be used by the SAX parser to create a hollow instance.
public  Transformation(String name)
     Minimum c'tor: Any transformation should be named.
public  Transformation(String namespace, String name, String version)
     Standard ctor: This will name a transformation with the complete tripel necessary to access it correctly (w/o guessing).
Parameters:
  name - is the name of the transformation in the current namespaceand version context.
Parameters:
  namespace - is the namespace that the transformation resides in.
Parameters:
  version - is a version number.

Method Summary
public  voidaddArgument(Argument vArgument)
    
public  voidaddArgument(int index, Argument vArgument)
     Accessor: Inserts an argument at an arbitrary place into the list.
public  voidaddCall(Call vCall)
     Accessor: Adds an invocation to the list of calls.
public  voidaddCall(int index, Call vCall)
     Accessor: Inserts an invocation at an arbitrary place into the list.
public  voidaddDeclare(Declare vDeclare)
     Accessor: Adds a formal argument declaration to the map of declarations.
public  voidaddLocal(Local vLocal)
     Accessor: Adds a temporary variable declaration to the map of local variables.
public  voidaddProfile(Profile vProfile)
     Accessor: Appends a profile definition to the list of profiles.
public  voidaddProfile(int index, Profile vProfile)
     Accessor: Inserts a profile definition at an arbitrary position into the list of profiles.
public  EnumerationenumerateArgument()
     Accessor: Provides an iterator for the Argument list.
public  EnumerationenumerateCall()
     Accessor: Provides an iterator for the Call list.
public  EnumerationenumerateDeclare()
     Accessor: Provides an iterator for the Declare map.
public  EnumerationenumerateLocal()
     Accessor: Provides an iterator for the local variables. the iterator over all locally declared variables.
public  EnumerationenumerateProfile()
     Accessor: Provides an iterator for the Profile list.
public  ArgumentgetArgument(int index)
     Accessor: Obtains an Argument at an arbitrary position.
Parameters:
  index - is the place to look up the element at.
public  Argument[]getArgument()
     Accessor: Obtains the complete commandline arguments.
public  intgetArgumentCount()
     Accessor: Obtains the count of items in the argument list.
public  java.util.ListgetArgumentList()
     Accessor: Obtains the complete commandline arguments.
public  StringgetArgumentSeparator()
     Gets the separating string between multiple Argument elements. The current state of the separator.
public  CallgetCall(int index)
     Accessor: Obtains an Call at an arbitrary position.
Parameters:
  index - is the place to look up the element at.
public  Call[]getCall()
     Accessor: Obtains the invocation list.
public  intgetCallCount()
     Accessor: Obtains the count of items in the call list.
public  java.util.ListgetCallList()
     Accessor: Obtains the invocation list.
public  DeclaregetDeclare(String name)
     Accessor: Obtains the declaration of a formal argument as referenced by its variable name.
public  Declare[]getDeclare()
     Accessor: Obtain all known formal arguments.
public  intgetDeclareCount()
     Accessor: Counts the number of formal arguments known to this transformation.
public  java.util.ListgetDeclareList()
     Accessor: Obtain all known formal arguments.
public  java.util.MapgetDeclareMap()
     Accessor: Obtains all known formal arguments.
public  LocalgetLocal(String name)
     Accessor: Obtains the declaration of a temporary variable as referenced by its name.
Parameters:
  name - is the variable name to obtain the declaration for.
public  Local[]getLocal()
     Accessor: Obtain all known temporary variables.
public  intgetLocalCount()
     Accessor: Counts the number of temporary variables known to this transformation.
public  java.util.ListgetLocalList()
     Accessor: Obtains all known temporary variables.
public  java.util.MapgetLocalMap()
     Accessor: Obtains all known temporary variables.
public  ProfilegetProfile(int index)
     Accessor: Obtains an Profile at an arbitrary position.
Parameters:
  index - is the place to look up the element at.
exception:
  IndexOutOfBoundsException - if the referenced positiondoes not exist.
public  Profile[]getProfile()
     Accessor: Obtain a copy of the list of all Profile specifications.
public  intgetProfileCount()
     Accessor: Counts the number of profile specifications known to this job.
public  java.util.ListgetProfileList()
     Accessor: Obtain a read-only copy of the list of all Profile specifications.
public  intgetType()
     Type accessor for quick distinction between definitions.
public  Stringidentify()
     Constructs dynamically a short descriptive, hopefully unique identifier for this transformation.
public  booleanisSimple()
     Predicate: Determines, if this is a simple TR (as opposed to compound).
public  IteratoriterateArgument()
     Accessor: Provides an iterator for the Argument list.
public  IteratoriterateCall()
     Accessor: Provides an iterator for the Call list.
public  IteratoriterateDeclare()
     Accessor: Provides an iterator for the Declare map.
public  IteratoriterateLocal()
     Accessor: Provides an iterator for local variables.
public  IteratoriterateProfile()
     Accessor: Provides an iterator for the Profile list.
public  ListIteratorlistIterateArgument()
     Accessor: Provides a list iterator for the Argument list.
public  ListIteratorlistIterateArgument(int start)
     Accessor: Provides a list iterator for the Argument list.
public  ListIteratorlistIterateCall()
     Accessor: Provides a list iterator for the Call list.
public  ListIteratorlistIterateCall(int start)
     Accessor: Provides a list iterator for the Call list.
public  ListIteratorlistIterateProfile()
     Accessor: Provides a list iterator for the Profile list.
public  ListIteratorlistIterateProfile(int start)
     Accessor: Provides a list iterator for the Profile list.
public  voidremoveAllArgument()
     Accessor: Removes all commandline arguments.
public  voidremoveAllCall()
     Accessor: Removes all calls.
public  voidremoveAllDeclare()
     Accessor: Removes all formal arguments.
public  voidremoveAllLocal()
     Accessor: Removes all temporary variables.
public  voidremoveAllProfile()
     Accessor: Removes all profile declarations.
public  ArgumentremoveArgument(int index)
     Accessor: Removes a commandline argument fragment from the commandline.
public  CallremoveCall(int index)
     Accessor: Removes a single call fragment from the list of calls. Each component in this vector with an index greater or equal to the specified index is shifted downward to have an index one smaller than the value it had previously.
public  DeclareremoveDeclare(String name)
     Accessor: Removes a formal argument.
public  LocalremoveLocal(String name)
     Accessor: Removes a temporary variable.
public  ProfileremoveProfile(int index)
     Accessor: Removes a profile.
public  voidsetArgument(int index, Argument vArgument)
     Accessor: Overwrites an commandline argument fragment with a new one.
public  voidsetArgument(Argument[] argumentArray)
     Accessor: Replace the commandline arguments with a new commandline argument.
public  voidsetArgument(java.util.Collection arguments)
     Accessor: Replace the commandline arguments with a new commandline argument.
public  voidsetArgumentSeparator(String separator)
     Overwrites the internal separator string between neighbouring Argument elements with new content.
public  voidsetCall(int index, Call vCall)
     Accessor: Overwrites a call with a new one.
public  voidsetCall(Call[] callArray)
     Accessor: Replace the calls with a new call list.
public  voidsetCall(Collection calls)
     Accessor: Replace the calls with a new call list.
public  voidsetDeclare(Declare vDeclare)
     Accessor: Insert or replace a declaration with a new version.
Parameters:
  vDeclare - is the declaration to insert or replace.
public  voidsetDeclare(Declare[] declareArray)
     Accessor: Replace all declarations by a new set of declarations.
public  voidsetDeclare(Collection declares)
     Accessor: Replace all declarations by a new set of declarations.
public  voidsetDeclare(Map declares)
     Accessor: Replace all declarations by a new set of declarations.
public  voidsetLocal(Local vLocal)
     Accessor: Inserts or replaces a temporary variable with a new version.
Parameters:
  vLocal - is the temporary variable to insert or replace.
public  voidsetLocal(Local[] localArray)
     Accessor: Replaces all declarations by a new set of declarations.
public  voidsetLocal(Collection locals)
     Accessor: Replaces all declarations by a new set of declarations. This method effectively exchanges all temporary variables.
public  voidsetLocal(Map locals)
     Accessor: Replace all declarations by a new set of declarations. This method effectively exchanges all temporary variables.
public  voidsetProfile(int index, Profile vProfile)
    
public  voidsetProfile(Profile[] profileArray)
     Accessor: Replace the internal profiles with a new list.
public  voidsetProfile(java.util.Collection profiles)
     Accessor: Replace the internal profiles with a new list.
public  voidtoString(Writer stream)
     Dumps the content of the given element into a string.
public  voidtoXML(Writer stream, String indent, String namespace)
     Dump the state of the current element as XML output.


Constructor Detail
Transformation
public Transformation()(Code)
Default ctor: This ctor will frequently be used by the SAX parser to create a hollow instance. Note that a transformation can be named.



Transformation
public Transformation(String name)(Code)
Minimum c'tor: Any transformation should be named.
Parameters:
  name - is the name of the transformation in the current namespaceand version context.
See Also:   Definition



Transformation
public Transformation(String namespace, String name, String version)(Code)
Standard ctor: This will name a transformation with the complete tripel necessary to access it correctly (w/o guessing).
Parameters:
  name - is the name of the transformation in the current namespaceand version context.
Parameters:
  namespace - is the namespace that the transformation resides in.
Parameters:
  version - is a version number.
See Also:   Definition




Method Detail
addArgument
public void addArgument(Argument vArgument) throws IndexOutOfBoundsException(Code)
Accessor: Adds an argument to the list of arguments
Parameters:
  vArgument - is the argument to append to the command linearguments.
exception:
  IndexOutOfBounds - if the argument does not fit into the list.
See Also:   Argument



addArgument
public void addArgument(int index, Argument vArgument) throws IndexOutOfBoundsException(Code)
Accessor: Inserts an argument at an arbitrary place into the list. Each component in this vector with an index greater or equal to the specified index is shifted upward to have an index one greater than the value it had previously.
Parameters:
  index - is the position to insert an argument
Parameters:
  vArgument - is the argument to append to the command linearguments.
exception:
  IndexOutOfBounds - if the argument does not fit into the list.
See Also:   Transformation.getArgument(int)
See Also:   Transformation.setArgument(int,Argument)
See Also:   Argument



addCall
public void addCall(Call vCall) throws IndexOutOfBoundsException(Code)
Accessor: Adds an invocation to the list of calls.
Parameters:
  vCall - is the invocation to append to the list of calls.
exception:
  IndexOutOfBounds - if the argument does not fit into the list.
See Also:   Call



addCall
public void addCall(int index, Call vCall) throws IndexOutOfBoundsException(Code)
Accessor: Inserts an invocation at an arbitrary place into the list. Each component in this vector with an index greater or equal to the specified index is shifted upward to have an index one greater than the value it had previously.
Parameters:
  index - is the position to insert an invocation
Parameters:
  vCall - is the invocation to append to the list of calls.
exception:
  IndexOutOfBounds - if the argument does not fit into the list.
See Also:   Transformation.setCall(int,Call)
See Also:   Transformation.getCall(int)
See Also:   Call



addDeclare
public void addDeclare(Declare vDeclare)(Code)
Accessor: Adds a formal argument declaration to the map of declarations.
Parameters:
  vDeclare - is the formal argument to add to the declarations.
See Also:   Transformation.getDeclare(String)
See Also:   Transformation.setDeclare(Declare)
See Also:   Declare



addLocal
public void addLocal(Local vLocal)(Code)
Accessor: Adds a temporary variable declaration to the map of local variables.
Parameters:
  vLocal - is the local variable declaration with value.
See Also:   Transformation.getLocal(String)
See Also:   Transformation.setLocal(Local)
See Also:   Local



addProfile
public void addProfile(Profile vProfile) throws IndexOutOfBoundsException(Code)
Accessor: Appends a profile definition to the list of profiles.
Parameters:
  vProfile - is the profile to append to remembered profiles.
exception:
  IndexOutOfBounds - if the argument does not fit into the list.
See Also:   Profile



addProfile
public void addProfile(int index, Profile vProfile) throws IndexOutOfBoundsException(Code)
Accessor: Inserts a profile definition at an arbitrary position into the list of profiles. Each component in this vector with an index greater or equal to the specified index is shifted upward to have an index one greater than the value it had previously.
Parameters:
  index - is the position to insert the definitions into.
Parameters:
  vProfile - is the profile to append to remembered profiles.
exception:
  IndexOutOfBounds - if the argument does not fit into the list.
See Also:   Transformation.getProfile(int)
See Also:   Transformation.setProfile(int,Profile)
See Also:   Profile



enumerateArgument
public Enumeration enumerateArgument()(Code)
Accessor: Provides an iterator for the Argument list. the iterator for the Argument list.
See Also:   Argument
See Also:   java.util.Enumeration



enumerateCall
public Enumeration enumerateCall()(Code)
Accessor: Provides an iterator for the Call list. the iterator for the Call list.
See Also:   Call
See Also:   java.util.Enumeration



enumerateDeclare
public Enumeration enumerateDeclare()(Code)
Accessor: Provides an iterator for the Declare map. the iterator for the Declare list.
See Also:   Declare
See Also:   java.util.Enumeration



enumerateLocal
public Enumeration enumerateLocal()(Code)
Accessor: Provides an iterator for the local variables. the iterator over all locally declared variables.
See Also:   Local
See Also:   java.util.Enumeration



enumerateProfile
public Enumeration enumerateProfile()(Code)
Accessor: Provides an iterator for the Profile list. the iterator for the Profile list.
See Also:   Profile
See Also:   java.util.Enumeration



getArgument
public Argument getArgument(int index) throws IndexOutOfBoundsException(Code)
Accessor: Obtains an Argument at an arbitrary position.
Parameters:
  index - is the place to look up the element at. the argument at the specified place.
throws:
  IndexOutOfBoundsException - if the referenced position doesnot exist.
See Also:   Argument



getArgument
public Argument[] getArgument()(Code)
Accessor: Obtains the complete commandline arguments. This array is a copy to avoid write-through modifications. an array with all commandline arguments inside.
See Also:   Transformation.setArgument(Argument[])
See Also:   Argument



getArgumentCount
public int getArgumentCount()(Code)
Accessor: Obtains the count of items in the argument list. the number of arguments in the commandline argument list.
See Also:   Argument



getArgumentList
public java.util.List getArgumentList()(Code)
Accessor: Obtains the complete commandline arguments. The resulting list is read-only. an array with all commandline arguments inside.
See Also:   Transformation.setArgument(Collection)
See Also:   Argument
See Also:   



getArgumentSeparator
public String getArgumentSeparator()(Code)
Gets the separating string between multiple Argument elements. The current state of the separator. The text may be null.
See Also:   Transformation.setArgumentSeparator(String)



getCall
public Call getCall(int index) throws IndexOutOfBoundsException(Code)
Accessor: Obtains an Call at an arbitrary position.
Parameters:
  index - is the place to look up the element at. the call at the specified place.
throws:
  IndexOutOfBoundsException - if the referenced position doesnot exist.
See Also:   Transformation.addCall(int,Call)
See Also:   Transformation.setCall(int,Call)
See Also:   Call



getCall
public Call[] getCall()(Code)
Accessor: Obtains the invocation list. This array is a copy of the original to avoid write-through modifications. an array with all calls inside.
See Also:   Call



getCallCount
public int getCallCount()(Code)
Accessor: Obtains the count of items in the call list. the number of calls in the call list.
See Also:   Call



getCallList
public java.util.List getCallList()(Code)
Accessor: Obtains the invocation list. a read-only list with all calls inside.
See Also:   Transformation.setCall(Collection)
See Also:   Call



getDeclare
public Declare getDeclare(String name)(Code)
Accessor: Obtains the declaration of a formal argument as referenced by its variable name.
Parameters:
  name - is the symbolic index and variable name to obtain thedeclaration for. the Declare object referenced by the name. Mayreturn null, if there is no such object.
See Also:   Transformation.addDeclare(Declare)
See Also:   Transformation.setDeclare(Declare)
See Also:   Declare



getDeclare
public Declare[] getDeclare()(Code)
Accessor: Obtain all known formal arguments. Note that the array will be arbitrarily sorted, depending on Java's hash function. a list of all formal arguments.
See Also:   Declare
See Also:   Transformation.setDeclare(Declare[])



getDeclareCount
public int getDeclareCount()(Code)
Accessor: Counts the number of formal arguments known to this transformation. the formal argument count



getDeclareList
public java.util.List getDeclareList()(Code)
Accessor: Obtain all known formal arguments. Note that the list will be arbitrarily sorted, depending on Java's hash function. It is also a read-only list to avoid modifications outside the API. a list of all formal arguments.
See Also:   Transformation.setDeclare(Collection)
See Also:   Declare



getDeclareMap
public java.util.Map getDeclareMap()(Code)
Accessor: Obtains all known formal arguments. The map is a read-only map to avoid modifications outside the API. a map with all formal arguments.
See Also:   Transformation.setDeclare(Map)
See Also:   Declare
See Also:   



getLocal
public Local getLocal(String name)(Code)
Accessor: Obtains the declaration of a temporary variable as referenced by its name.
Parameters:
  name - is the variable name to obtain the declaration for. the Local object referenced by the name. Mayreturn null, if there is no such object.
See Also:   Transformation.addLocal(Local)
See Also:   Transformation.setLocal(Local)
See Also:   Local



getLocal
public Local[] getLocal()(Code)
Accessor: Obtain all known temporary variables. Note that the array will be arbitrarily sorted, depending on Java's hash function. a list of all temporary variables.
See Also:   Transformation.setLocal(Local[])
See Also:   Local



getLocalCount
public int getLocalCount()(Code)
Accessor: Counts the number of temporary variables known to this transformation. the temporary variable count



getLocalList
public java.util.List getLocalList()(Code)
Accessor: Obtains all known temporary variables. Note that the list will be arbitrarily sorted, depending on Java's hash function. It is also a read-only list to avoid modifications outside the API. a list of all formal arguments.
See Also:   Transformation.setLocal(Collection)
See Also:   Local



getLocalMap
public java.util.Map getLocalMap()(Code)
Accessor: Obtains all known temporary variables. The map is a read-only map to avoid modifications outside the API. a map with all formal arguments.
See Also:   Transformation.setLocal(Map)
See Also:   Local
See Also:   



getProfile
public Profile getProfile(int index) throws IndexOutOfBoundsException(Code)
Accessor: Obtains an Profile at an arbitrary position.
Parameters:
  index - is the place to look up the element at.
exception:
  IndexOutOfBoundsException - if the referenced positiondoes not exist.
See Also:   Transformation.addProfile(int,Profile)
See Also:   Transformation.setProfile(int,Profile)
See Also:   Profile



getProfile
public Profile[] getProfile()(Code)
Accessor: Obtain a copy of the list of all Profile specifications. a collection containing the scheduler specific environmentoptions for the job.
See Also:   Transformation.setProfile(Profile[])
See Also:   Profile
See Also:   



getProfileCount
public int getProfileCount()(Code)
Accessor: Counts the number of profile specifications known to this job. the number of profiles
See Also:   Profile



getProfileList
public java.util.List getProfileList()(Code)
Accessor: Obtain a read-only copy of the list of all Profile specifications. a collection containing the scheduler specific environmentoptions for the job.
See Also:   Transformation.setProfile(Collection)
See Also:   Profile
See Also:   



getType
public int getType()(Code)
Type accessor for quick distinction between definitions. the value of Definition.TRANSFORMATION



identify
public String identify()(Code)
Constructs dynamically a short descriptive, hopefully unique identifier for this transformation. a string describing the transformation
See Also:   Object.hashCode



isSimple
public boolean isSimple()(Code)
Predicate: Determines, if this is a simple TR (as opposed to compound). true, if this a simple transformation.



iterateArgument
public Iterator iterateArgument()(Code)
Accessor: Provides an iterator for the Argument list. the iterator for the Argument list.
See Also:   Argument



iterateCall
public Iterator iterateCall()(Code)
Accessor: Provides an iterator for the Call list. the iterator for the Call list.
See Also:   Call



iterateDeclare
public Iterator iterateDeclare()(Code)
Accessor: Provides an iterator for the Declare map. the iterator for the Declare list.
See Also:   Declare



iterateLocal
public Iterator iterateLocal()(Code)
Accessor: Provides an iterator for local variables. the iterator over all local variables.
See Also:   Declare



iterateProfile
public Iterator iterateProfile()(Code)
Accessor: Provides an iterator for the Profile list. the iterator for the Profile list.
See Also:   Profile



listIterateArgument
public ListIterator listIterateArgument()(Code)
Accessor: Provides a list iterator for the Argument list. the iterator for the Argument list.
See Also:   Argument



listIterateArgument
public ListIterator listIterateArgument(int start)(Code)
Accessor: Provides a list iterator for the Argument list. the iterator for the Argument list.
Parameters:
  start - is the start index
See Also:   Argument



listIterateCall
public ListIterator listIterateCall()(Code)
Accessor: Provides a list iterator for the Call list. the iterator for the Call list.
See Also:   Call



listIterateCall
public ListIterator listIterateCall(int start)(Code)
Accessor: Provides a list iterator for the Call list. the iterator for the Call list.
Parameters:
  start - is the start index
See Also:   Call



listIterateProfile
public ListIterator listIterateProfile()(Code)
Accessor: Provides a list iterator for the Profile list. the iterator for the Profile list.
See Also:   Profile



listIterateProfile
public ListIterator listIterateProfile(int start)(Code)
Accessor: Provides a list iterator for the Profile list. the iterator for the Profile list.
Parameters:
  start - is the start index
See Also:   Profile



removeAllArgument
public void removeAllArgument()(Code)
Accessor: Removes all commandline arguments.
See Also:   Argument



removeAllCall
public void removeAllCall()(Code)
Accessor: Removes all calls.
See Also:   Call



removeAllDeclare
public void removeAllDeclare()(Code)
Accessor: Removes all formal arguments.
See Also:   Declare



removeAllLocal
public void removeAllLocal()(Code)
Accessor: Removes all temporary variables.
See Also:   Local



removeAllProfile
public void removeAllProfile()(Code)
Accessor: Removes all profile declarations.
See Also:   Profile



removeArgument
public Argument removeArgument(int index)(Code)
Accessor: Removes a commandline argument fragment from the commandline. Each component in this vector with an index greater or equal to the specified index is shifted downward to have an index one smaller than the value it had previously. The size of this vector is decreased by 1.
Parameters:
  index - is the position to remove the argument fragment from. the removed Argument.
exception:
  ArrayIndexOutOfBoundsException - if the index was invalid.
See Also:   Argument



removeCall
public Call removeCall(int index)(Code)
Accessor: Removes a single call fragment from the list of calls. Each component in this vector with an index greater or equal to the specified index is shifted downward to have an index one smaller than the value it had previously. The size of this vector is decreased by 1.
Parameters:
  index - is the position to remove the call fragment from. the removed Call.
exception:
  ArrayIndexOutOfBoundsException - if the index was invalid.
See Also:   Call



removeDeclare
public Declare removeDeclare(String name)(Code)
Accessor: Removes a formal argument.
Parameters:
  name - is the name of the argument to remove the removed formal argument.
See Also:   Declare



removeLocal
public Local removeLocal(String name)(Code)
Accessor: Removes a temporary variable.
Parameters:
  name - is the name of the temporary variable to remove the removed variable.
See Also:   Local



removeProfile
public Profile removeProfile(int index)(Code)
Accessor: Removes a profile. Each component in this vector with an index greater or equal to the specified index is shifted downward to have an index one smaller than the value it had previously. The size of this vector is decreased by 1.
Parameters:
  index - is the position to remove the profile from. the removed Profile.
exception:
  ArrayIndexOutOfBoundsException - if the index was invalid.
See Also:   Profile



setArgument
public void setArgument(int index, Argument vArgument) throws IndexOutOfBoundsException(Code)
Accessor: Overwrites an commandline argument fragment with a new one.
Parameters:
  index - is the position to overwrite the element at
Parameters:
  vArgument - is the new commandline argument.
exception:
  IndexOutOfBoundsException - if the position does not exist.
See Also:   Argument



setArgument
public void setArgument(Argument[] argumentArray)(Code)
Accessor: Replace the commandline arguments with a new commandline argument.
Parameters:
  argumentArray - is the new commandline argument array.
See Also:   Argument



setArgument
public void setArgument(java.util.Collection arguments)(Code)
Accessor: Replace the commandline arguments with a new commandline argument.
Parameters:
  arguments - is the new commandline argument array.
See Also:   Argument



setArgumentSeparator
public void setArgumentSeparator(String separator)(Code)
Overwrites the internal separator string between neighbouring Argument elements with new content.
Parameters:
  separator - is the new string separating neighbouring arguments.
See Also:   Transformation.getArgumentSeparator()



setCall
public void setCall(int index, Call vCall) throws IndexOutOfBoundsException(Code)
Accessor: Overwrites a call with a new one.
Parameters:
  index - is the position to overwrite the element at
Parameters:
  vCall - is the new call.
exception:
  IndexOutOfBoundsException - if the position does not exist.
See Also:   Transformation.addCall(int,Call)
See Also:   Transformation.getCall(int)
See Also:   Call



setCall
public void setCall(Call[] callArray)(Code)
Accessor: Replace the calls with a new call list.
Parameters:
  callArray - is the new call array.
See Also:   Call



setCall
public void setCall(Collection calls)(Code)
Accessor: Replace the calls with a new call list.
Parameters:
  calls - is the new call array.
See Also:   Call



setDeclare
public void setDeclare(Declare vDeclare)(Code)
Accessor: Insert or replace a declaration with a new version.
Parameters:
  vDeclare - is the declaration to insert or replace.
See Also:   Declare
See Also:   java.util.Hashtable.put(ObjectObject)



setDeclare
public void setDeclare(Declare[] declareArray)(Code)
Accessor: Replace all declarations by a new set of declarations. This method effectively exchanges all formal arguments of a job.
Parameters:
  declareArray - is the new set of declarations.
See Also:   Declare



setDeclare
public void setDeclare(Collection declares)(Code)
Accessor: Replace all declarations by a new set of declarations. This method effectively exchanges all formal arguments of a job.
Parameters:
  declares - is the new set of declarations.
See Also:   Declare



setDeclare
public void setDeclare(Map declares)(Code)
Accessor: Replace all declarations by a new set of declarations. This method effectively exchanges all formal arguments of a job.
Parameters:
  declares - is the new set of declarations.
See Also:   Declare



setLocal
public void setLocal(Local vLocal)(Code)
Accessor: Inserts or replaces a temporary variable with a new version.
Parameters:
  vLocal - is the temporary variable to insert or replace.
See Also:   Local
See Also:   java.util.Hashtable.put(ObjectObject)



setLocal
public void setLocal(Local[] localArray)(Code)
Accessor: Replaces all declarations by a new set of declarations. This method effectively exchanges all temporary variables.
Parameters:
  localArray - is the new set of local variable declarations.
See Also:   Local



setLocal
public void setLocal(Collection locals)(Code)
Accessor: Replaces all declarations by a new set of declarations. This method effectively exchanges all temporary variables.
Parameters:
  locals - is the new set of temporary variable declarations.
See Also:   Local



setLocal
public void setLocal(Map locals)(Code)
Accessor: Replace all declarations by a new set of declarations. This method effectively exchanges all temporary variables.
Parameters:
  locals - is the new set of declarations.
See Also:   Local



setProfile
public void setProfile(int index, Profile vProfile) throws IndexOutOfBoundsException(Code)
Accessor: Overwrites a profile with a new profile
Parameters:
  index - is the position to overwrite the profile at.
Parameters:
  vProfile - is the new profile to use in overwriting.
exception:
  IndexOutOfBoundsException - if the position does not exist.
See Also:   Profile



setProfile
public void setProfile(Profile[] profileArray)(Code)
Accessor: Replace the internal profiles with a new list.
Parameters:
  profileArray - is the new list of profiles to use for the job.
See Also:   Profile



setProfile
public void setProfile(java.util.Collection profiles)(Code)
Accessor: Replace the internal profiles with a new list.
Parameters:
  profiles - is the new list of profiles to use for the job.
See Also:   Profile



toString
public void toString(Writer stream) throws IOException(Code)
Dumps the content of the given element into a string. This function traverses all sibling classes as necessary and converts the data into textual 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, if you use a buffered writer.
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.If a null value is specified, no indentation norlinefeeds will be generated.
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.



Fields inherited from org.griphyn.vdl.classes.Definition
final public static int DERIVATION(Code)(Java Doc)
final public static int TRANSFORMATION(Code)(Java Doc)

Methods inherited from org.griphyn.vdl.classes.Definition
public int compareTo(Object o)(Code)(Java Doc)
public boolean equals(Object obj)(Code)(Java Doc)
public String getDescription()(Code)(Java Doc)
public String getKeyword()(Code)(Java Doc)
public String getName()(Code)(Java Doc)
public String getNamespace()(Code)(Java Doc)
public String getTitle()(Code)(Java Doc)
abstract public int getType()(Code)(Java Doc)
public String getUrl()(Code)(Java Doc)
public String getVersion()(Code)(Java Doc)
public int hashCode()(Code)(Java Doc)
abstract public String identify()(Code)(Java Doc)
public boolean match(int type, String namespace, String name, String version)(Code)(Java Doc)
public void setDescription(String description)(Code)(Java Doc)
public void setKeyword(String keyword)(Code)(Java Doc)
public void setName(String name)(Code)(Java Doc)
public void setNamespace(String namespace)(Code)(Java Doc)
public void setTitle(String title)(Code)(Java Doc)
public void setUrl(String url)(Code)(Java Doc)
public void setVersion(String version)(Code)(Java Doc)
public static String shortID(Definition d, String namespace, String name, String version)(Code)(Java Doc)
public String shortID()(Code)(Java Doc)
public String toXML()(Code)(Java Doc)
public void toXML(Writer stream) throws IOException(Code)(Java Doc)


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