oracle.dss.dataView

Class EdgeComponentHandle

java.lang.Object

oracle.dss.dataView.ComponentHandle

oracle.dss.dataView.EdgeComponentHandle

All Implemented Interfaces:

java.io.Serializable

public class EdgeComponentHandle
extends ComponentHandle

Represents a cell in a row header or in a column header. This is normally a selected column or row heading, or the cell that you want to select programmatically. This class provides access to the item and information about its location.

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.dss.dataView.ComponentHandle

m_dataAccess

Constructor Summary

Constructors

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.

Method Summary

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.

Methods inherited from class oracle.dss.dataView.ComponentHandle

getComponent, getID, getName, setDataAccess

Methods inherited from class java.lang.Object

clone, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

EdgeComponentHandle

public 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. For example, take the following column header:

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.

Parameters:

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.

See Also:

DataDirector

EdgeComponentHandle

public 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.

Parameters:

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.

Method Detail

getEdge

public int getEdge()

Retrieves the edge that the cell is on.

Returns:

A constant, such as DataDirector.COLUMN_EDGE, that identifies the edge that the cell is on. Constants are defined in the DataDirector interface.

See Also:

DataDirector

getDepth

public int getDepth()

Retrieves the depth of the cell. The depth identifies the location of the dimension on the edge. For example, take the following column header:

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.

Returns:

The depth of the cell that this EdgeComponentInfo represents.

getIndex

public int getIndex()

Retrieves the index of the cell. Each dimension member of the innermost dimension has a unique, zero-based index. For example, take the following column header:

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:

• NY has index 0
• Boston has index 1
• LA has index 2
• Toronto has index 3
• Winnepeg has index 4
• and so on

Returns:

The index of the item that this EdgeComponentHandle represents

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 location of the represented item, as identified by its edge, depth, and index.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Retrieves the EdgeComponentInfo for the cell that this EdgeComponentHandle represents.

Specified by:

getComponentInfo in class ComponentHandle

Returns:

Information about the location of the represented item. The EdgeComponentInfo can be null, though this is not normal.

See Also:

DataComponentHandle

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class ComponentHandle

For internal use only. Application developers should not use this

Indicates whether the specified object is equivalent to this EdgeComponentHandle.