Java Doc for Scalar.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.Value
      org.griphyn.vdl.classes.Scalar

Scalar
public class Scalar extends Value implements Cloneable,Serializable(Code)
This class implements one of the argument types for parameters passed to transformations from derivations.
author:
   Jens-S. Vöckler
author:
   Yong Zhao
version:
   $Revision: 50 $
See Also:   Value
See Also:   List



Constructor Summary
public  Scalar()
     Default ctor.
public  Scalar(Leaf firstChild)
     Convenience ctor: Initializes the object with the first child to be put into the list of values.

Method Summary
public  voidaddLeaf(Leaf vLeaf)
     Accessor: Adds a Leaf value to the list of values gathered as the content of a Scalar.
Parameters:
  vLeaf - is the value to append to the list.
public  voidaddLeaf(int index, Leaf vLeaf)
     Accessor: Inserts a Leaf value into a specific position of the list of gathered values.
Parameters:
  index - is the position to insert the item into
Parameters:
  vLeaf - is the value to append to the list.
public  Objectclone()
     Creates and returns a copy of this object.
public  booleancontainsLFN(String filename, int linkage)
     Determines if the scalar contains an LFN of the specified linkage. The logic uses short-circuit evaluation, thus finding things is faster than not finding things.
public  EnumerationenumerateLeaf()
     Accessor: Enumerates the internal values that constitute the content of the Scalar element.
public  java.util.ListgetAllLFN(int linkage)
     Determines all LFN instances of a given scalar that match the specified linkage.
public  intgetContainerType()
     Accessor: Obtains the value type of this class.
public  java.util.ListgetLFNList(int linkage)
     Determines all LFN instances of a given scalar that match the specified linkage.
public  LeafgetLeaf(int index)
     Accessor: Obtains the Leaf at a certain position in the list of leaf values.
public  Leaf[]getLeaf()
     Accessor: Gets an array of all values that constitute the current content.
public  intgetLeafCount()
     Accessor: Obtains the size of the internal list of Leaf s.
public  java.util.ListgetLeafList()
     Accessor: Gets an array of all values that constitute the current content.
public  StringgetSymbolicType()
     This method determines which container is being used in the abstract base class in order to kludgy statements when printing debug info.
public  IteratoriterateLeaf()
     Accessor: Enumerates the internal values that constitute the content of the Scalar element.
public  ListIteratorlistIterateLeaf()
     Accessor: Enumerates the internal values that constitute the content of the Scalar element.
public  ListIteratorlistIterateLeaf(int start)
     Accessor: Enumerates the internal values that constitute the content of the Scalar element.
public  voidremoveAllLeaf()
     Accessor: Removes the content of the Scalar.
public  LeafremoveLeaf(int index)
     Accessor: Remove a single item from the list of nodes.
public  voidsetLeaf(int index, Leaf vLeaf)
     Accessor: Overwrites a LFN or Text value at a certain position in the content-constituting list.
public  voidsetLeaf(Leaf[] leafArray)
     Accessor: Overwrites internal list with an external list representing a Scalar value.
public  voidsetLeaf(Collection leaves)
     Accessor: Overwrites internal list with an external list representing a Scalar value.
public  StringtoString()
     Converts the object state into textual format for human consumption.
public  voidtoString(Writer stream)
     Converts the object state into textual format for human consumption.
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.


Constructor Detail
Scalar
public Scalar()(Code)
Default ctor.



Scalar
public Scalar(Leaf firstChild)(Code)
Convenience ctor: Initializes the object with the first child to be put into the list of values.
Parameters:
  firstChild - is either a LFN or Textobject.
See Also:   Leaf
See Also:   LFN
See Also:   Text




Method Detail
addLeaf
public void addLeaf(Leaf vLeaf) throws IndexOutOfBoundsException(Code)
Accessor: Adds a Leaf value to the list of values gathered as the content of a Scalar.
Parameters:
  vLeaf - is the value to append to the list. Note that only leafvalues of LFN or Text are allowed.
throws:
  IndexOutOfBoundsException - if the value cannot be added.
See Also:   Leaf
See Also:   Text
See Also:   LFN



addLeaf
public void addLeaf(int index, Leaf vLeaf) throws IndexOutOfBoundsException(Code)
Accessor: Inserts a Leaf value into a specific position of the list of gathered values.
Parameters:
  index - is the position to insert the item into
Parameters:
  vLeaf - is the value to append to the list. Note that only leafvalues of LFN or Text are allowed.
throws:
  IndexOutOfBoundsException - if the value cannot be added.
See Also:   Text
See Also:   LFN



clone
public Object clone()(Code)
Creates and returns a copy of this object. a new instance.



containsLFN
public boolean containsLFN(String filename, int linkage)(Code)
Determines if the scalar contains an LFN of the specified linkage. The logic uses short-circuit evaluation, thus finding things is faster than not finding things.
Parameters:
  filename - is the name of the LFN
Parameters:
  linkage - is the linkage to check for, -1 for any linkage type. true if the LFN is contained in the scalar, false otherwise.
See Also:   org.griphyn.vdl.classes.LFN
See Also:   



enumerateLeaf
public Enumeration enumerateLeaf()(Code)
Accessor: Enumerates the internal values that constitute the content of the Scalar element. an enumeration to walk the list with.



getAllLFN
public java.util.List getAllLFN(int linkage)(Code)
Determines all LFN instances of a given scalar that match the specified linkage. This is a higher-level method employing the given API.
Parameters:
  linkage - is the linkage to check for, -1 for all filenames. a set of logical filename instances that match the linkageand were part of the scalar. The result may be an empty set, if nosuch result were to be found.
See Also:   LFN
See Also:   



getContainerType
public int getContainerType()(Code)
Accessor: Obtains the value type of this class. By using the abstract method in the parent class, Scalar objects can be distinguished from List objects without using the instanceof operator. the fixed value of being a scalar.
See Also:   Value.SCALAR
See Also:   



getLFNList
public java.util.List getLFNList(int linkage)(Code)
Determines all LFN instances of a given scalar that match the specified linkage. This is a higher-level method employing the given API. Note that also linkage of NONE will not be found in wildcard search mode.
Parameters:
  linkage - is the linkage to check for, -1 for all filenames. a set of all logical filenames that match the linkage andwere part of the scalar. The result may be an empty set, if no suchresult were to be found. For a linkage of -1, complete LFNs will bereturned, for any other linkage, just the filename will bereturned.
See Also:   Derivation.getLFNList(int)
See Also:   
See Also:   LFN
See Also:   



getLeaf
public Leaf getLeaf(int index) throws IndexOutOfBoundsException(Code)
Accessor: Obtains the Leaf at a certain position in the list of leaf values.
Parameters:
  index - is the position in the list to obtain a value from The LFN or Text at the position.
throws:
  IndexOutOfBoundsException - if the index points to an elmentin the list that does not contain any elments.
See Also:   LFN
See Also:   Text



getLeaf
public Leaf[] getLeaf()(Code)
Accessor: Gets an array of all values that constitute the current content. This array is a copy to avoid write-through modifications. an array with a mixture of either Text orLFN values.
See Also:   LFN
See Also:   Text



getLeafCount
public int getLeafCount()(Code)
Accessor: Obtains the size of the internal list of Leaf s. number of elements that an external array needs to be sized to.



getLeafList
public java.util.List getLeafList()(Code)
Accessor: Gets an array of all values that constitute the current content. This list is read-only. an array with a mixture of either Text orLFN values.
See Also:   LFN
See Also:   Text



getSymbolicType
public String getSymbolicType()(Code)
This method determines which container is being used in the abstract base class in order to kludgy statements when printing debug info. the symblic identifier for the type of the Value.



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



listIterateLeaf
public ListIterator listIterateLeaf()(Code)
Accessor: Enumerates the internal values that constitute the content of the Scalar element. an iterator to walk the list with.



listIterateLeaf
public ListIterator listIterateLeaf(int start)(Code)
Accessor: Enumerates the internal values that constitute the content of the Scalar element.
Parameters:
  start - is the start index a list iterator to walk the list with.



removeAllLeaf
public void removeAllLeaf()(Code)
Accessor: Removes the content of the Scalar.



removeLeaf
public Leaf removeLeaf(int index)(Code)
Accessor: Remove a single item from the list of nodes. The list is shrunken in the process.
Parameters:
  index - is the position at which an element is to be removed. the object that was removed. The object is either aLFN or a Text.
See Also:   LFN
See Also:   Text



setLeaf
public void setLeaf(int index, Leaf vLeaf) throws IndexOutOfBoundsException(Code)
Accessor: Overwrites a LFN or Text value at a certain position in the content-constituting list.
Parameters:
  index - position to overwrite an elment in.
Parameters:
  vLeaf - is either a LFN or Text object.
throws:
  IndexOutOfBoundsException - if the position pointed to is invalid.
See Also:   LFN
See Also:   Text



setLeaf
public void setLeaf(Leaf[] leafArray)(Code)
Accessor: Overwrites internal list with an external list representing a Scalar value.
Parameters:
  leafArray - is the external list of Text orLFN objects used to overwrite things.
See Also:   Text
See Also:   LFN



setLeaf
public void setLeaf(Collection leaves)(Code)
Accessor: Overwrites internal list with an external list representing a Scalar value.
Parameters:
  leaves - is the external list of Text orLFN objects used to overwrite things.
See Also:   Text
See Also:   LFN



toString
public String toString()(Code)
Converts the object state into textual format for human consumption. a textual description of the element and its sub-classes.Be advised that these strings might become large.



toString
public void toString(Writer stream) throws IOException(Code)
Converts the object state into textual format for human consumption.
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, 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.
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.Value
final public static int LIST(Code)(Java Doc)
final public static int SCALAR(Code)(Java Doc)

Methods inherited from org.griphyn.vdl.classes.Value
abstract public Object clone()(Code)(Java Doc)
abstract public boolean containsLFN(String filename, int linkage)(Code)(Java Doc)
abstract public java.util.List getAllLFN(int linkage)(Code)(Java Doc)
abstract public int getContainerType()(Code)(Java Doc)
abstract public java.util.List getLFNList(int linkage)(Code)(Java Doc)
public String getName()(Code)(Java Doc)
abstract public String getSymbolicType()(Code)(Java Doc)
public static boolean isInRange(int x)(Code)(Java Doc)
public void setName(String name)(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.