public class GroupComponentHandle extends ComponentHandle
Graph
and provides information
about the group of the component.Modifier and Type | Field and Description |
---|---|
protected boolean |
m_seriesAreRows |
m_dataAccess
Constructor and Description |
---|
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. |
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o) |
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.
|
Attributes[] |
getGroupAttributes()
The attributes that make up the group ex: Employee -SMITH
|
int |
getLayer()
Retrieves the layer number of the component.
|
int |
getSlice()
Retrieves the first slice in the group.
|
void |
setSeriesAreRows(boolean seriesAreRows) |
java.lang.String |
toString()
Converts this object to a
String . |
getComponent, getID, getName, setDataAccess
public GroupComponentHandle(int id, java.lang.String name, java.lang.Object comp, int group)
int
to identify the group of
the component.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.public GroupComponentHandle(int id, java.lang.String name, java.lang.Object comp, GroupComponentInfo info)
GroupComponentInfo
to identify
the group of the component.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.public GroupComponentHandle(int id, java.lang.String name, java.lang.Object comp, int group, int edge, int slice)
int
to identify the group of
the component.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.DataDirector.COLUMN_EDGE
,
DataDirector.ROW_EDGE
public int getLayer()
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.
public int getGroup()
GroupComponentInfo
.
Group numbers begin at zero.public int getEdge()
DataDirector.COLUMN_EDGE
,
DataDirector.ROW_EDGE
public int getSlice()
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.getEdge()
public java.lang.String toString()
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.toString
in class java.lang.Object
String
representation of this object.public ComponentInfo getComponentInfo()
GroupComponentInfo
for the component
that this GroupComponentHandle
represents.getComponentInfo
in class ComponentHandle
GroupComponentInfo
can be null
,
but this is not normal.DataComponentHandle
public Attributes[] getGroupAttributes()
public boolean equals(java.lang.Object o)
equals
in class ComponentHandle
GroupComponentHandle
.public void setSeriesAreRows(boolean seriesAreRows)