netcharts.pro.util
Class NFServerGeneratedImage

java.lang.Object
  |
  +--netcharts.pro.util.NFServerGeneratedImage

All Implemented Interfaces:

java.io.Serializable

public class NFServerGeneratedImage

extends java.lang.Object

implements java.io.Serializable

This class holds all the information related to a server generated image. This includes the encoded image data, the mime type of the data, a width, a height, an array of MapElements to create an html imagemap, a textual description, and associated unique ID.

See Also:

Serialized Form

Inner Class Summary

static class

NFServerGeneratedImage.MapElement Internal representation of an image map element.

Constructor Summary

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

NFServerGeneratedImage(byte[] image, java.lang.String mimeType, int width, int height, NFServerGeneratedImage.MapElement[] map, java.lang.String textualDescription, java.lang.String uniqueID)
Create an NFServerGeneratedImage with the given image data, mime type, width, height, MapElement vector, textual description, and unique ID.

Method Summary

int	getHeight() Get the height of the image.
byte[]	getImage() Get the encoded image data.
NFServerGeneratedImage.MapElement[]	getMap() Get the MapElement array.
java.lang.String	getMimeType() Get the mime type of the encoded image.
java.lang.String	getTextualDescription() Get the textual description of the image.
java.lang.String	getTextualDescriptionInALTFormat() Get the textual description of the image in a format suitable for use in the ALT attribute of an IMG tag in an HTML page.
java.lang.String	getTextualDescriptionInHTMLFormat() Get the textual description of the image in a format suitable for use in an HTML page.
java.lang.String	getUniqueID() Get the unique ID of the NFServerGeneratedImage.
int	getWidth() Get the width of the image.
void	setHeight(int height) Set the height of the image.
void	setImage(byte[] image) Set the encoded image data.
void	setMap(NFServerGeneratedImage.MapElement[] map) Set the MapElement array.
void	setMimeType(java.lang.String mimeType) Set the mime type of the encoded image.
void	setTextualDescription(java.lang.String textualDescription) Set the textual description of the image.
void	setUniqueID(java.lang.String uniqueID) Set the unique ID of the NFServerGeneratedImage.
void	setWidth(int width) Set the width of the image.
java.lang.String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

NFServerGeneratedImage

public NFServerGeneratedImage(byte[] image,
                              java.lang.String mimeType,
                              int width,
                              int height)

Create a NFServerGeneratedImage with the given image data, mime type, width, and height.

Parameters:

image - The encoded image data.

mimeType - The mime type of the encoded image.

width - The width of the image.

height - The height of the image.

NFServerGeneratedImage

public NFServerGeneratedImage(byte[] image,
                              java.lang.String mimeType,
                              int width,
                              int height,
                              NFServerGeneratedImage.MapElement[] map,
                              java.lang.String textualDescription,
                              java.lang.String uniqueID)

Create an NFServerGeneratedImage with the given image data, mime type, width, height, MapElement vector, textual description, and unique ID.

Parameters:

image - The encoded image data.

mimeType - The mime type of the encoded image.

width - The width of the image.

height - The height of the image.

map - The MapElement vector.

textualDescription - The textual description of the image.

uniqueID - The unique ID of the NFServerGeneratedImage.

Method Detail

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.

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.

setMap

public void setMap(NFServerGeneratedImage.MapElement[] map)

Set the MapElement array.

getMap

public NFServerGeneratedImage.MapElement[] getMap()

Get the MapElement array.

setTextualDescription

public void setTextualDescription(java.lang.String textualDescription)

Set the textual description of the image.

getTextualDescription

public java.lang.String getTextualDescription()

Get the textual description of the image.

getTextualDescriptionInHTMLFormat

public java.lang.String getTextualDescriptionInHTMLFormat()

Get the textual description of the image in a format suitable for use in an HTML page.

getTextualDescriptionInALTFormat

public java.lang.String getTextualDescriptionInALTFormat()

Get the textual description of the image in a format suitable for use in the ALT attribute of an IMG tag in an HTML page.

setUniqueID

public void setUniqueID(java.lang.String uniqueID)

Set the unique ID of the NFServerGeneratedImage.

getUniqueID

public java.lang.String getUniqueID()

Get the unique ID of the NFServerGeneratedImage.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object