public class EdgeComponentHandle extends ComponentHandle
m_dataAccess
Constructor and Description |
---|
EdgeComponentHandle(int id,
java.lang.String name,
java.lang.Object comp,
EdgeComponentInfo info)
Constructor that uses an
EdgeComponentInfo to identify the
location of the cell. |
EdgeComponentHandle(int id,
java.lang.String name,
java.lang.Object comp,
int edge,
int depth,
int index)
Constructor that uses edge, depth, and index values to identify the
location of the cell.
|
Modifier and Type | Method and Description |
---|---|
boolean |
equals(java.lang.Object o) |
ComponentInfo |
getComponentInfo()
Retrieves the
EdgeComponentInfo for the cell that
this EdgeComponentHandle represents. |
int |
getDepth()
Retrieves the depth of the cell.
|
int |
getEdge()
Retrieves the edge that the cell is on.
|
int |
getIndex()
Retrieves the index of the cell.
|
java.lang.String |
toString()
Converts this object to a
String . |
getComponent, getID, getName, setDataAccess
public EdgeComponentHandle(int id, java.lang.String name, java.lang.Object comp, int edge, int depth, int index)
June | July | ||||||||||
Tents | Canoes | Tents | Canoes | ||||||||
NY | Boston | LA | Toronto | Winnepeg | NY | LA | NY | Boston | LA | Toronto | Winnepeg |
To identify the cell for Toronto, for Canoes, for June, the edge would be COLUMN_EDGE; the depth would be 2, and the index would be 3. Depth and index both begin at zero.
id
- A constant, either GridView.COL_HEADER
,
or GridView.ROW_HEADER
, that
identifies the kind of header that contains the cell that this
EdgeComponentHandle
represents.name
- The name of the represented component.comp
- The actual reference to the component.edge
- A constant, such as DataDirector.COLUMN_EDGE
,
that identifies
the edge of the component.
Constants are defined in the DataDirector
interface.depth
- The depth of the cell that this
EdgeComponentHandle
represents.
Zero is the outermost dimension on the edge.index
- The index of the cell. The index is zero-based.
Each dimension member in the innermost dimension has a unique
index.
In outer dimensions, any index that the outer dimension spans
can be used.DataDirector
public EdgeComponentHandle(int id, java.lang.String name, java.lang.Object comp, EdgeComponentInfo info)
EdgeComponentInfo
to identify the
location of the cell.id
- A constant, either GridView.COL_HEADER
,
or GridView.ROW_HEADER
, that
identifies the kind of header that contains the cell that this
EdgeComponentHandle
represents.name
- The name of the represented component.comp
- The actual reference to the component.info
- The EdgeComponentInfo
that specifies the location
of the item to represent.public int getEdge()
DataDirector.COLUMN_EDGE
,
that identifies the edge that the cell is on.
Constants are defined in the DataDirector
interface.DataDirector
public int getDepth()
June | July | ||||||||||
Tents | Canoes | Tents | Canoes | ||||||||
NY | Boston | LA | Toronto | Winnepeg | NY | LA | NY | Boston | LA | Toronto | Winnepeg |
The Month dimension is at depth 0; the Product dimension is at depth 1; and the Geography dimension is at depth 2.
EdgeComponentInfo
represents.public int getIndex()
June | July | ||||||||||
Tents | Canoes | Tents | Canoes | ||||||||
NY | Boston | LA | Toronto | Winnepeg | NY | LA | NY | Boston | LA | Toronto | Winnepeg |
Reading from left to right in the Geography dimension:
EdgeComponentHandle
representspublic java.lang.String toString()
String
.
The String
contains the name of this class, the name of the
component, and location of the represented item, as identified by its
edge, depth, and index.toString
in class java.lang.Object
String
representation of this object.public ComponentInfo getComponentInfo()
EdgeComponentInfo
for the cell that
this EdgeComponentHandle
represents.getComponentInfo
in class ComponentHandle
EdgeComponentInfo
can be null
,
though this is not normal.DataComponentHandle
public boolean equals(java.lang.Object o)
equals
in class ComponentHandle
EdgeComponentHandle
.