oracle.dss.graph
Class Threshold

java.lang.Object
  oracle.dss.dataView.BaseComponentXML
      oracle.dss.graph.BaseGraphComponent
          oracle.dss.graph.Threshold

All Implemented Interfaces:

UIThresholdColor

public class Threshold
extends BaseGraphComponent
implements UIThresholdColor

The threshold component of the funnel graph. A threshold usually represents a range of percent values with a color.

Field Summary

protected int

m_thresholdCount

Fields inherited from class oracle.dss.graph.BaseGraphComponent

a_assignedToY2, a_association, a_automaticRotation, a_axisAutoScaledFromZero, a_axisMaxAutoScaled, a_axisMaxValue, a_axisMinAutoScaled, a_axisMinValue, a_axisZoomMaxValue, a_axisZoomMinValue, a_backGround, a_borderStyle, a_borderTransparent, a_borderUsingDefaults, a_borderWidth, a_color, a_defaultAssignedToY2, a_defaultBorderColor, a_defaultBorderTransparent, a_defaultColor, a_defaultFitlineType, a_defaultLineWidth, a_defaultMarkerColor, a_defaultMarkerShape, a_defaultMarkerType, a_displayedInLegend, a_explicitEnd, a_explicitStart, a_fitlineType, a_focusFactor, a_group, a_height, a_high_value, a_horizontalAlignment, a_imageSource, a_isometricProjection, a_labelPosition, a_legendMarkersPerRow, a_legendOrientation, a_legendTextPosition, a_lightSourceX, a_lightSourceY, a_lightSourceZ, a_line_value, a_lineColor, a_lineIndex, a_lineStyle, a_lineWidth, a_location, a_logarithmicBase, a_low_value, a_majorTickStep, a_majorTickStepAutomatic, a_markerColor, a_markerShape, a_markerSize, a_markersPerRowAutomatic, a_markerTextAngleDefault, a_markerTextPlace, a_markerTextRadiusDefault, a_markerType, a_minorTickStep, a_minorTickStepType, a_mode, a_panX, a_panY, a_pieSliceExplode, a_quadrantLineCountX, a_quadrantLineCountY, a_quadrantLineValueX, a_quadrantLineValueY, a_rendered, a_rollover_behavior, a_scaledLogarithmic, a_series, a_sharePanelProperties, a_sizeX, a_sizeY, a_sizeZ, a_skippedWithLabels, a_squareRisers, a_text, a_textFittingAutomatic, a_textRotation, a_textType, a_thresholdMaxValue, a_thresholdMinValue, a_tickLabelSkipCount, a_tickLabelSkipFirst, a_tickLabelSkipMode, a_tickLabelStaggered, a_tickLabelWrapped, a_tickStyle, a_translationX, a_translationY, a_translationZ, a_transparent, a_type, a_verticalAlignment, a_viewerX, a_viewerY, a_viewerZ, a_visibility, a_visible, a_wallThickX, a_wallThickY, a_wallThickZ, a_width, a_wordWrapEnabled, a_x, a_xValue, a_y, a_yValue, a_yValueAssignment, a_zoomFactor, al_both, AL_BOTH, al_left, AL_LEFT, al_right, AL_RIGHT, ap_always, AP_ALWAYS, ap_never, AP_NEVER, ar_horiz_rotate_270, AR_HORIZ_ROTATE_270, ar_horiz_rotate_90, AR_HORIZ_ROTATE_90, ar_no_rotate, AR_NO_ROTATE, dy2_auto_assign, DY2_AUTO_ASSIGN, dy2_false, DY2_FALSE, dy2_true, DY2_TRUE, FP_LG_CHECK, FP_LG_CROSSHATCH, FP_LG_DIAG_UP_LT, FP_LG_DIAG_UP_RT, FP_LG_DIAMOND_CHECK, FP_LG_TRIANGLE_CHECK, FP_MAX, FP_SM_CHECK, FP_SM_CROSSHATCH, FP_SM_DIAG_UP_LT, FP_SM_DIAG_UP_RT, FP_SM_DIAMOND_CHECK, FP_SM_TRIANGLE_CHECK, fs_bold, FS_BOLD, fs_bold_italic_underline, FS_BOLD_ITALIC_UNDERLINE, fs_bold_underline, FS_BOLD_UNDERLINE, fs_italic, FS_ITALIC, fs_italic_bold, FS_ITALIC_BOLD, fs_italic_underline, FS_ITALIC_UNDERLINE, fs_plain, FS_PLAIN, fs_underline, FS_UNDERLINE, ft_color, FT_COLOR, ft_exponential, FT_EXPONENTIAL, ft_gradient, FT_GRADIENT, ft_linear, FT_LINEAR, ft_logarithmic, FT_LOGARITHMIC, ft_none, FT_NONE, FT_PATTERN, ft_texture, FT_TEXTURE, gd_diagonal_135, GD_DIAGONAL_135, gd_diagonal_45, GD_DIAGONAL_45, gd_down, GD_DOWN, gd_down_left, GD_DOWN_LEFT, gd_down_right, GD_DOWN_RIGHT, gd_left, GD_LEFT, gd_radial, GD_RADIAL, gd_radial_bottom_left, GD_RADIAL_BOTTOM_LEFT, gd_radial_bottom_right, GD_RADIAL_BOTTOM_RIGHT, gd_radial_top_left, GD_RADIAL_TOP_LEFT, gd_radial_top_right, GD_RADIAL_TOP_RIGHT, gd_right, GD_RIGHT, gd_up, GD_UP, gd_up_left, GD_UP_LEFT, gd_up_right, GD_UP_RIGHT, gs_automatic, GS_AUTOMATIC, gs_extended, GS_EXTENDED, gs_grid, GS_GRID, gs_in, GS_IN, gs_none, GS_NONE, gs_out, GS_OUT, gs_span, GS_SPAN, lap_bottom, LAP_BOTTOM, lap_left, LAP_LEFT, lap_right, LAP_RIGHT, lap_top, LAP_TOP, ld_percent, LD_PERCENT, ld_text, LD_TEXT, ld_text_percent, LD_TEXT_PERCENT, ld_value, LD_VALUE, LEGENDMARKERSLIMIT, lo_automatic, LO_AUTOMATIC, lo_horizontal, LO_HORIZONTAL, lo_vertical, LO_VERTICAL, lp_inside, LP_INSIDE, lp_no_labels, LP_NO_LABELS, lp_outside_feeler_if_needed, LP_OUTSIDE_FEELER_IF_NEEDED, lp_outside_with_feeler, LP_OUTSIDE_WITH_FEELER, lp_outside_without_feeler, LP_OUTSIDE_WITHOUT_FEELER, ls_dash, LS_DASH, ls_dash_dot, LS_DASH_DOT, ls_dotted, LS_DOTTED, ls_solid, LS_SOLID, ltp_above, LTP_ABOVE, ltp_below, LTP_BELOW, ltp_on_left, LTP_ON_LEFT, ltp_on_marker, LTP_ON_MARKER, ltp_on_right, LTP_ON_RIGHT, m_commonGraph, m_identObj, m_pfj, ms_automatic, MS_AUTOMATIC, ms_circle, MS_CIRCLE, ms_diamond, MS_DIAMOND, ms_human, MS_HUMAN, ms_none, MS_NONE, ms_plus, MS_PLUS, ms_square, MS_SQUARE, ms_triangle_down, MS_TRIANGLE_DOWN, ms_triangle_up, MS_TRIANGLE_UP, mt_area, MT_AREA, mt_bar, MT_BAR, mt_centered_stepped_line, MT_CENTERED_STEPPED_LINE, MT_CURVE_AREA, mt_curve_line, MT_CURVE_LINE, mt_default, MT_DEFAULT, mt_marker, MT_MARKER, mt_stepped_line, MT_STEPPED_LINE, mtp_center, MTP_CENTER, mtp_custom, MTP_CUSTOM, mtp_inside_max, MTP_INSIDE_MAX, mtp_inside_min, MTP_INSIDE_MIN, mtp_on_maxedge, MTP_ON_MAXEDGE, mtp_outside_max, MTP_OUTSIDE_MAX, QUADRANTLINEVALUELIMIT, ro_area, RO_AREA, ro_back, RO_BACK, ro_front, RO_FRONT, ro_line, RO_LINE, sv_hidden, SV_HIDDEN, sv_visible, SV_VISIBLE, tdm_stretched, TDM_STRETCHED, tdm_tiled, TDM_TILED, tls_automatic, TLS_AUTOMATIC, tls_manual, TLS_MANUAL, tls_noskip, TLS_NOSKIP, tr_horiz, TR_HORIZ, tr_horiz_rotate_270, TR_HORIZ_ROTATE_270, tr_horiz_rotate_90, TR_HORIZ_ROTATE_90, tsm_explicit, TSM_EXPLICIT, tsm_off, TSM_OFF, va_bottom, va_center, va_top, VF_PIE_SLICE_LABEL, VF_STOCK_VOLUME, VF_X1, VF_Y1, VF_Y2, VF_Z

Fields inherited from class oracle.dss.dataView.BaseComponentXML

m_jsfHashMap

Constructor Summary

Threshold(CommonGraph graph)

Method Summary

java.awt.Color	getColor(int threshold) Retrieves the fill color for the markers of the threshold.
protected java.lang.String	getComponentName()
double	getMaxValue(int threshold) Returns the maximum value for the given threshold.
double	getMinValue(int threshold) Returns the minimum value for the given threshold.
int	getThresholdId(int group) Retrieves the index of the threshold for a given group.
protected boolean	getThresholdItemsXML(boolean allProperties, boolean allOverriddenProperties, oracle.dss.util.xml.ContainerNode node)
protected boolean	getThresholdXML(boolean allProperties, boolean allOverriddenProperties, oracle.dss.util.xml.ObjectNode thresholdNode, int i)
protected oracle.dss.util.xml.ContainerNode	getXML(boolean allProperties, boolean allOverriddenProperties)
boolean	isTransparent(int threshold) Indicates whether the fill color for the markers of the threshold is transparent.
boolean	isXMLBeingSet() Checks if XML setting is on
protected void	resetStyle()
void	setColor(java.awt.Color newColor, int threshold) Specifies the fill color for the markers of the threshold.
void	setColorValueRange(java.awt.Color[] colors, double[][] values) Sets the threshold for a funnel graph with the given set of colors and value ranges.
void	setDefaultColor(java.awt.Color color) Sets the default Color
void	setMaxValue(int threshold, double maxVal) Specifies the maximum value for the given threshold.
void	setMinValue(int threshold, double minVal) Specifies the minimum value for the given threshold.
protected void	setThresholdItemsXML(oracle.dss.util.xml.ContainerNode node)
protected void	setThresholdXML(oracle.dss.util.xml.ObjectNode thresholdNode, int threshold, boolean allProperties, java.util.HashMap map)
void	setTransparent(boolean yesNo, int threshold) Specifies whether the fill color for the markers of the threshold is transparent.
protected void	setXML(oracle.dss.util.xml.ContainerNode node, boolean allProperties)
protected void	setXML(oracle.dss.util.xml.ContainerNode node, boolean allProperties, java.util.HashMap map)

Methods inherited from class oracle.dss.graph.BaseGraphComponent

convertAssociationToInt, convertFillPatternToString, convertGradientDirectionToString, convertHorizontalAlignmentToInt, convertHorizontalAlignmentToString, convertLineStyleToInt, convertLineStyleToString, convertLocationToInt, convertTextRotationtToInt, convertTickStyleToInt, convertTypeToInt, hexStringToInt, selectObject, toHexString

Methods inherited from class oracle.dss.dataView.BaseComponentXML

getNonstyleXML, getStyleXML, getStyleXML, getXML, setNonstyleXML, setNonstyleXML, setStyleXML, setXML, setXML, setXML, setXML

Methods inherited from class java.lang.Object

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

Field Detail

m_thresholdCount

protected int m_thresholdCount

For internal use only. Application developers should not use this

The total number of thresholds.

Constructor Detail

Threshold

public Threshold(CommonGraph graph)

Parameters:

graph - the graph that this object belongs to

For internal use only. Application developers should not use this

Constructor. Application developers should not have to construct this object, because the graph does it automatically.

Method Detail

setColorValueRange

public void setColorValueRange(java.awt.Color[] colors,
                               double[][] values)
                        throws ThresholdOutOfRangeException

Sets the threshold for a funnel graph with the given set of colors and value ranges.

Parameters:

colors - the array of colors to be used for the threshold

values - the values to be used for the corresponding colors. This is a 2 dimensional array where the length of the 1st dimnension specifies the threshold count that corresponds to the number of colors. The length of the 2nd dimension should be 2 where the first index specifies the minimum value and the 2nd index specifies the maximum value for that threshold.

Throws:

ThresholdOutOfRangeException

getColor

public java.awt.Color getColor(int threshold)
                        throws ThresholdOutOfRangeException

Retrieves the fill color for the markers of the threshold.

Specified by:

getColor in interface UIThresholdColor

Parameters:

threshold - the index of the threshold. The values range from 0 to the value of graph.getThresholdObjectCount minus 1.

Returns:

the fill color for the markers of the threshold. For transparent fill color, this returns null.

Throws:

ThresholdOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph.

ThresholdOutOfRangeException

setColor

public void setColor(java.awt.Color newColor,
                     int threshold)
              throws ThresholdOutOfRangeException

Specifies the fill color for the markers of the threshold.

Specified by:

setColor in interface UIThresholdColor

Parameters:

threshold - the index of the threshold. The values range from 0 to the value of graph.getThresholdObjectCount minus 1.

newColor - the fill color for the markers of the threshold. If this is null, the fill color is made transparent.

Throws:

ThresholdOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph.

ThresholdOutOfRangeException

See Also:

Graph.getThresholdObjectCount()

getMinValue

public double getMinValue(int threshold)
                   throws ThresholdOutOfRangeException

Returns the minimum value for the given threshold.

Parameters:

threshold - the index of the threshold for which the minimum value has to be retrieved. The index values range from 0 to the value of graph.getThresholdObjectCount minus 1.

Returns:

the lower range of the given threshold

Throws:

ThresholdOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph.

ThresholdOutOfRangeException

setMinValue

public void setMinValue(int threshold,
                        double minVal)
                 throws ThresholdOutOfRangeException

Specifies the minimum value for the given threshold.

Parameters:

threshold - the index of the threshold for which the minimum value has to be set. The index values range from 0 to the value of graph.getThresholdObjectCount minus 1.

minVal - the minimum value to be set for the given threshold

Throws:

ThresholdOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph.

ThresholdOutOfRangeException

getMaxValue

public double getMaxValue(int threshold)
                   throws ThresholdOutOfRangeException

Returns the maximum value for the given threshold.

Parameters:

threshold - the index of the threshold for which the maximum value has to be retrieved. The index values range from 0 to the value of graph.getThresholdObjectCount minus 1.

Returns:

the upper range of the given threshold

Throws:

ThresholdOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph.

ThresholdOutOfRangeException

setMaxValue

public void setMaxValue(int threshold,
                        double maxVal)
                 throws ThresholdOutOfRangeException

Specifies the maximum value for the given threshold.

Parameters:

threshold - the index of the threshold for which the maximum value has to be set. The index values range from 0 to the value of graph.getThresholdObjectCount minus 1.

maxVal - the maximum value to be set for the given threshold

Throws:

ThresholdOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph.

ThresholdOutOfRangeException

isTransparent

public boolean isTransparent(int threshold)
                      throws ThresholdOutOfRangeException

Indicates whether the fill color for the markers of the threshold is transparent. To make the markers of this threshold transparent, set both the setBorderTransparent and the setTransparent methods to true. When an object is transparent, it is not visible, but you can select it.

Parameters:

threshold - the index of the threshold. The values range from 0 to the value of graph.getThresholdObjectCount minus 1.

Returns:

true if the fill color for the markers of the threshold is transparent, false if the fill color for the markers of this threshold is visible

Throws:

ThresholdOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph

ThresholdOutOfRangeException

setTransparent

public void setTransparent(boolean yesNo,
                           int threshold)
                    throws ThresholdOutOfRangeException

Specifies whether the fill color for the markers of the threshold is transparent. To make the markers of this threshold transparent, set both the setBorderTransparent and the setTransparent methods to true. When an object is transparent, it is not visible, but you can select it.

Parameters:

threshold - the index of the threshold. The values range from 0 to the value of graph.getThresholdObjectCount minus 1.

yesNo - true to make the fill color for the markers of the threshold transparent, false to make the fill color for the markers of this threshold visible

Throws:

ThresholdOutOfRangeException - if threshold is less than zero, or greater than or equal to the value of the ThresholdObjectCount property of the graph

ThresholdOutOfRangeException

getThresholdId

public int getThresholdId(int group)

Retrieves the index of the threshold for a given group.

Specified by:

getThresholdId in interface UIThresholdColor

Parameters:

group - the group index

Returns:

the threshold index for the given group

setDefaultColor

public void setDefaultColor(java.awt.Color color)

Sets the default Color

Parameters:

color - The new Value

isXMLBeingSet

public boolean isXMLBeingSet()

Checks if XML setting is on

Specified by:

isXMLBeingSet in interface UIThresholdColor

Returns:

true if xml setting is on false if xml setting is off

getComponentName

protected java.lang.String getComponentName()

Overrides:

getComponentName in class BaseComponentXML

For internal use only. Application developers should not use this

Retrieves the name of the threshold.

getXML

protected oracle.dss.util.xml.ContainerNode getXML(boolean allProperties,
                                                   boolean allOverriddenProperties)

For internal use only. Application developers should not use this

Gets XML from this Threshold object.

getThresholdItemsXML

protected boolean getThresholdItemsXML(boolean allProperties,
                                       boolean allOverriddenProperties,
                                       oracle.dss.util.xml.ContainerNode node)

For internal use only. Application developers should not use this

Retrieves style attributes of ThresholdItems to XML. returns whether if the style is overridden

getThresholdXML

protected boolean getThresholdXML(boolean allProperties,
                                  boolean allOverriddenProperties,
                                  oracle.dss.util.xml.ObjectNode thresholdNode,
                                  int i)

For internal use only. Application developers should not use this

Retrieves style properties of Threshold to XML. returns whether if the style is overridden

setXML

protected void setXML(oracle.dss.util.xml.ContainerNode node,
                      boolean allProperties,
                      java.util.HashMap map)

For internal use only. Application developers should not use this

Sets XML on this ThresholdItems object.

setXML

protected void setXML(oracle.dss.util.xml.ContainerNode node,
                      boolean allProperties)

For internal use only. Application developers should not use this

Sets XML on this ThresholdItems object.

setThresholdItemsXML

protected void setThresholdItemsXML(oracle.dss.util.xml.ContainerNode node)

For internal use only. Application developers should not use this

Sets ThresholdItem style XML on this Threshold object.

setThresholdXML

protected void setThresholdXML(oracle.dss.util.xml.ObjectNode thresholdNode,
                               int threshold,
                               boolean allProperties,
                               java.util.HashMap map)

For internal use only. Application developers should not use this

Sets Threshold style XML on this Threshold object.

resetStyle

protected void resetStyle()

For internal use only. Application developers should not use this

reset style properties.