oracle.dss.dataView

Interface ImageView

All Superinterfaces:

oracle.dss.presutil.CommonViewAttributes, ComponentTypeConverter, DataviewAttributes, DataviewCommon

All Known Implementing Classes:

CommonGauge, CommonGraph

public interface ImageView
extends DataviewAttributes, DataviewCommon

Image-based BI Beans views should implement this interface to ensure provide export to PNG and SVG and other image-related features.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	a_imageHeight
static java.lang.String	a_imageWidth
static int	SVG_HEADERS_ALL SvgHeaders: all.
static int	SVG_HEADERS_NONE SvgHeaders: none.
static int	SVG_MODE_BASIC SVG mode to simply render the Graph as static SVG.
static int	SVG_MODE_DATA_SCROLLING
static int	SVG_MODE_DATA_ZOOMING
static int	SVG_MODE_DRILLING
static int	SVG_MODE_FONT_EMBEDDING
static int	SVG_MODE_FULL SVG mode to render the Graph as interactive SVG.
static int	SVG_MODE_METADATA
static int	SVG_MODE_NO_HEADER
static int	SVG_MODE_SHAPE_ATTRIBUTES
static int	SVG_MODE_TIME_AXIS_EVENT
static int	SVG_MODE_TOOLTIPS

Method Summary

Modifier and Type	Method and Description
void	exportToFlash(java.io.OutputStream os, boolean renderDynamic, boolean showDrawing) Deprecated.
void	exportToPNG(java.io.OutputStream os)
void	exportToPNGWithException(java.io.OutputStream os) Exports a snapshot of this view as a PNG image.
void	exportToSVG(java.io.OutputStream os, int mode, java.lang.String charEnc)
void	exportToSVG(java.io.Writer writer, int mode, java.lang.String charEnc)
void	exportToSVGWithException(java.io.OutputStream os, int mode, java.lang.String charEnc)
void	exportToSVGWithException(java.io.Writer writer, int mode, java.lang.String charEnc)
void	exportToSWFWithException(java.io.OutputStream os, int mode, java.lang.String charEnc)
void	exportToXMLWithException(java.io.OutputStream os, int mode, java.lang.String charEnc)
void	exportToXMLWithException(java.io.Writer writer, int mode, java.lang.String charEnc)
java.lang.String	getAlternativeText(ComponentHandle handle)
int[]	getDrillParameters(ComponentHandle handle)
java.lang.String	getFlashPlayerDownloadMessageHTML(java.lang.String version, java.lang.String url)
java.util.Enumeration	getImagemapEnumeration(int filter) Required by subclasses, provides imagemap entries for tooltips and image maps
java.awt.Dimension	getImageSize() Retrieves the size of this view.
int	getSvgHeaders()
java.util.List	getSvgScriptIdList()
SVGWriterProvider	getSVGWriterProvider()
void	refreshData()
void	setDVTResources(DVTResources res) Specifies Wrapped RichBundle
void	setImageSize(java.awt.Dimension d) Specifies a size for this view.
void	setStylePath(java.lang.String stylePath)
void	setSvgHeaders(int headers)
void	setSVGWriterProvider(SVGWriterProvider provider)
boolean	setTabularData(java.util.List tableRows)

Methods inherited from interface oracle.dss.dataView.DataviewAttributes

getHTMLPagingControlWidth, getLayerMetadataLabelType, getMemberMetadataLabelType, getPagingControlPosition, isDrillingEnabled, isDrillingSupported, isHTMLPagingControlAutosubmit, isPagingControlVisible, setDrillingEnabled, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setLayerMetadataLabelType, setMemberMetadataLabelType, setPagingControlPosition, setPagingControlVisible

Methods inherited from interface oracle.dss.presutil.CommonViewAttributes

getDescription, getLocalName, getName, setDescription, setLocalName, setName

Methods inherited from interface oracle.dss.dataView.DataviewCommon

createPropertyOverrideFlags, dataFormatChanged, dataStyleChanged, getDataSource, getDataviewFootnote, getDataviewSubtitle, getDataviewTitle, getErrorHandler, getFontList, getHTMLPagingControlWidth, getIntlString, getIntlString, getLayerMetadataLabelType, getLocale, getMemberMetadataLabelType, getModel, getTokenSubstitution, getViewType, getWaitDataForRow, getZoomFactor, isDataUnformattedSupported, isDataViewFormatSupported, isHTMLPagingControlAutosubmit, isLayerMetadataLabelTypeSupported, isLayerMetaShortLabelSupported, isLayerMetaViewStyleSupported, isMemberMetadataLabelTypeSupported, isMetadataShortLabelSupported, isMetadataViewStyleSupported, isPagingControlVisible, isPropertyOverrideFlag, metadataStyleChanged, repaint, scaleFont, setDataSource, setHTMLPagingControlAutosubmit, setHTMLPagingControlWidth, setPagingControlVisible, setPropertyOverrideFlags, setTokenSubstitution, setWaitDataForRow

Methods inherited from interface oracle.dss.rules.ComponentTypeConverter

convertComponentTypeToInteger, convertComponentTypeToString

Field Detail

a_imageWidth

@Concealed
static final java.lang.String a_imageWidth

See Also:

Constant Field Values

For internal use only. Application developers should not use this

a_imageHeight

@Concealed
static final java.lang.String a_imageHeight

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG_MODE_NO_HEADER

@Concealed
static final int SVG_MODE_NO_HEADER

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG mode to render the Graph as static SVG with no XML header. TBD: this was added for a demo, can it be removed now?

SVG_MODE_BASIC

static final int SVG_MODE_BASIC

SVG mode to simply render the Graph as static SVG.

See Also:

Constant Field Values

SVG_MODE_TOOLTIPS

@Concealed
static final int SVG_MODE_TOOLTIPS

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG mode to render the Graph with tooltips.

SVG_MODE_DRILLING

@Concealed
static final int SVG_MODE_DRILLING

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG mode to render the Graph with drilling enabled. This is only used for JSF Graph, and will not work for Java-client Graph.

SVG_MODE_DATA_ZOOMING

@Concealed
static final int SVG_MODE_DATA_ZOOMING

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG mode to render the Graph with data zooming enabled. This is only used for JSF Graph, and will not work for Java-client Graph.

SVG_MODE_SHAPE_ATTRIBUTES

@Concealed
static final int SVG_MODE_SHAPE_ATTRIBUTES

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG mode to render the Graph with ShapeAttributes enabled. This is only used for JSF Graph, and will not work for Java-client Graph.

SVG_MODE_FONT_EMBEDDING

@Concealed
static final int SVG_MODE_FONT_EMBEDDING

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG mode to embed fonts in SVG.

SVG_MODE_DATA_SCROLLING

@Concealed
static final int SVG_MODE_DATA_SCROLLING

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG mode to render the Graph with data scrolling enabled. This is only used for JSF Graph, and will not work for Java-client Graph.

SVG_MODE_TIME_AXIS_EVENT

@Concealed
static final int SVG_MODE_TIME_AXIS_EVENT

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG mode to render plot area with onclick handler. This is only used for JSF Graph, and will not work for Java-client Graph.

SVG_MODE_METADATA

@Concealed
static final int SVG_MODE_METADATA

See Also:

Constant Field Values

For internal use only. Application developers should not use this

SVG mode to include graph metadata in the SVG.

SVG_MODE_FULL

static final int SVG_MODE_FULL

SVG mode to render the Graph as interactive SVG.

See Also:

Constant Field Values

SVG_HEADERS_NONE

static final int SVG_HEADERS_NONE

SvgHeaders: none. Do not include header XML in exported SVG.

See Also:

Constant Field Values

SVG_HEADERS_ALL

static final int SVG_HEADERS_ALL

SvgHeaders: all. Include all header XML in exported SVG.

See Also:

Constant Field Values

Method Detail

getImageSize

java.awt.Dimension getImageSize()

Retrieves the size of this view.

Returns:

The size of the view, in a Dimension object.

setImageSize

void setImageSize(java.awt.Dimension d)

Specifies a size for this view.

Parameters:

d - The size to make the view.

refreshData

@Concealed
void refreshData()

For internal use only. Application developers should not use this

Refreshes the display.

getDrillParameters

@Concealed
int[] getDrillParameters(ComponentHandle handle)

For internal use only. Application developers should not use this

Returns drill parameters for a given component The return value will be null if component is not drillable Otherwise, an integer array will be returned, where: index 0 - Edge parameter index 1 - Layer parameter index 2 - Slice parameter

getAlternativeText

@Concealed
java.lang.String getAlternativeText(ComponentHandle handle)

For internal use only. Application developers should not use this

returns alternative text for drill related components

setTabularData

@Concealed
boolean setTabularData(java.util.List tableRows)

Parameters:

tableRows - List of data to plot in the image view.

Returns:

true if data is successfully set on the image view, false if there is a data problem.

For internal use only. Application developers should not use this

Specifies data for the ImageView, from a table of data. Use this method to provide data row-by-row, from a file of tab-delimited or comma-separated values, or from a JDBC ResultSet.

When you use this method, you extract values from the file or ResultSet, organize them, and then pass them all in one call to this method. The image view creates a grid of data from the data that you pass in, and it uses this grid to populate itself.

For each data value in the table or result set, you construct an array of three Objects:

• The object at index 0 is the label for the column, in the grid that the image view constructs, in which the data item belongs. This is normally a String.
• The object at index 1 is the label for the row, in the grid that the image view constructs, in which the data item belongs. This is normally a String.
• The object at index 2 is the data value, usually a Double.

You add each Object array to a List (normally an ArrayList or a Vector). You pass the complete List to this method.

The following table shows a set of data to pass to the image view through this method:

Boston	Bowties	97300
Boston	Neckties	413812
Cleveland	Bowties	48025
Cleveland	Neckties	298511

The Object arrays would look like this, if you want the types of ties to appear in the legend (assuming that data rows in the grid represent series):

 Object[] tableRow1 = {"Boston", "Bowties", new Double(97300)};
 Object[] tableRow2 = {"Boston", "Neckties", new Double(413812)};
 Object[] tableRow3 = {"Cleveland", "Bowties", new Double(48025)};
 Object[] tableRow4 = {"Cleveland", "Neckties", new Double(298511)};

 // add the arrays to a List
 ArrayList data = new ArrayList();
 data.add(tableRow1);
 data.add(tableRow2);
 data.add(tableRow3);
 data.add(tableRow4);

 // pass the List to this method
 imgView.setTabularData(data);
 

The grid that this method constructs and feeds to the image view looks like this:

	Boston	Cleveland
Bowties	97300	48025
Neckties	413812	298511

Note that the data is not interactive. If you want users to be able to rotate or drill, you will have to provide a way for them to express that intention, and you must call this method again to display the rearranged data.

exportToPNG

@Concealed
void exportToPNG(java.io.OutputStream os)

Parameters:

os - The OutputStream that specifies the location and name of the PNG file.

See Also:

exportToPNGWithException(java.io.OutputStream)

For internal use only. Application developers should not use this

Exports a snapshot of this view as a PNG image.

exportToPNGWithException

void exportToPNGWithException(java.io.OutputStream os)
                       throws oracle.dss.graph.pfj.png.PNGInvalidParameterException,
                              java.lang.Exception

Exports a snapshot of this view as a PNG image.

Parameters:

os - The OutputStream that specifies the location and name of the PNG file.

Throws:

oracle.dss.graph.pfj.png.PNGInvalidParameterException

java.lang.Exception

See Also:

exportToPNG(java.io.OutputStream)

exportToSVG

@Concealed
void exportToSVG(java.io.OutputStream os,
                            int mode,
                            java.lang.String charEnc)

Parameters:

os - The OutputStream to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

For internal use only. Application developers should not use this

Exports a snapshot of this view as SVG.

exportToSVGWithException

@Concealed
void exportToSVGWithException(java.io.OutputStream os,
                                         int mode,
                                         java.lang.String charEnc)
                                  throws java.io.IOException,
                                         java.lang.Exception

Parameters:

os - The OutputStream to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

For internal use only. Application developers should not use this

Exports a snapshot of the view as SVG.

exportToSVG

@Concealed
void exportToSVG(java.io.Writer writer,
                            int mode,
                            java.lang.String charEnc)

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

For internal use only. Application developers should not use this

Exports a snapshot of this view as SVG.

exportToSVGWithException

@Concealed
void exportToSVGWithException(java.io.Writer writer,
                                         int mode,
                                         java.lang.String charEnc)
                                  throws java.io.IOException,
                                         java.lang.Exception

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in SVG; constants are defined in this class and begin with SVG_MODE_

charEnc - character encoding to use for SVG

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

For internal use only. Application developers should not use this

Exports a snapshot of the view as SVG.

exportToXMLWithException

@Concealed
void exportToXMLWithException(java.io.OutputStream os,
                                         int mode,
                                         java.lang.String charEnc)
                                  throws java.io.IOException,
                                         java.lang.Exception

Parameters:

os - The OutputStream to write XML to.

mode - specifies what to include in XML; currently not used

charEnc - character encoding to use for XML

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

For internal use only. Application developers should not use this

Exports a snapshot of the page that is currently displayed to the XML file.

exportToXMLWithException

@Concealed
void exportToXMLWithException(java.io.Writer writer,
                                         int mode,
                                         java.lang.String charEnc)
                                  throws java.io.IOException,
                                         java.lang.Exception

Parameters:

writer - The Writer to write SVG to.

mode - specifies what to include in XML; currently not used

charEnc - character encoding to use for XML

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

For internal use only. Application developers should not use this

Exports a snapshot of the page that is currently displayed to the XML file.

exportToSWFWithException

@Concealed
void exportToSWFWithException(java.io.OutputStream os,
                                         int mode,
                                         java.lang.String charEnc)
                                  throws java.io.IOException,
                                         java.lang.Exception

Parameters:

os - The OutputStream to write the SWF to.

mode - specifies what to include in SWF; currently not used

charEnc - character encoding to use

Throws:

java.io.IOException - if there was a problem writing to the stream

java.lang.Exception - if another problem occurred

For internal use only. Application developers should not use this

Exports a snapshot of the page that is currently displayed to the SWF file. This method first exports the view to XML, and then injects the XML into the SWF.

exportToFlash

@Deprecated
 @Concealed
void exportToFlash(java.io.OutputStream os,
                                           boolean renderDynamic,
                                           boolean showDrawing)

Deprecated.

Parameters:

os - the outputstream associated with the flash file

renderDynamic - Flag indicating if the rendering will be dynamic or static. For static charts, the value is false.

showDrawing - Only applicable for static charts and indicates if the drawing of the chart should be shown.

For internal use only. Application developers should not use this

Exports a snapshot of the view as Flash.

getImagemapEnumeration

java.util.Enumeration getImagemapEnumeration(int filter)

Required by subclasses, provides imagemap entries for tooltips and image maps

setStylePath

@Concealed
void setStylePath(java.lang.String stylePath)
                      throws java.io.IOException,
                             oracle.dss.util.xml.BIIOException,
                             oracle.dss.util.xml.BISAXException,
                             oracle.dss.util.xml.BIParseException

Parameters:

stylePath - The path of the XML to set as a style on this view.

Throws:

java.io.IOException - If there is a problem loading the specified XML file.

oracle.dss.util.xml.BIIOException - If there is a problem reading the XML file.

oracle.dss.util.xml.BISAXException - If a general SAX exception occurs in parsing the XML.

oracle.dss.util.xml.BIParseException - If the XML syntax is incorrect, or if the XML is not valid according to the DTD that is specified in the XML.

For internal use only. Application developers should not use this

Applies a style to this view based on the specified XML file.

setSVGWriterProvider

@Concealed
void setSVGWriterProvider(SVGWriterProvider provider)

Parameters:

provider - Instance of SVGWriterProvider used to create an SVGWriter instance

For internal use only. Application developers should not use this

Set the provider used to create an SVG writer for exporting to SVG.

getSVGWriterProvider

@Concealed
SVGWriterProvider getSVGWriterProvider()

Returns:

Instance of SVGWriterProvider used to create an SVGWriter instance

For internal use only. Application developers should not use this

Get the provider used to create an SVG writer for exporting to SVG.

setSvgHeaders

@Concealed
void setSvgHeaders(int headers)

Parameters:

headers - constant indicating whether to include headers in exported SVG

For internal use only. Application developers should not use this

Set whether headers are included in exported SVG. Valid constants begin with SVG_HEADERS_.

getSvgHeaders

@Concealed
int getSvgHeaders()

Returns:

constant indicating whether to include headers in exported SVG

For internal use only. Application developers should not use this

Determine whether headers are included in exported SVG.

getSvgScriptIdList

@Concealed
java.util.List getSvgScriptIdList()

Returns:

list of SVG script node ids

For internal use only. Application developers should not use this

Get the list of SVG script node ids.

getFlashPlayerDownloadMessageHTML

@Concealed
java.lang.String getFlashPlayerDownloadMessageHTML(java.lang.String version,
                                                              java.lang.String url)

Parameters:

version - required version

url - URL to get the Flash player

Returns:

String message indicating that the required version of the Flash player is not installed

For internal use only. Application developers should not use this

Get the HTML message to display indicating that the required version of the Flash player is not installed. The given URL will be included as a link in the message text.

setDVTResources

void setDVTResources(DVTResources res)

Specifies Wrapped RichBundle