oracle.dss.dataView
Class GroupComponentHandle

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

All Implemented Interfaces:

java.io.Serializable

public class GroupComponentHandle

extends ComponentHandle

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

See Also:

Serialized Form

Constructor Summary

GroupComponentHandle(int id, java.lang.String name, java.lang.Object comp, GroupComponentInfo info)
Constructor that uses a GroupComponentInfo to identify the group of the component.

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

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

Method Summary

ComponentInfo	getComponentInfo() Retrieves the GroupComponentInfo for the component that this GroupComponentHandle represents.
int	getEdge() Retrieves the edge this group is on.
int	getGroup() Retrieves the group number of the component.
int	getLayer() Retrieves the layer number of the component.
int	getSlice() Retrieves the first slice in the group.
java.lang.String	toString() Converts this object to a String.

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

GroupComponentHandle

public GroupComponentHandle(int id,
                            java.lang.String name,
                            java.lang.Object comp,
                            int group)

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

Parameters:

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

name - The name of the represented component.

comp - The actual reference to the component.

group - The group to which the component belongs.

GroupComponentHandle

public GroupComponentHandle(int id,
                            java.lang.String name,
                            java.lang.Object comp,
GroupComponentInfo info)

Constructor that uses a GroupComponentInfo to identify the group of the component.

Parameters:

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

name - The name of the represented component.

comp - The actual reference to the component.

info - The GroupComponentInfo that identifies the group.

GroupComponentHandle

public GroupComponentHandle(int id,
                            java.lang.String name,
                            java.lang.Object comp,
                            int group,
                            int edge,
                            int slice)

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

Parameters:

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

name - The name of the represented component.

comp - The actual reference to the component.

group - The group to which the component belongs.

edge - A constant that identifies the edge to which the component belongs. Valid constants are listed in the See Also section.

slice - The first row or column in the group to which the component belongs.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE

Method Detail

getLayer

public int getLayer()

Retrieves the layer number of the component. This method gets the information from the GroupComponentInfo. Layer numbers begin at zero.

Layer numbers are relevant for O1TickLabel objects in graphs that have a time axis (dates along the axis). On a time axis, you can have labels for smaller units of time (such as days, weeks, or months) next to the axis, and labels for larger units of time (such as weeks, months, or years) that appear below the labels for smaller units.

The 0th label is the largest time unit.

Returns:

The layer number of the component.

getGroup

public int getGroup()

Retrieves the group number of the component. This method gets the information from the GroupComponentInfo. Group numbers begin at zero.

Returns:

The group number of the component.

getEdge

public int getEdge()

Retrieves the edge this group is on.

Returns:

A constant that identifies edge for this group. Valid constants are documented in the See Also section.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.ROW_EDGE

getSlice

public int getSlice()

Retrieves the first slice in the group. If getEdge returns DataDirector.COLUMN_EDGE, then this method returns the first column of data that this group represents. If getEdge returns DataDirector.ROW_EDGE, then this method returns the first row of data that this group represents.

Returns:

The first slice (row or column) that the group represents.

See Also:

getEdge()

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, and the group number of the component. Group numbers begin at zero.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Retrieves the GroupComponentInfo for the component that this GroupComponentHandle represents.

Overrides:

getComponentInfo in class ComponentHandle

Returns:

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