oracle.dss.util
Class GroupComponentInfo

java.lang.Object
  |
  +--oracle.dss.util.ComponentInfo
        |
        +--oracle.dss.util.GroupComponentInfo

All Implemented Interfaces:

java.lang.Cloneable

public class GroupComponentInfo

extends ComponentInfo

Group information about a component in a Graph. Used for components that have data associated with them.

Constructor Summary

GroupComponentInfo(int group)
Constructor.

GroupComponentInfo(int group, int edge, int slice)
Constructor that specifies the group, the edge, and the slice.

GroupComponentInfo(int group, int layer, int edge, int slice)
Constructor that specifies the group, the layer, the edge, and the slice.

Method Summary

java.lang.Object	clone() Clones this GroupComponentInfo.
boolean	equals(java.lang.Object o) Indicates whether the specified object is equivalent to this GroupComponentInfo.
int	getEdge() Retrieves the edge that the group is on.
int	getGroup() Retrieves the group number.
int	getLayer() Retrieves the layer number of the component.
QDR	getQDR(DataAccess dataAccess, int flags) Retrieves a QDR for this GroupComponentInfo.
int	getSlice() Retrieves the first slice in the group.
java.lang.String	toString() Produces a String that identifies the group.

Methods inherited from class java.lang.Object

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

Constructor Detail

GroupComponentInfo

public GroupComponentInfo(int group)

Constructor.

Parameters:

group - The group that the component is in.

GroupComponentInfo

public GroupComponentInfo(int group,
                          int edge,
                          int slice)

Constructor that specifies the group, the edge, and the slice.

Parameters:

group - The group that the component is in.

edge - A constant that represents the data edge that group is on. Possible values are listed in the See Also section. The value depends on the return value of the Graph.isDataRowShownAsASeries.

slice - The first slice in the group.

See Also:

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

GroupComponentInfo

public GroupComponentInfo(int group,
                          int layer,
                          int edge,
                          int slice)

Constructor that specifies the group, the layer, the edge, and the slice.

Parameters:

group - The group that the component is in.

layer - The layer that the component is in. The layer is relevant for graphs that have a time axis, where the ordinal axis shows time values. The outer-most layer (labels for the largest units of time) is layer 0.

edge - A constant that represents the data edge that group is on. Possible values are listed in the See Also section. The value depends on the return value of the Graph.isDataRowShownAsASeries.

slice - The first slice in the group.

See Also:

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

Method Detail

clone

public java.lang.Object clone()

Clones this GroupComponentInfo.

Overrides:

clone in class ComponentInfo

Returns:

The clone of this GroupComponentInfo.

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. Group numbers start at zero.

Returns:

The group number.

getEdge

public int getEdge()

Retrieves the edge that the group is on.

Returns:

A constant that represents the edge that the group 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()

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()

equals

public boolean equals(java.lang.Object o)

Indicates whether the specified object is equivalent to this GroupComponentInfo. GroupComponentInfo objects are equivalent if they refer to the same group.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare with this GroupComponentInfo.

Returns:

true if both objects refer to the same group, false if not or if o is not a GroupComponentInfo.

getQDR

public QDR getQDR(DataAccess dataAccess,
                  int flags)

Retrieves a QDR for this GroupComponentInfo. The QDR currently identifies the dimension members represented by the first column or row of data that corresponds to the group.

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

Overrides:

getQDR in class ComponentInfo

Parameters:

dataAccess - The DataAccess that provided the data for the group that this GroupComponentInfo describes.

flags - A constant that identifies whether to include page edge information if the QDR is not for the page edge. Valid constants are listed in the See Also section.

Returns:

A QDR that identifies the first slice of data that this GroupComponentInfo describes.

See Also:

getEdge(), DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

toString

public java.lang.String toString()

Produces a String that identifies the group.

Overrides:

toString in class java.lang.Object

Returns:

The group number, in a String.