oracle.dss.dataView
Class AlertEvent

java.lang.Object
  |
  +--java.util.EventObject
        |
        +--oracle.dss.dataView.AlertEvent

All Implemented Interfaces:

java.io.Serializable

public class AlertEvent

extends java.util.EventObject

The event that contains the information about a problem. The problem may be of interest to the application, but it is not necessarily an error condition. Some problems are related to the data that is passed to the graph.

For more information about data requirements for different graph types, see the BI Beans Help system.

See Also:

Serialized Form

Field Summary

static int	AXIS_TITLE_TRUNCATED ID: The axis title is truncated.
static int	DATA_ALL_AXIS_DATA_NULL ID: All data that is passed to any graph axis is null.
static int	DATA_ALL_AXIS_DATA_NULL_NEG_ZERO ID: All of the data is null, a negative value, or zero, for a logarithmically scaled axis.
static int	DATA_ALL_DATA_NULL ID: All data is null.
static int	DATA_ALL_DATA_NULL_NEG_ZERO ID: All of the data is null, a negative value, or zero, and the graph type requires positive data.
static int	DATA_PARTIAL_DATA_NULL ID: Some of the data is null.
static int	DATA_PARTIAL_DATA_NULL_NEG_ZERO ID: Some of the data is null, a negative value, or zero, and the graph type requires positive data.
static int	DATA_PARTIAL_GROUP ID: There are not enough data points for each group of data.
static int	DATA_STOCK_HIGH_LT_LOW_VALUE ID: In a stock graph, the data for the high value of a stock is less than the low value.
static int	DATA_STOCK_OPEN_OR_CLOSE_OUT_OF_RANGE ID: In a stock graph, the opening or closing value is higher than the high value or lower than the low value.
static int	LEGEND_MARKERS_NOT_ALL_DISPLAYED ID: There is not enough room in the legend area to display a marker for each series that the graph displays.
static int	LEGEND_TEXT_TRUNCATED ID: The legend text cannot all be displayed in the legend area.
static int	TITLE_TEXT_TRUNCATED ID: The title text is truncated.

Constructor Summary

AlertEvent(java.lang.Object source, int id)
Constructor.

Method Summary

int	getID() Retrieves a constant that identifies the type of problem.

Methods inherited from class java.util.EventObject

getSource, toString

Methods inherited from class java.lang.Object

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

Field Detail

LEGEND_TEXT_TRUNCATED

public static final int LEGEND_TEXT_TRUNCATED

ID: The legend text cannot all be displayed in the legend area. There may be too many series, or the labels may be too long, or the font size that has been specified for the legend text may be too large.

See Also:

Graph.setAutoLayout(int)

LEGEND_MARKERS_NOT_ALL_DISPLAYED

public static final int LEGEND_MARKERS_NOT_ALL_DISPLAYED

ID: There is not enough room in the legend area to display a marker for each series that the graph displays. During automatic layout of components, the graph tries to increase the legend area size to display a marker for each series that appears in the graph. If, however, there is a large number of series, the space for legend markers is limited. The graph tries to make each item smaller, and it truncates the legend text, before it reports this problem. If you get this alert ID, you should consider limiting the amount of data that appears in the graph.

See Also:

Graph.setAutoLayout(int)

AXIS_TITLE_TRUNCATED

public static final int AXIS_TITLE_TRUNCATED

ID: The axis title is truncated. The rectangle for the axis title is the same as the edge of the plot area. If the number of series and series labels causes the legend to be especially large, the automatic layout feature of the graph reduces the size of the plot area, and so, of the rectangles for the axis titles. If you get an alert with this ID, consider reducing the number of series in the graph or specifying a shorter axis title.

See Also:

Graph.setAutoLayout(int)

DATA_PARTIAL_GROUP

public static final int DATA_PARTIAL_GROUP

ID: There are not enough data points for each group of data. In a scatter, polar, bubble, or stock graph, each group requires more than one data value. The data that was passed in does not have a number of columns (or rows, if rows map to groups) that divides evenly by the number of data points required for each group in the current graph type.

For example, a scatter graph requires two data points in each group. If the data has an odd number of columns, then the last group does not have a complete set of data.

You can call oracle.dss.graph.Graph.getGroupSize to find out how many data points are required in a group.

See Also:

Graph.getGroupSize(int)

DATA_STOCK_HIGH_LT_LOW_VALUE

public static final int DATA_STOCK_HIGH_LT_LOW_VALUE

ID: In a stock graph, the data for the high value of a stock is less than the low value. In a stock graph, the order of the data that is passed to the graph determines how the graph interprets the data. The high value is passed before the low value.

For example, if the GraphType is Graph.STOCK_HILO_CLOSE, then the group values must be passed in this order:

1. High value
2. Low value
3. Closing value

If the data is passed with the low value first, an alert with this alert ID is sent to the AlertListener. If the order is correct, then the problem is with individual data values.

DATA_STOCK_OPEN_OR_CLOSE_OUT_OF_RANGE

public static final int DATA_STOCK_OPEN_OR_CLOSE_OUT_OF_RANGE

ID: In a stock graph, the opening or closing value is higher than the high value or lower than the low value. In a high-low-close or open-high-low-close stock graph, the opening and closing values should be between the high and low values. In a stock graph, the order of the data that is passed to the graph determines how the graph interprets the data. The order in which you must pass data to such graphs is as follows:

1. Opening value (if the graph type displays opening values)
2. High value (first if no opening)
3. Low value
4. Closing value
5. Trading volume, if the graph type displays volume

DATA_ALL_DATA_NULL_NEG_ZERO

public static final int DATA_ALL_DATA_NULL_NEG_ZERO

ID: All of the data is null, a negative value, or zero, and the graph type requires positive data. Pie graphs, percent graphs (such as a percent bar graph), and pareto graphs expect that all of the data is positive. Graphs that have an axis that is scaled logarithmically expect that all of the data for that axis is positive.

DATA_ALL_DATA_NULL

public static final int DATA_ALL_DATA_NULL

ID: All data is null. All graph types require non-null data.

DATA_PARTIAL_DATA_NULL_NEG_ZERO

public static final int DATA_PARTIAL_DATA_NULL_NEG_ZERO

ID: Some of the data is null, a negative value, or zero, and the graph type requires positive data. Pie graphs, percent graphs (such as a percent bar graph), pareto graphs, and graphs that have an axis that is scaled logarithmically expect that all of the data is positive.

DATA_PARTIAL_DATA_NULL

public static final int DATA_PARTIAL_DATA_NULL

ID: Some of the data is null. The graph does not display markers for null data.

DATA_ALL_AXIS_DATA_NULL_NEG_ZERO

public static final int DATA_ALL_AXIS_DATA_NULL_NEG_ZERO

ID: All of the data is null, a negative value, or zero, for a logarithmically scaled axis. Graphs that have an axis that is scaled logarithmically should have all positive data for that axis. The graph sends an alert with this ID if you have two data axes, and all of the data assigned to one of these axes is negative, null, or zero.

DATA_ALL_AXIS_DATA_NULL

public static final int DATA_ALL_AXIS_DATA_NULL

ID: All data that is passed to any graph axis is null. One example of this is a scatter graph for which all the data that should be plotted on the X-axis is null. Another example is a dual-Y graph for which all the data for the Y1-axis is null.

TITLE_TEXT_TRUNCATED

public static final int TITLE_TEXT_TRUNCATED

ID: The title text is truncated. During automatic graph layout, the graph found that the title text is too long for it to be displayed fully in the graph.

See Also:

Graph.setAutoLayout(int)

Constructor Detail

AlertEvent

public AlertEvent(java.lang.Object source,
                  int id)

Constructor.

Parameters:

source - The source of this event.

id - A constant that identifies the type of problem that occurred.

Method Detail

getID

public int getID()

Retrieves a constant that identifies the type of problem.

Returns:

A constant that identifies the type of problem that occurred. Valid constants are listed in the See Also section.

See Also:

LEGEND_TEXT_TRUNCATED, LEGEND_MARKERS_NOT_ALL_DISPLAYED, TITLE_TEXT_TRUNCATED, AXIS_TITLE_TRUNCATED, DATA_ALL_AXIS_DATA_NULL, DATA_ALL_AXIS_DATA_NULL_NEG_ZERO, DATA_ALL_DATA_NULL, DATA_ALL_DATA_NULL_NEG_ZERO, DATA_PARTIAL_DATA_NULL, DATA_PARTIAL_GROUP, DATA_PARTIAL_DATA_NULL_NEG_ZERO, DATA_STOCK_HIGH_LT_LOW_VALUE, DATA_STOCK_OPEN_OR_CLOSE_OUT_OF_RANGE