netcharts.server.api
Class ServerGeneratedImage

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

All Implemented Interfaces:

java.io.Serializable

public class ServerGeneratedImage

extends java.lang.Object

implements java.io.Serializable

Object containing raw byte image and drilldown map information.

See Also:

Serialized Form

Constructor Summary

ServerGeneratedImage()
Create an empty ServerGeneratedImage.

ServerGeneratedImage(byte[] image, java.lang.String mimeType)
Create a ServerGeneratedImage with the given image data and mime type.

ServerGeneratedImage(byte[] image, java.lang.String encodingScheme, java.lang.String mimeType)
Create a ServerGeneratedImage with the given image data, encoding and mime type.

ServerGeneratedImage(byte[] image, java.lang.String encodingScheme, java.lang.String mimeType, java.lang.String chartFile, MapElement[] map)
Create an ServerGeneratedImage with the given image data, mime type, MapElement vector and unique ID.

ServerGeneratedImage(byte[] image, java.lang.String encodingScheme, java.lang.String mimeType, java.lang.String chartFile, MapElement[] map, java.lang.String uniqueID)
Create an ServerGeneratedImage with the given image data, mime type, MapElement vector and unique ID.

ServerGeneratedImage(byte[] image, java.lang.String encodingScheme, java.lang.String mimeType, java.lang.String chartFile, MapElement[] map, java.lang.String uniqueID, int width, int height)
Create an ServerGeneratedImage 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 ServerGeneratedImage.
int	getDwellBorderSize() Get the border size of the dwelllabel.
java.lang.String	getDwellColor() Get the background color of the dwelllabel.
java.lang.String	getDwellFont() Get the font of the dwelllabel.
java.lang.String	getDwellFontColor() Get the font color of the dwelllabel.
int	getDwellFontSize() Get the font size of the dwelllabel.
java.lang.String	getEncodingScheme() Get the encoding scheme of the image data.
java.lang.String	getError() Get the error.
int	getHeight() Get the height of the image.
byte[]	getImage() Get the encoded image data.
MapElement[]	getMap() Get the MapElement array.
java.lang.String	getMapName() Get the ID of the map
java.lang.String	getMimeType() Get the mime type of the encoded image.
java.lang.String	getUniqueID() Get the unique ID of the ServerGeneratedImage.
int	getWidth() Get the width of the image.
boolean	load(byte[] serializedSGI) Load and initialize the ServerGeneratedImage 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 ServerGeneratedImage.
void	setDwellBorderSize(int dwellBorderSize) Set the border size of the dwelllabel.
void	setDwellColor(java.lang.String dwellColor) Set the background color of the dwelllabel.
void	setDwellFont(java.lang.String dwellFont) Set the font of the dwelllabel.
void	setDwellFontColor(java.lang.String dwellFontColor) Set the font color of the dwelllabel.
void	setDwellFontSize(int dwellFontSize) Set the font size of the dwelllabel.
void	setEncodingScheme(java.lang.String encodingScheme) Set the encoding scheme of the image data.
void	setError(java.lang.String error) Set the error.
void	setHeight(int height) Set the height of the image.
void	setImage(byte[] image) Set the encoded image data.
void	setMap(MapElement[] map) Set the MapElement array.
void	setMapName(java.lang.String mapName) Set the ID of the map.
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 ServerGeneratedImage.
void	setWidth(int width) Set the width of the image.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ServerGeneratedImage

public ServerGeneratedImage()

Create an empty ServerGeneratedImage.

ServerGeneratedImage

public ServerGeneratedImage(byte[] image,
                            java.lang.String mimeType)

Create a ServerGeneratedImage with the given image data and mime type.

Parameters:

image - The encoded image data.

mimeType - The mime type of the encoded image.

ServerGeneratedImage

public ServerGeneratedImage(byte[] image,
                            java.lang.String encodingScheme,
                            java.lang.String mimeType)

Create a ServerGeneratedImage with the given image data, encoding and mime type.

Parameters:

image - The encoded image data.

encodingScheme - The encoding scheme of the image data.

mimeType - The mime type of the encoded image.

ServerGeneratedImage

public ServerGeneratedImage(byte[] image,
                            java.lang.String encodingScheme,
                            java.lang.String mimeType,
                            java.lang.String chartFile,
                            MapElement[] map)

Create an ServerGeneratedImage with the given image data, mime type, MapElement vector and unique ID.

Parameters:

image - The encoded image data.

encodingScheme - The encoding scheme of the image data.

mimeType - The mime type of the encoded image.

chartFile - The chart file of the ServerGenerateImage.

map - The MapElement vector.

ServerGeneratedImage

public ServerGeneratedImage(byte[] image,
                            java.lang.String encodingScheme,
                            java.lang.String mimeType,
                            java.lang.String chartFile,
                            MapElement[] map,
                            java.lang.String uniqueID)

Create an ServerGeneratedImage with the given image data, mime type, MapElement vector and unique ID.

Parameters:

image - The encoded image data.

encodingScheme - The encoding scheme of the image data.

mimeType - The mime type of the encoded image.

chartFile - The chart file of the ServerGenerateImage.

map - The MapElement vector.

uniqueID - The unique ID of the ServerGeneratedImage.

ServerGeneratedImage

public ServerGeneratedImage(byte[] image,
                            java.lang.String encodingScheme,
                            java.lang.String mimeType,
                            java.lang.String chartFile,
                            MapElement[] map,
                            java.lang.String uniqueID,
                            int width,
                            int height)

Create an ServerGeneratedImage with the given image data, mime type, MapElement vector and unique ID.

Parameters:

image - The encoded image data.

encodingScheme - The encoding scheme of the image data.

mimeType - The mime type of the encoded image.

chartFile - The chart file of the ServerGenerateImage.

map - The MapElement vector.

uniqueID - The unique ID of the ServerGeneratedImage.

width - The width of the image.

height - The height of the image.

Method Detail

load

public boolean load(byte[] serializedSGI)

Load and initialize the ServerGeneratedImage from an XML based serialized form.

Parameters:

serializedSGI - The ServerGeneratedImage 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.

createUniqueID

public void createUniqueID()

Create the Unique ID of the image or retrieve it from the HTML.

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.

setDwellFont

public void setDwellFont(java.lang.String dwellFont)

Set the font of the dwelllabel. If the parameter is zero-length, no change will occur.

getDwellFont

public java.lang.String getDwellFont()

Get the font of the dwelllabel.

setDwellColor

public void setDwellColor(java.lang.String dwellColor)

Set the background color of the dwelllabel. If the parameter is zero-length, no change will occur.

getDwellColor

public java.lang.String getDwellColor()

Get the background color of the dwelllabel.

setDwellFontColor

public void setDwellFontColor(java.lang.String dwellFontColor)

Set the font color of the dwelllabel. If the parameter is zero-length, no change will occur.

getDwellFontColor

public java.lang.String getDwellFontColor()

Get the font color of the dwelllabel.

setDwellFontSize

public void setDwellFontSize(int dwellFontSize)

Set the font size of the dwelllabel.

getDwellBorderSize

public int getDwellBorderSize()

Get the border size of the dwelllabel.

setDwellBorderSize

public void setDwellBorderSize(int dwellBorderSize)

Set the border size of the dwelllabel.

getDwellFontSize

public int getDwellFontSize()

Get the font size of the dwelllabel.

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.

setEncodingScheme

public void setEncodingScheme(java.lang.String encodingScheme)

Set the encoding scheme of the image data.

getEncodingScheme

public java.lang.String getEncodingScheme()

Get the encoding scheme of the image data.

setMapName

public void setMapName(java.lang.String mapName)

Set the ID of the map.

getMapName

public java.lang.String getMapName()

Get the ID of the map

setMap

public void setMap(MapElement[] map)

Set the MapElement array.

getMap

public MapElement[] getMap()

Get the MapElement array.

setChartFile

public void setChartFile(java.lang.String chartFile)

Set the chart file of the ServerGeneratedImage.

getChartFile

public java.lang.String getChartFile()

Get the chart file of the ServerGeneratedImage.

setWidth

public void setWidth(int width)

Set the width of the image.

getWidth

public int getWidth()

Get the width of the image.

setHeight

public void setHeight(int height)

Set the height of the image.

getHeight

public int getHeight()

Get the height of the image.

setUniqueID

public void setUniqueID(java.lang.String uniqueID)

Set the unique ID of the ServerGeneratedImage.

getUniqueID

public java.lang.String getUniqueID()

Get the unique ID of the ServerGeneratedImage.

setError

public void setError(java.lang.String error)

Set the error.

getError

public java.lang.String getError()

Get the error.