ReferenceObjectSet (Oracle Fusion Middleware Java API Reference for Oracle Data Visualization Components)

java.lang.Object
- oracle.adf.view.faces.bi.component.BIComplexAttributeBase
- - oracle.adf.view.faces.bi.component.graph.ReferenceObjectSet

All Implemented Interfaces:

javax.faces.component.StateHolder
```
public class ReferenceObjectSet
extends BIComplexAttributeBase
```
Defines a set of reference objects for a graph.

Since:

R11

Field Summary

Fields
Modifier and Type	Field and Description
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DISPLAY_SERIES_KEY`
`static java.lang.String`	`DISPLAY_SERIES_NAME`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DISPLAY_X1_KEY`
`static java.lang.String`	`DISPLAY_X1_NAME`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DISPLAY_Y1_KEY`
`static java.lang.String`	`DISPLAY_Y1_NAME`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`DISPLAY_Y2_KEY`
`static java.lang.String`	`DISPLAY_Y2_NAME`
`static org.apache.myfaces.trinidad.bean.PropertyKey`	`REFERENCE_OBJECT_MAP_KEY`
`static BIFacesBeanImpl.Type`	`TYPE`

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
ID_KEY, m_parent, TRANSIENT_KEY

Constructor Summary

Constructors
Constructor and Description

ReferenceObjectSet()

Constructors
Constructor and Description
`ReferenceObjectSet()`

Method Summary

Methods
Modifier and Type	Method and Description
`void`	`applyProperties(java.util.HashMap map)` Applications do not need to call this method.
`protected org.apache.myfaces.trinidad.bean.FacesBean.Type`	`getBeanType()`
`int`	`getDisplaySeries()` Indicates when the reference objects for Series component should be displayed.
`int`	`getDisplayX1()` Indicates when the reference objects for X1Axis component should be displayed.
`int`	`getDisplayY1()` Indicates when the reference objects for Y1Axis component should be displayed.
`int`	`getDisplayY2()` Indicates when the reference objects for Y2Axis component should be displayed.
`ReferenceObject`	`getReferenceObject(int i, boolean createNew)`
`java.util.Map`	`getReferenceObjectMap()`
`java.lang.Object`	`saveState(javax.faces.context.FacesContext context)`
`void`	`setDisplaySeries(int display)` Deprecated.
`void`	`setDisplaySeries(java.lang.String display)` Specifies when to display the reference objects for Series.
`void`	`setDisplayX1(int display)` Specifies when to display the reference objects for X1Axis component.
`void`	`setDisplayX1(java.lang.String display)` Specifies when to display the reference objects for X1Axis component.
`void`	`setDisplayY1(int display)` Specifies when to display the reference objects for Y1Axis component.
`void`	`setDisplayY1(java.lang.String display)` Specifies when to display the reference objects for Y1Axis component.
`void`	`setDisplayY2(int display)` Specifies when to display the reference objects for Y2Axis component.
`void`	`setDisplayY2(java.lang.String display)` Specifies when to display the reference objects for Y2Axis component.
`void`	`setReferenceObjectMap(java.util.Map map)`

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase
getBooleanProperty, getFacesBean, getId, getParent, getProperty, getPropertyKey, getSetAttributeIndex, isTransient, isUpdated, processSetAttribute, processSetAttributeAndAdd, registerAttachedObjectKey, restoreState, setBooleanProperty, setId, setParent, setProperty, setTransient, setUpdated

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Field Detail
  - TYPE
```
public static final BIFacesBeanImpl.Type TYPE
```
  - REFERENCE_OBJECT_MAP_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey REFERENCE_OBJECT_MAP_KEY
```
  - DISPLAY_X1_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_X1_KEY
```
  - DISPLAY_Y1_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_Y1_KEY
```
  - DISPLAY_Y2_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_Y2_KEY
```
  - DISPLAY_SERIES_KEY
```
public static final org.apache.myfaces.trinidad.bean.PropertyKey DISPLAY_SERIES_KEY
```
  - DISPLAY_X1_NAME
```
public static final java.lang.String DISPLAY_X1_NAME
```
    See Also:
    Constant Field Values
  - DISPLAY_Y1_NAME
```
public static final java.lang.String DISPLAY_Y1_NAME
```
    See Also:
    Constant Field Values
  - DISPLAY_Y2_NAME
```
public static final java.lang.String DISPLAY_Y2_NAME
```
    See Also:
    Constant Field Values
  - DISPLAY_SERIES_NAME
```
public static final java.lang.String DISPLAY_SERIES_NAME
```
    See Also:
    Constant Field Values
- Constructor Detail
  - ReferenceObjectSet
```
public ReferenceObjectSet()
```
- Method Detail
  - applyProperties
```
public void applyProperties(java.util.HashMap map)
```
    Applications do not need to call this method. This is for internal use.
    
    Overrides:
    
    applyProperties in class BIComplexAttributeBase
    
    Parameters:
    map - hashMap that contains property value pairs.
  - getReferenceObject
```
public ReferenceObject getReferenceObject(int i,
                                 boolean createNew)
```
  - setReferenceObjectMap
```
public void setReferenceObjectMap(java.util.Map map)
```
  - getReferenceObjectMap
```
public java.util.Map getReferenceObjectMap()
```
  - getDisplayX1
```
public int getDisplayX1()
```
    Indicates when the reference objects for X1Axis component should be displayed. By default display value will be DISPLAY_ALWAYS.
    
    Returns:
    A constant that indicates when to display the reference object.
    See Also:
    #RO_DISPLAY_NEVER, #RO_DISPLAY_ALWAYS, #RO_DISPLAY_AUTOMATIC
  - getDisplayY1
```
public int getDisplayY1()
```
    Indicates when the reference objects for Y1Axis component should be displayed. By default display value will be DISPLAY_ALWAYS.
    
    Returns:
    A constant that indicates when to display the reference object.
    See Also:
    #RO_DISPLAY_NEVER, #RO_DISPLAY_ALWAYS, #RO_DISPLAY_AUTOMATIC
  - getDisplayY2
```
public int getDisplayY2()
```
    Indicates when the reference objects for Y2Axis component should be displayed. By default display value will be DISPLAY_ALWAYS.
    
    Returns:
    A constant that indicates when to display the reference object.
    See Also:
    #RO_DISPLAY_NEVER, #RO_DISPLAY_ALWAYS, #RO_DISPLAY_AUTOMATIC
  - getDisplaySeries
```
public int getDisplaySeries()
```
    Indicates when the reference objects for Series component should be displayed. By default display value will be DISPLAY_ALWAYS.
    
    Returns:
    A constant that indicates when to display the reference object.
    See Also:
    #RO_DISPLAY_NEVER, #RO_DISPLAY_ALWAYS, #RO_DISPLAY_AUTOMATIC
  - setDisplayX1
```
public void setDisplayX1(int display)
```
    Specifies when to display the reference objects for X1Axis component. By default display value will be DISPLAY_ALWAYS.
    
    Parameters:
    display - A constant that indicates when to display the reference object.
    See Also:
    #RO_DISPLAY_NEVER, #RO_DISPLAY_ALWAYS, #RO_DISPLAY_AUTOMATIC
  - setDisplayX1
```
public void setDisplayX1(java.lang.String display)
```
    Specifies when to display the reference objects for X1Axis component. By default display value will be DISPLAY_ALWAYS.
    Parameters:
    display - A constant that indicates when to display the reference object. Controls whether reference lines related to a series should be displayed when the mouse hovers over a data series. Valid values are the following:
    
    RO_DISPLAY_NEVER - Does not display reference objects for the series objects.
    
    RO_DISPLAY_ALWAYS - (Default) Always displays reference objects for the series objects
    
    RO_DISPLAY_AUTOMATIC - Display reference object when mouse is hovered over the associated series objects.
  - setDisplayY1
```
public void setDisplayY1(int display)
```
    Specifies when to display the reference objects for Y1Axis component. By default display value will be DISPLAY_ALWAYS.
    
    Parameters:
    display - A constant that indicates when to display the reference object.
    See Also:
    #RO_DISPLAY_NEVER, #RO_DISPLAY_ALWAYS, #RO_DISPLAY_AUTOMATIC
  - setDisplayY1
```
public void setDisplayY1(java.lang.String display)
```
    Specifies when to display the reference objects for Y1Axis component. By default display value will be DISPLAY_ALWAYS.
    Parameters:
    display - A constant that indicates when to display the reference object. Controls whether reference lines related to a series should be displayed when the mouse hovers over a data series. Valid values are the following:
    
    RO_DISPLAY_NEVER - Does not display reference objects for the Y1 objects.
    
    RO_DISPLAY_ALWAYS - (Default) Always displays reference objects for the Y1 objects
    
    RO_DISPLAY_AUTOMATIC - Display reference object when mouse is hovered over the associated Y1 objects.
  - setDisplayY2
```
public void setDisplayY2(int display)
```
    Specifies when to display the reference objects for Y2Axis component. By default display value will be DISPLAY_ALWAYS.
    
    Parameters:
    display - A constant that indicates when to display the reference object.
    See Also:
    #RO_DISPLAY_NEVER, #RO_DISPLAY_ALWAYS, #RO_DISPLAY_AUTOMATIC
  - setDisplayY2
```
public void setDisplayY2(java.lang.String display)
```
    Specifies when to display the reference objects for Y2Axis component. By default display value will be DISPLAY_ALWAYS.
    Parameters:
    display - A constant that indicates when to display the reference object. Controls whether reference lines related to a series should be displayed when the mouse hovers over a data series. Valid values are the following:
    
    RO_DISPLAY_NEVER - Does not display reference objects for the Y2 objects.
    
    RO_DISPLAY_ALWAYS - (Default) Always displays reference objects for the Y2 objects
    
    RO_DISPLAY_AUTOMATIC - Display reference object when mouse is hovered over the associated Y2 objects.
  - setDisplaySeries
```
public void setDisplaySeries(int display)
```
    Deprecated. Use ReferenceObjectSet.setDisplaySeries(int display) Specifies when to display the reference objects for Series component. By default display value will be DISPLAY_ALWAYS.
    
    Parameters:
    display - A constant that indicates when to display the reference object.
    See Also:
    #RO_DISPLAY_NEVER, #RO_DISPLAY_ALWAYS, #RO_DISPLAY_AUTOMATIC
  - setDisplaySeries
```
public void setDisplaySeries(java.lang.String display)
```
    Specifies when to display the reference objects for Series. By default display value will be DISPLAY_ALWAYS.
    Parameters:
    display - A constant that indicates when to display the reference object. Controls whether reference lines related to a series should be displayed when the mouse hovers over a data series. Valid values are the following:
    
    RO_DISPLAY_NEVER - Does not display reference objects for the series objects.
    
    RO_DISPLAY_ALWAYS - (Default) Always displays reference objects for the series objects
    
    RO_DISPLAY_AUTOMATIC - Display reference object when mouse is hovered over the associated series objects.
  - saveState
```
public java.lang.Object saveState(javax.faces.context.FacesContext context)
```
    Specified by:
    
    saveState in interface javax.faces.component.StateHolder
    
    Overrides:
    
    saveState in class BIComplexAttributeBase
  - getBeanType
```
protected org.apache.myfaces.trinidad.bean.FacesBean.Type getBeanType()
```
    Specified by:
    
    getBeanType in class BIComplexAttributeBase

Class ReferenceObjectSet

Field Summary

Fields inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

Constructor Summary

Method Summary

Methods inherited from class oracle.adf.view.faces.bi.component.BIComplexAttributeBase

Methods inherited from class java.lang.Object

Field Detail

TYPE

REFERENCE_OBJECT_MAP_KEY

DISPLAY_X1_KEY

DISPLAY_Y1_KEY

DISPLAY_Y2_KEY

DISPLAY_SERIES_KEY

DISPLAY_X1_NAME

DISPLAY_Y1_NAME

DISPLAY_Y2_NAME

DISPLAY_SERIES_NAME

Constructor Detail

ReferenceObjectSet

Method Detail

applyProperties

getReferenceObject

setReferenceObjectMap

getReferenceObjectMap

getDisplayX1

getDisplayY1

getDisplayY2

getDisplaySeries

setDisplayX1

setDisplayX1

setDisplayY1

setDisplayY1

setDisplayY2

setDisplayY2

setDisplaySeries

setDisplaySeries

saveState

getBeanType