/*
* This file or a portion of this file is licensed under the terms of
* the Globus Toolkit Public License, found in file GTPL, or at
* http://www.globus.org/toolkit/download/license.html. This notice must
* appear in redistributions of this file, with or without modification.
*
* Redistributions of this Software, with or without modification, must
* reproduce the GTPL in: (1) the Software, or (2) the Documentation or
* some other similar material which is provided with the Software (if
* any).
*
* Copyright 1999-2004 University of Chicago and The University of
* Southern California. All rights reserved.
*/
package edu.isi.pegasus.planner.invocation;
import java.util.*;
import java.io.Writer;
import java.io.IOException;
/**
* This class is transient for XML parsing. The data value will be
* incorporated into the <code>StatCall</code> class.
*
* @author Jens-S. Vöckler
* @author Yong Zhao
* @version $Revision$
* @see StatCall
*/
public class Data extends Invocation implements HasText
{
/**
* This is the data contained between the tags. A <code>null</code>
* value is not valid.
*/
private StringBuffer m_value;
/**
* Indicates, if the data is only partial.
*/
private boolean m_truncated;
/**
* Default c'tor: Construct a hollow shell and allow further
* information to be added later.
*/
public Data()
{
m_value = null;
m_truncated = false;
}
/**
* Constructs a piece of data.
* @param value is the data to remember. The string may be empty,
* but it must not be <code>null</code>.
* @exception NullPointerException if the argument was null.
*/
public Data( String value )
{
if ( value == null )
throw new NullPointerException("the value to the <data> tag constructor must not be null" );
else
m_value = new StringBuffer(value);
}
/**
* Constructs a piece of data.
* @param value is the data to remember. The string may be empty,
* but it must not be <code>null</code>.
* @param truncated is a flag to indicate that the data is partial.
* @exception NullPointerException if the argument was null.
*/
public Data( String value, boolean truncated )
{
if ( value == null )
throw new NullPointerException("the value to the <data> tag constructor must not be null" );
else
m_value = new StringBuffer(value);
m_truncated = truncated;
}
/**
* Appends a piece of text to the existing text.
* @param fragment is a piece of text to append to existing text.
* Appending <code>null</code> is a noop.
*/
public void appendValue( String fragment )
{
if ( fragment != null ) {
if ( this.m_value == null ) this.m_value = new StringBuffer(fragment);
else this.m_value.append(fragment);
}
}
/**
* Accessor
*
* @see #setTruncated(boolean)
*/
public boolean getTruncated()
{ return this.m_truncated; }
/**
* Accessor.
*
* @param truncated
* @see #getTruncated()
*/
public void setTruncated( boolean truncated )
{ this.m_truncated = truncated; }
/**
* Accessor
*
* @see #setValue(String)
*/
public String getValue()
{
return ( m_value == null ? null : m_value.toString() );
}
/**
* Accessor.
*
* @param value is the new value to set.
* @see #getValue()
*/
public void setValue( String value )
{
this.m_value = ( value == null ? null : new StringBuffer(value) );
}
/**
* Converts the active state into something meant for human consumption.
* The method will be called when recursively traversing the instance
* tree.
*
* @param stream is a stream opened and ready for writing. This can also
* be a string stream for efficient output.
*/
public void toString( Writer stream )
throws IOException
{
throw new IOException( "method not implemented, please contact vds-support@griphyn.org" );
}
/**
* Dumps the state of the current element as XML output. This function
* can return the necessary data more efficiently, thus overwriting
* the inherited method.
*
* @param indent is a <code>String</code> 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.
*
* @return a String which contains the state of the current class and
* its siblings using XML. Note that these strings might become large.
*/
public String toXML( String indent )
{
if ( m_value != null ) {
String newline =
System.getProperty( "line.separator", "\r\n" );
StringBuffer result =
new StringBuffer( m_value.length() + 24 );
if ( indent != null && indent.length() > 0 ) result.append( indent );
result.append( "<data truncated=\"" );
result.append( Boolean.toString(m_truncated) );
result.append( "\">" ).append( quote(getValue(),false) ).append("</data>");
if ( indent != null ) result.append(newline);
return result.toString();
} else {
return new String();
}
}
/**
* 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.
*
* @param stream is a stream opened and ready for writing. This can also
* be a string stream for efficient output.
* @param indent is a <code>String</code> 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 <code>null</code> value is specified, no indentation nor
* linefeeds will be generated.
* @param 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.
* @exception IOException if something fishy happens to the stream.
*/
public void toXML( Writer stream, String indent, String namespace )
throws IOException
{
if ( this.m_value != null ) {
String tag = ( namespace != null && namespace.length() > 0 ) ?
namespace + ":data" : "data";
// open tag
if ( indent != null && indent.length() > 0 ) stream.write( indent );
stream.write( '<' );
stream.write( tag );
writeAttribute( stream, " truncated=\"", Boolean.toString(m_truncated) );
stream.write( '>' );
// dump content
stream.write( quote(getValue(),false) );
// close tag
stream.write( "</" );
stream.write( tag );
stream.write( '>' );
if ( indent != null )
stream.write( System.getProperty( "line.separator", "\r\n" ) );
}
}
}