oracle.dss.dataView
Class SeriesComponentHandle

java.lang.Object
  |
  +--oracle.dss.dataView.ComponentHandle
        |
        +--oracle.dss.dataView.SeriesComponentHandle

All Implemented Interfaces:

java.io.Serializable

public class SeriesComponentHandle

extends ComponentHandle

Represents a component in a Graph and provides information about the series of the component.

See Also:

Serialized Form

Constructor Summary

SeriesComponentHandle(int id, java.lang.String name, java.lang.Object comp, int series)
Constructor that uses an int to identify the series of the component.

SeriesComponentHandle(int id, java.lang.String name, java.lang.Object comp, int series, int edge)
Constructor that uses an int to identify the series of the component.

SeriesComponentHandle(int id, java.lang.String name, java.lang.Object comp, SeriesComponentInfo info)
Constructor that uses a SeriesComponentInfo to identify the series of the component.

Method Summary

ComponentInfo	getComponentInfo() Retrieves the SeriesComponentInfo for the component that this SeriesComponentHandle represents.
int	getEdge() Retrieves the edge that the series is on.
int	getSeries() Retrieves the series number of the component.
java.lang.String	toString() Retrieves a String representation of this object.

Methods inherited from class oracle.dss.dataView.ComponentHandle

getComponent, getID, getName

Methods inherited from class java.lang.Object

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

Constructor Detail

SeriesComponentHandle

public SeriesComponentHandle(int id,
                             java.lang.String name,
                             java.lang.Object comp,
                             int series)

Constructor that uses an int to identify the series of the component.

Parameters:

id - A constant, such as Graph.DATAMARKER, that identifies the component that this SeriesComponentHandle represents.

name - The name of the represented component.

comp - The actual reference to the component.

series - The series to which the component belongs.

SeriesComponentHandle

public SeriesComponentHandle(int id,
                             java.lang.String name,
                             java.lang.Object comp,
SeriesComponentInfo info)

Constructor that uses a SeriesComponentInfo to identify the series of the component.

Parameters:

id - A constant, such as Graph.DATAMARKER, that identifies the component that this SeriesComponentHandle represents.

name - The name of the represented component.

comp - The actual reference to the component.

info - The SeriesComponentInfo that identifies the series.

SeriesComponentHandle

public SeriesComponentHandle(int id,
                             java.lang.String name,
                             java.lang.Object comp,
                             int series,
                             int edge)

Constructor that uses an int to identify the series of the component.

Parameters:

id - A constant, such as Graph.DATAMARKER, that identifies the component that this SeriesComponentHandle represents.

name - The name of the represented component.

comp - The actual reference to the component.

series - The series to which the component belongs.

edge - the edge the series is on

Method Detail

getSeries

public int getSeries()

Retrieves the series number of the component. This method gets the information from the SeriesComponentInfo. Series numbers begin at zero.

Returns:

The series number of the component.

getEdge

public int getEdge()

Retrieves the edge that the series is on.

Returns:

The edge the series is on. Possible values are listed in the See Also section. The value depends on the return value of the Graph.isDataRowShownAsASeries.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE, Graph.isDataRowShownAsASeries()

toString

public java.lang.String toString()

Retrieves a String representation of this object. The String contains the name of this class, the name of the component, and the series number of the component. Series numbers begin at zero.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Retrieves the SeriesComponentInfo for the component that this SeriesComponentHandle represents.

Overrides:

getComponentInfo in class ComponentHandle

Returns:

Information about the series of the represented component. The SeriesComponentInfo can be null, but this is not normal.