com.gestalt.scribe
Class HTMLData

java.lang.Object
  |
  +--com.gestalt.scribe.HTMLData
All Implemented Interfaces:
java.io.Serializable

public class HTMLData
extends java.lang.Object
implements java.io.Serializable

HTMLData class provides the means of passing HTML-based report to the calling program. It carries the plain HTML content and, optionally, images the content may refer to. The images are stored as binary JPEG representation in a Hashmap as key-value pairs. The keys are unique String tags assigned to the images, in "imgN" format, and the values are byte arrays with the image binary content. HTMLData objects are created by Scribe server, and are returned to the client application via getReportAsHTML method of Connector class. The client application is responsible for extracting the HTML content and image data from HTMLData object.

See Also:
Connector, Serialized Form

 
Method Summary
 java.util.Vector getHTML()
          Returns the HTML content of HTMLData.
 java.lang.String getHTMLText()
          Returns the HTML content of HTMLData.
 java.util.Hashtable getImages()
          Returns the Hashtable with image binary data.
 boolean isEmpty()
          Returns the empty state flag of HTMLData.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Method Detail

getHTML

public java.util.Vector getHTML()
Returns the HTML content of HTMLData.

Returns:
Vector of Strings containing the HTML-formatted text. Each String ends with the newline character \n.

getImages

public java.util.Hashtable getImages()
Returns the Hashtable with image binary data.

Returns:
Hashtable containing the key (tag) - value (image) pairs.

getHTMLText

public java.lang.String getHTMLText()
Returns the HTML content of HTMLData.

Returns:
String containing the HTML-formatted text.

isEmpty

public boolean isEmpty()
Returns the empty state flag of HTMLData.

Returns:
boolean value as true if there is no HTML content.