|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
public interface ImageView
Image-based BI Beans views should implement this interface to ensure provide export to PNG and SVG and other image-related features.
Field Summary | |
---|---|
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 | |
---|---|
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.presutil.CommonViewAttributes |
---|
getDescription, getLocalName, getName, setDescription, setLocalName, setName |
Methods inherited from interface oracle.dss.rules.ComponentTypeConverter |
---|
convertComponentTypeToInteger, convertComponentTypeToString |
Field Detail |
---|
static final java.lang.String a_imageWidth
static final java.lang.String a_imageHeight
static final int SVG_MODE_NO_HEADER
static final int SVG_MODE_BASIC
static final int SVG_MODE_TOOLTIPS
static final int SVG_MODE_DRILLING
static final int SVG_MODE_DATA_ZOOMING
static final int SVG_MODE_SHAPE_ATTRIBUTES
static final int SVG_MODE_FONT_EMBEDDING
static final int SVG_MODE_DATA_SCROLLING
static final int SVG_MODE_TIME_AXIS_EVENT
static final int SVG_MODE_METADATA
static final int SVG_MODE_FULL
static final int SVG_HEADERS_NONE
static final int SVG_HEADERS_ALL
Method Detail |
---|
java.awt.Dimension getImageSize()
Dimension
object.void setImageSize(java.awt.Dimension d)
d
- The size to make the view.void refreshData()
int[] getDrillParameters(ComponentHandle handle)
java.lang.String getAlternativeText(ComponentHandle handle)
boolean setTabularData(java.util.List tableRows)
tableRows
- List
of data to plot in the image view.true
if data is successfully set on the image view, false
if there is a data problem.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
:
String
.String
.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 aList
ArrayList data = new ArrayList(); data.add(tableRow1); data.add(tableRow2); data.add(tableRow3); data.add(tableRow4); // pass theList
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.
void exportToPNG(java.io.OutputStream os)
os
- The OutputStream
that specifies the location and name of the PNG file.exportToPNGWithException(java.io.OutputStream)
void exportToPNGWithException(java.io.OutputStream os) throws oracle.dss.graph.pfj.png.PNGInvalidParameterException, java.lang.Exception
os
- The OutputStream
that specifies the location and name of the PNG file.oracle.dss.graph.pfj.png.PNGInvalidParameterException
java.lang.Exception
exportToPNG(java.io.OutputStream)
void exportToSVG(java.io.OutputStream os, int mode, java.lang.String charEnc)
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 SVGvoid exportToSVGWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) throws java.io.IOException, java.lang.Exception
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 SVGjava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredvoid exportToSVG(java.io.Writer writer, int mode, java.lang.String charEnc)
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 SVGvoid exportToSVGWithException(java.io.Writer writer, int mode, java.lang.String charEnc) throws java.io.IOException, java.lang.Exception
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 SVGjava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredvoid exportToXMLWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) throws java.io.IOException, java.lang.Exception
os
- The OutputStream
to write XML to.mode
- specifies what to include in XML; currently not usedcharEnc
- character encoding to use for XMLjava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredvoid exportToXMLWithException(java.io.Writer writer, int mode, java.lang.String charEnc) throws java.io.IOException, java.lang.Exception
writer
- The Writer
to write SVG to.mode
- specifies what to include in XML; currently not usedcharEnc
- character encoding to use for XMLjava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurredvoid exportToSWFWithException(java.io.OutputStream os, int mode, java.lang.String charEnc) throws java.io.IOException, java.lang.Exception
os
- The OutputStream
to write the SWF to.mode
- specifies what to include in SWF; currently not usedcharEnc
- character encoding to usejava.io.IOException
- if there was a problem writing to the streamjava.lang.Exception
- if another problem occurred
@Deprecated
void exportToFlash(java.io.OutputStream os,
boolean renderDynamic,
boolean showDrawing)
os
- the outputstream associated with the flash filerenderDynamic
- 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.java.util.Enumeration getImagemapEnumeration(int filter)
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
stylePath
- The path of the XML to set as a style on this view.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.void setSVGWriterProvider(SVGWriterProvider provider)
provider
- Instance of SVGWriterProvider
used to create an SVGWriter
instanceSVGWriterProvider getSVGWriterProvider()
SVGWriterProvider
used to create an SVGWriter
instancevoid setSvgHeaders(int headers)
headers
- constant indicating whether to include headers in exported SVGint getSvgHeaders()
java.util.List getSvgScriptIdList()
java.lang.String getFlashPlayerDownloadMessageHTML(java.lang.String version, java.lang.String url)
version
- required versionurl
- URL to get the Flash playervoid setDVTResources(DVTResources res)
|
Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components 11g Release 2 (11.1.2.3.0) E17492-04 |
||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |