NetCharts Server

netcharts.server.api
Class ServerGeneratedPage

java.lang.Object
  |
  +--netcharts.server.api.ServerGeneratedPage

public class ServerGeneratedPage
extends java.lang.Object

Object with HTML representation of chart image.


Constructor Summary
ServerGeneratedPage()
          Create an empty ServerGeneratedPage.
ServerGeneratedPage(byte[] image, java.lang.String mimeType, java.lang.String html)
          Create a ServerGeneratedPage with the given image data and mime type.
ServerGeneratedPage(byte[] image, java.lang.String mimeType, java.lang.String html, java.lang.String altText, java.lang.String chartFile)
          Create an ServerGeneratedPage with the given image data, mime type, HTML and unique ID.
ServerGeneratedPage(byte[] image, java.lang.String mimeType, java.lang.String html, java.lang.String altText, java.lang.String chartFile, java.lang.String uniqueID)
          Create an ServerGeneratedPage with the given image data, mime type, MapElement vector and unique ID.
 
Method Summary
 void createUniqueID()
          Create the Unique ID of the image or retrieve it from the HTML.
 java.lang.String getAltText()
          Get the alternate text of the image.
 java.lang.String getChartFile()
          Get the chart file of the ServerGeneratedPage.
 java.lang.String getError()
          Get the error.
 java.lang.String getHTML()
          Get the unique ID of the ServerGeneratedPage.
 java.lang.String getHTMLFragment()
          Retrieve the html code contained within the tag and the script.
 byte[] getImage()
          Get the encoded image data.
 java.lang.String getMimeType()
          Get the mime type of the encoded image.
 java.lang.String getUniqueID()
          Get the unique ID of the ServerGeneratedPage.
 boolean load(byte[] serializedSGP)
          Load and initialize the ServerGeneratedPage from an XML based serialized form.
 java.lang.String save()
          Persist the ServerGeneratedImage into an XML based serialized form.
 java.lang.String save(java.lang.String encoding)
          Persist the ServerGeneratedImage into an XML based serialized form.
 void setAltText(java.lang.String altText)
          Set the alternate text of the image.
 void setChartFile(java.lang.String chartFile)
          Set the chart file of the ServerGeneratedPage.
 void setError(java.lang.String error)
          Set the error.
 void setHTML(java.lang.String html)
          Set the unique ID of the ServerGeneratedPage.
 void setImage(byte[] image)
          Set the encoded image data.
 boolean setImageSourceTag(java.lang.String newSource)
          Modify the src parameter of the img tag.
 void setMimeType(java.lang.String mimeType)
          Set the mime type of the encoded image.
 void setUniqueID(java.lang.String uniqueID)
          Set the unique ID of the ServerGeneratedPage.
 
Methods inherited from class java.lang.Object
equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

ServerGeneratedPage

public ServerGeneratedPage()
Create an empty ServerGeneratedPage.

ServerGeneratedPage

public ServerGeneratedPage(byte[] image,
                           java.lang.String mimeType,
                           java.lang.String html)
Create a ServerGeneratedPage with the given image data and mime type.
Parameters:
image - The encoded image data.
mimeType - The mime type of the encoded image.
html - The resultant HTML of the page.

ServerGeneratedPage

public ServerGeneratedPage(byte[] image,
                           java.lang.String mimeType,
                           java.lang.String html,
                           java.lang.String altText,
                           java.lang.String chartFile)
Create an ServerGeneratedPage with the given image data, mime type, HTML and unique ID.
Parameters:
image - The encoded image data.
mimeType - The mime type of the encoded image.
html - The resultant HTML of the page.
altText - The alternate of the encoded image.
chartFile - The chart file of the ServerGeneratedPage.

ServerGeneratedPage

public ServerGeneratedPage(byte[] image,
                           java.lang.String mimeType,
                           java.lang.String html,
                           java.lang.String altText,
                           java.lang.String chartFile,
                           java.lang.String uniqueID)
Create an ServerGeneratedPage with the given image data, mime type, MapElement vector and unique ID.
Parameters:
image - The encoded image data.
mimeType - The mime type of the encoded image.
html - The resultant HTML of the page.
altText - The alternate of the encoded image.
chartFile - The chart file of the ServerGeneratedPage.
uniqueID - The unique ID of the encoded image.
Method Detail

load

public boolean load(byte[] serializedSGP)
Load and initialize the ServerGeneratedPage from an XML based serialized form.
Parameters:
serializedSGI - The ServerGeneratedPage in XML form.

save

public java.lang.String save()
Persist the ServerGeneratedImage into an XML based serialized form.

save

public java.lang.String save(java.lang.String encoding)
Persist the ServerGeneratedImage into an XML based serialized form.
Parameters:
The - string encoding to use for the xml document and the image data.

setImageSourceTag

public boolean setImageSourceTag(java.lang.String newSource)
Modify the src parameter of the img tag.

createUniqueID

public void createUniqueID()
Create the Unique ID of the image or retrieve it from the HTML.

getHTMLFragment

public java.lang.String getHTMLFragment()
Retrieve the html code contained within the tag and the script.

setImage

public void setImage(byte[] image)
Set the encoded image data.

getImage

public byte[] getImage()
Get the encoded image data.

setMimeType

public void setMimeType(java.lang.String mimeType)
Set the mime type of the encoded image.

getMimeType

public java.lang.String getMimeType()
Get the mime type of the encoded image.

setAltText

public void setAltText(java.lang.String altText)
Set the alternate text of the image.

getAltText

public java.lang.String getAltText()
Get the alternate text of the image.

setChartFile

public void setChartFile(java.lang.String chartFile)
Set the chart file of the ServerGeneratedPage.

getChartFile

public java.lang.String getChartFile()
Get the chart file of the ServerGeneratedPage.

setUniqueID

public void setUniqueID(java.lang.String uniqueID)
Set the unique ID of the ServerGeneratedPage.

getUniqueID

public java.lang.String getUniqueID()
Get the unique ID of the ServerGeneratedPage.

setHTML

public void setHTML(java.lang.String html)
Set the unique ID of the ServerGeneratedPage.

getHTML

public java.lang.String getHTML()
Get the unique ID of the ServerGeneratedPage.

setError

public void setError(java.lang.String error)
Set the error.

getError

public java.lang.String getError()
Get the error.

NetCharts Server


Visual Mining, Inc.
15825 Shady Grove Rd.
Suite 20
Rockville, MD 20850
800.308.0731
301.947.8293 FAX

Copyright © Visual Mining, Inc. 1996 - 2007
All Rights Reserved.

NetCharts Server TM is a registered trademark of Visual Mining, Inc. Other brands and their products are trademarks of their respective holders.

Last Modified: Jun 14, 2007