oracle.dss.dataView
Class DataComponentHandle

java.lang.Object
  oracle.dss.dataView.ComponentHandle
      oracle.dss.dataView.DataComponentHandle

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

BoxPlotDataComponentHandle, ScatterDataComponentHandle, StockDataComponentHandle, ThresholdComponentHandle

public class DataComponentHandle
extends ComponentHandle

Represents the location of data, such as a cell in a GridView, or a data marker in a Graph. This normally represents a selected cell or marker, or the cell or marker that you want to select programmatically.

See Also:

Serialized Form

Field Summary

static java.lang.String	KEY_PATH Key Path for the data value in a data control hierarchical Collection object.
protected boolean	m_seriesAreRows
static java.lang.String	ROW_KEY Row Key of the row that contains the data value in a data control RowSet Collection object.
static java.lang.String	UNFORMATTED_VALUE Unformatted value(eg 50, 200)

Fields inherited from class oracle.dss.dataView.ComponentHandle

m_dataAccess

Constructor Summary

DataComponentHandle(int id, java.lang.String name, java.lang.Object comp, DataComponentInfo dataInfo)
Class constructor that uses a DataComponentInfo to specify the row and column.

DataComponentHandle(int id, java.lang.String name, java.lang.Object comp, DataComponentInfo info, boolean seriesAreRows)
Constructor that uses a DataComponentInfo to identify the row and column, for a graph component.

DataComponentHandle(int id, java.lang.String name, java.lang.Object comp, DataComponentInfo info, int group, int series)
Constructor that uses int values to specify the row, column, group, and series for a graph.

DataComponentHandle(int id, java.lang.String name, java.lang.Object comp, int r, int c)
Constructor that uses int values to specify the row and column.

DataComponentHandle(int id, java.lang.String name, java.lang.Object comp, int r, int c, boolean seriesAreRows)
Constructor that uses int values to specify the row and column, for a graph.

DataComponentHandle(int id, java.lang.String name, java.lang.Object comp, int row, int column, int group, int series)
Constructor that uses int values to specify the row, column, group, and series for a graph.

Method Summary

boolean	equals(java.lang.Object o)
int	getColumn() Retrieves the column number of the component or cell.
ComponentInfo	getComponentInfo() Retrieves the DataComponentInfo for the component or cell that this DataComponentHandle represents.
int	getGroup() Retrieves the group number of the component.
Attributes[]	getGroupAttributes() The attributes that make up the group ex: Employee -SMITH
int	getRow() Retrieves the row number of the component or cell.
int	getSeries() Retrieves the series number of the component or cell.
Attributes[]	getSeriesAttributes() The attributes that make up the series ex: Country - USA, Product - Coke
java.lang.Object	getValue(java.lang.String attrName) Retrieves the data attribute values associated with attrName argument.
boolean	isSeriesComponent() Indicates whether this data component represents a series.
void	setSeriesAreRows(boolean seriesAreRows)
void	setSeriesComponent(boolean series) Specifies whether this data component represents a series.
java.lang.String	toString() Converts this object to a String.

Methods inherited from class oracle.dss.dataView.ComponentHandle

getComponent, getID, getName, setDataAccess

Methods inherited from class java.lang.Object

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

Field Detail

m_seriesAreRows

protected boolean m_seriesAreRows

UNFORMATTED_VALUE

public static final java.lang.String UNFORMATTED_VALUE

Unformatted value(eg 50, 200)

See Also:

Constant Field Values

ROW_KEY

public static final java.lang.String ROW_KEY

Row Key of the row that contains the data value in a data control RowSet Collection object. Row keys are of type oracle.jbo.Key.

See Also:

Constant Field Values

KEY_PATH

public static final java.lang.String KEY_PATH

Key Path for the data value in a data control hierarchical Collection object. Key path is of type ArrayList of oracle.jbo.Key objects.

See Also:

Constant Field Values

Constructor Detail

DataComponentHandle

public DataComponentHandle(int id,
                           java.lang.String name,
                           java.lang.Object comp,
                           int r,
                           int c)

Constructor that uses int values to specify the row and column.

Parameters:

id - In a graph, a constant that identifies the represented graph component, such as Graph.DATAMARKER. For a GridView, the constant GridView.DATA_CELL.

name - The name of the component that this DataComponentHandle represents.

comp - The actual reference to the component.

r - The row of the component or cell.

c - The column of the component or cell.

DataComponentHandle

public DataComponentHandle(int id,
                           java.lang.String name,
                           java.lang.Object comp,
                           int r,
                           int c,
                           boolean seriesAreRows)

Constructor that uses int values to specify the row and column, for a graph.

Parameters:

id - A constant, such as Graph.DATAMARKER, that identifies the component that this DataComponentHandle represents. The constants are defined in the Graph class.

name - The name of the component that this DataComponentHandle represents.

comp - The actual reference to the component.

r - The row of the component.

c - The column of the component.

seriesAreRows - true if the graph displays data rows as series, false if data rows appear as groups in the graph.

DataComponentHandle

public DataComponentHandle(int id,
                           java.lang.String name,
                           java.lang.Object comp,
                           DataComponentInfo dataInfo)

Class constructor that uses a DataComponentInfo to specify the row and column.

Parameters:

id - In a graph, a constant that identifies the represented graph component, such as Graph.DATAMARKER. For a GridView, the constant DATA_CELL.

name - The name of the component that this DataComponentHandle represents.

comp - The actual reference to the component.

info - The DataComponentInfo that identifies the row and column of the component.

DataComponentHandle

public DataComponentHandle(int id,
                           java.lang.String name,
                           java.lang.Object comp,
                           DataComponentInfo info,
                           boolean seriesAreRows)

Constructor that uses a DataComponentInfo to identify the row and column, for a graph component.

Parameters:

id - A constant, such as Graph.DATAMARKER, that identifies the component that this DataComponentHandle represents. The constants are defined in the Graph class.

name - The name of the component that this DataComponentHandle represents.

comp - The actual reference to the component.

info - Information about the row and column of the component.

seriesAreRows - true if the graph displays data rows as series, false if data rows appear as groups in the graph.

DataComponentHandle

public DataComponentHandle(int id,
                           java.lang.String name,
                           java.lang.Object comp,
                           int row,
                           int column,
                           int group,
                           int series)

Constructor that uses int values to specify the row, column, group, and series for a graph.

Parameters:

id - A constant, such as Graph.DATAMARKER, that identifies the component that this DataComponentHandle represents. The constants are defined in the Graph class.

name - The name of the component that this DataComponentHandle represents.

comp - The actual reference to the component.

row - The row of the component.

column - The column of the component.

group - The group of the component.

series - The series of the component.

DataComponentHandle

public DataComponentHandle(int id,
                           java.lang.String name,
                           java.lang.Object comp,
                           DataComponentInfo info,
                           int group,
                           int series)

Constructor that uses int values to specify the row, column, group, and series for a graph.

Parameters:

id - A constant, such as Graph.DATAMARKER, that identifies the component that this DataComponentHandle represents. The constants are defined in the Graph class.

name - The name of the component that this DataComponentHandle represents.

comp - The actual reference to the component.

info - The DataComponentInfo that identifies the row and column of the component.

group - The group of the component.

series - The series of the component.

Method Detail

getValue

public java.lang.Object getValue(java.lang.String attrName)

Retrieves the data attribute values associated with attrName argument.

Parameters:

attrName - A constant for the attribute name UNFORMATTED_VALUE or ROW_KEY

Returns:

the data attribute value ex: a Double

See Also:

UNFORMATTED_VALUE, ROW_KEY

getSeriesAttributes

public Attributes[] getSeriesAttributes()

The attributes that make up the series ex: Country - USA, Product - Coke

Returns:

array of Attributes

getGroupAttributes

public Attributes[] getGroupAttributes()

The attributes that make up the group ex: Employee -SMITH

Returns:

array of Attributes

getRow

public int getRow()

Retrieves the row number of the component or cell. This method gets the information from the DataComponentInfo. Row numbers begin at zero.

Returns:

The row number of the component.

getColumn

public int getColumn()

Retrieves the column number of the component or cell. This method gets the information from the DataComponentInfo. Column numbers begin at zero.

Returns:

The column number of the component.

getSeries

public int getSeries()

Retrieves the series number of the component or cell. When Graph.isDataRowShownAsASeries returns true, then this method returns the same value that the getRow method returns. When Graph.isDataRowShownAsASeries returns false, then this method returns the same value that the getColumn method returns.

Returns:

The series number of the component.

See Also:

Graph.isDataRowShownAsASeries()

getGroup

public int getGroup()

Retrieves the group number of the component. For this method to be effective, this DataComponentHandle must have been constructed by a constructor that has group and series arguments.

Returns:

The group number of the component.

See Also:

DataComponentHandle(int, String, Object, DataComponentInfo, int, int), DataComponentHandle(int, String, Object, int, int, int, int), Graph.isDataRowShownAsASeries()

toString

public java.lang.String toString()

Converts this object to a String. The String contains the name of this class, the name of the component, the row number, and the column number. Row and column numbers begin at zero.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Retrieves the DataComponentInfo for the component or cell that this DataComponentHandle represents.

Specified by:

getComponentInfo in class ComponentHandle

Returns:

Information about the row and column of the component. The DataComponentInfo can be null, but this not normal.

See Also:

DataComponentHandle

isSeriesComponent

public boolean isSeriesComponent()

Indicates whether this data component represents a series. Most markers do have a distinct series. However, in a 3-D surface graph, for example, a marker is not associated with a particular series.

Returns:

true if this data component represents series data, false if it does not.

setSeriesComponent

public void setSeriesComponent(boolean series)

Specifies whether this data component represents a series. Most markers do have a distinct series. However, in a 3-D surface graph, for example, a marker is not associated with a particular series.

Parameters:

series - true if this data component represents series data, false if it does not.

setSeriesAreRows

public void setSeriesAreRows(boolean seriesAreRows)

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class ComponentHandle