| java.lang.Object
 org.griphyn.vdl.Chimera
All known Subclasses: org.griphyn.vdl.classes.VDL, org.griphyn.vdl.invocation.Invocation, org.griphyn.vdl.dax.DAX,
| Chimera | | abstract public class Chimera (Code) | | This abstract class defines a common base for all JAPI Chimera objects.
All VDL-related classes must conform to this interface, in order to
make various instances available as a reference to this class.
author:
Jens-S. Vöckler
author:
Yong Zhao
version:
$Revision: 50 $ |
| Method Summary | |
| public static String | escape(String original)
Escapes certain characters inappropriate for textual output. | | public static String | quote(String original, boolean isAttribute)
Escapes certain characters inappropriate for XML content output.
FIXME: Quotes within attribute values are still not handled correctly.
Parameters:
original - is a string that needs to be quoted
Parameters:
isAttribute - denotes an attributes value, if set to true.If false, it denotes regular XML content outside of attributes. | | public String | toString()
Dumps content of the given element into a string. | | abstract public void | toString(Writer s)
Dumps the content of the given element into a stream. | | public String | toXML(String indent, String namespace)
Dumps the state of the current element as XML output. | | public void | toXML(Writer stream, String indent)
Provides backward compatibility.
toXML( stream, indent, (String) null );
Parameters:
stream - is a stream opened and ready for writing. | | abstract public void | toXML(Writer stream, String indent, String namespace)
Dump the state of the current element as XML output. | | public void | writeAttribute(Writer stream, String key, String value)
XML write helper method writes a quoted attribute onto a stream.
The terminating quote will be appended automatically. |
| escape | | public static String escape(String original)(Code) | | Escapes certain characters inappropriate for textual output.
Parameters:
original - is a string that needs to be quoted a string that is "safe" to print. |
| quote | | public static String quote(String original, boolean isAttribute)(Code) | | Escapes certain characters inappropriate for XML content output.
FIXME: Quotes within attribute values are still not handled correctly.
Parameters:
original - is a string that needs to be quoted
Parameters:
isAttribute - denotes an attributes value, if set to true.If false, it denotes regular XML content outside of attributes. a string that is "safe" to print as XML. |
| toString | | public String toString()(Code) | | Dumps content of the given element into a string. This function
traverses all sibling classes as necessary and converts the
data into textual output.
Sibling classes which represent small leaf objects, and can return
the necessary data more efficiently, are encouraged to overwrite
this method.
a textual description of the element and its sub-classes.Be advised that these strings might become large. |
| toString | | abstract public void toString(Writer s) throws IOException(Code) | | Dumps the content of the given element into a stream. This function
traverses all sibling classes as necessary and converts the
data into textual output.
Parameters:
s - is a stream opened and ready for writing. This can also bea string stream for efficient output. The stream interface shouldbe able to handle large elements efficiently.
exception:
IOException - if something fishy happens to the stream. |
| toXML | | public String toXML(String indent, String namespace)(Code) | | Dumps 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.
Sibling classes which represent small leaf objects, and can return
the necessary data more efficiently, are encouraged to overwrite
this method.
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 null, avoidable whitespaces in the output will be avoided.
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. a String which contains the state of the current classand its siblings using XML. Note that these strings might become large. |
| toXML | | public void toXML(Writer stream, String indent) throws IOException(Code) | | Provides backward compatibility.
toXML( stream, indent, (String) null );
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.
exception:
IOException - if something fishy happens to the stream.
See Also: Chimera.toXML(Writer,String,String) |
| toXML | | abstract 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 used 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.
See Also: java.io.BufferedWriter |
| writeAttribute | | public void writeAttribute(Writer stream, String key, String value) throws IOException(Code) | | XML write helper method writes a quoted attribute onto a stream.
The terminating quote will be appended automatically. Values will
be XML-escaped. No action will be taken, if the value is null.
Parameters:
stream - is the stream to append to
Parameters:
key - is the attribute including initial space, attribute name,equals sign, and opening quote.
Parameters:
value - is a string value, which will be put within the quotesand which will be escaped. If the value is null, no action will betaken
exception:
IOException - for stream errors. |
|
|