org.griphyn.vdl.invocation
Class Data

java.lang.Object
  org.griphyn.vdl.Chimera
      org.griphyn.vdl.invocation.Invocation
          org.griphyn.vdl.invocation.Data

All Implemented Interfaces:

Serializable, HasText

public class Data
extends Invocation
implements HasText

This class is transient for XML parsing. The data value will be incorporated into the StatCall class.

Version:

$Revision: 50 $

Author:

Jens-S. V??ckler, Yong Zhao

See Also:

StatCall, Serialized Form

Field Summary

private boolean	m_truncated Indicates, if the data is only partial.
private StringBuffer	m_value This is the data contained between the tags.

Constructor Summary

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

Data(String value)
Constructs a piece of data.

Data(String value, boolean truncated)
Constructs a piece of data.

Method Summary

void	appendValue(String fragment) Appends a piece of text to the existing text.
boolean	getTruncated() Accessor
String	getValue() Accessor
void	setTruncated(boolean truncated) Accessor.
void	setValue(String value) Accessor.
void	toString(Writer stream) Converts the active state into something meant for human consumption.
String	toXML(String indent) Dumps the state of the current element as XML output.
void	toXML(Writer stream, String indent, String namespace) Dump the state of the current element as XML output.

Methods inherited from class org.griphyn.vdl.Chimera

escape, quote, toString, toXML, toXML, writeAttribute

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

m_value

private StringBuffer m_value

This is the data contained between the tags. A null value is not valid.

m_truncated

private boolean m_truncated

Indicates, if the data is only partial.

Constructor Detail

Data

public Data()

Default c'tor: Construct a hollow shell and allow further information to be added later.

Data

public Data(String value)

Constructs a piece of data.

Parameters:

value - is the data to remember. The string may be empty, but it must not be null.

Throws:

NullPointerException - if the argument was null.

Data

public Data(String value,
            boolean truncated)

Constructs a piece of data.

Parameters:

value - is the data to remember. The string may be empty, but it must not be null.

truncated - is a flag to indicate that the data is partial.

Throws:

NullPointerException - if the argument was null.

Method Detail

appendValue

public void appendValue(String fragment)

Appends a piece of text to the existing text.

Specified by:

appendValue in interface HasText

Parameters:

fragment - is a piece of text to append to existing text. Appending null is a noop.

getTruncated

public boolean getTruncated()

Accessor

See Also:

setTruncated(boolean)

setTruncated

public void setTruncated(boolean truncated)

Accessor.

Parameters:

truncated -

See Also:

getTruncated()

getValue

public String getValue()

Accessor

Specified by:

getValue in interface HasText

See Also:

setValue(String)

setValue

public void setValue(String value)

Accessor.

Specified by:

setValue in interface HasText

Parameters:

value - is the new value to set.

See Also:

getValue()

toString

public void toString(Writer stream)
              throws IOException

Converts the active state into something meant for human consumption. The method will be called when recursively traversing the instance tree.

Specified by:

toString in class Chimera

Parameters:

stream - is a stream opened and ready for writing. This can also be a string stream for efficient output.

Throws:

IOException - if something fishy happens to the stream.

toXML

public String toXML(String indent)

Dumps the state of the current element as XML output. This function can return the necessary data more efficiently, thus overwriting the inherited method.

Parameters:

indent - is a String of spaces used for pretty printing. The initial amount of spaces should be an empty string. The parameter is used internally for the recursive traversal.

Returns:

a String which contains the state of the current class and its siblings using XML. Note that these strings might become large.

toXML

public void toXML(Writer stream,
                  String indent,
                  String namespace)
           throws IOException

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.

Specified by:

toXML in class Chimera

Parameters:

stream - is a stream opened and ready for writing. This can also be a string stream for efficient output.

indent - is a String of spaces used for pretty printing. 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 nor linefeeds will be generated.

namespace - is the XML schema namespace prefix. If neither empty nor null, each element will be prefixed with this prefix, and the root element will map the XML namespace.

Throws:

IOException - if something fishy happens to the stream.

See Also:

BufferedWriter