oracle.dss.dataView

Class DrillComponentHandle

java.lang.Object

oracle.dss.dataView.ComponentHandle

oracle.dss.dataView.DrillComponentHandle

All Implemented Interfaces:

java.io.Serializable

public class DrillComponentHandle
extends ComponentHandle

Represents a Graph component that indicates drilling, and provides information about the edge and layer of the component.

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.dss.dataView.ComponentHandle

m_dataAccess

Constructor Summary

Constructors

Constructor and Description
DrillComponentHandle(int id, java.lang.String name, java.lang.Object comp, int edge, int layer) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
ComponentInfo	getComponentInfo() Retrieves the DrillComponentInfo for the component that this DrillComponentHandle represents.
int	getEdge() Retrieves the edge that the drilling component is on.
int	getLayer() Retrieves the layer of the drilling component.
java.lang.String	toString() Generates a String representation of this DrillComponentHandle.

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

DrillComponentHandle

public DrillComponentHandle(int id,
                            java.lang.String name,
                            java.lang.Object comp,
                            int edge,
                            int layer)

Constructor.

Parameters:

id - A constant that identifies the component that this DrillComponentHandle represents.

name - The name of the represented component.

comp - The actual reference to the component.

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

layer - The layer of the cell that this DrillComponentHandle represents.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

Method Detail

toString

public java.lang.String toString()

Generates a String representation of this DrillComponentHandle. The String contains the name of this class, the name of the component, and location of the represented item, as identified by its edge and layer.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getEdge

public int getEdge()

Retrieves the edge that the drilling component is on.

Returns:

A constant that identifies the edge that the cell is on. Valid constants are listed in the See Also section.

See Also:

DataDirector.COLUMN_EDGE, DataDirector.PAGE_EDGE, DataDirector.ROW_EDGE

getLayer

public int getLayer()

Retrieves the layer of the drilling component. The layer identifies the location of the dimension on the edge. Currently, only layer 0 (the outermost layer) is supported.

Returns:

The layer of the component that this DrillComponentHandle represents.

getComponentInfo

public ComponentInfo getComponentInfo()

Retrieves the DrillComponentInfo for the component that this DrillComponentHandle represents.

Specified by:

getComponentInfo in class ComponentHandle

Returns:

Information about the location of the represented item. The DrillComponentInfo 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 DrillComponentHandle.