oracle.dss.dataView

Class ComponentHandle

java.lang.Object

oracle.dss.dataView.ComponentHandle

All Implemented Interfaces:

java.io.Serializable

Direct Known Subclasses:

AnnotationComponentHandle, ColumnComponentHandle, ColumnRangeComponentHandle, DataComponentHandle, DataRangeComponentHandle, DrillComponentHandle, EdgeComponentHandle, EdgeRangeComponentHandle, GroupComponentHandle, NonDataComponentHandle, NonDataIndexComponentHandle, RowComponentHandle, RowRangeComponentHandle, SeriesComponentHandle

public abstract class ComponentHandle
extends java.lang.Object
implements java.io.Serializable

Represents a component in a Dataview. A ComponentHandle provides access to the component that it represents. It also provides information about the component, through the ComponentInfo object. Concrete subclasses of this class provide information that is specific to the kind of component they describe.

ComponentHandle classes are used by Dataview objects to pass access and information to other classes. For example, when you listen for a SelectEvent, you can access the selected component by getting the ComponentHandle object from the event.

See Also:

ComponentInfo, SelectEvent, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
protected DataAccess	m_dataAccess

Constructor Summary

Constructors

Constructor and Description
ComponentHandle(int id, java.lang.String name, java.lang.Object comp) Constructor.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
java.lang.Object	getComponent() Retrieves an actual reference to the component that this ComponentHandle represents.
abstract ComponentInfo	getComponentInfo() Retrieves the ComponentInfo for the component that this ComponentHandle represents.
int	getID() Retrieves the identifier of the component that this ComponentHandle represents.
java.lang.String	getName() Retrieves the name of the component that this ComponentHandle represents.
void	setDataAccess(DataAccess access) This is for internal use.

Methods inherited from class java.lang.Object

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

Field Detail

m_dataAccess

protected DataAccess m_dataAccess

Constructor Detail

ComponentHandle

public ComponentHandle(int id,
                       java.lang.String name,
                       java.lang.Object comp)

Constructor.

Parameters:

id - A constant, such as Dataview.SUBTITLE, that identifies the component that this ComponentHandle represents. Constants are defined in the Dataview class and in its subclasses.

name - The name of the component that this ComponentHandle represents.

comp - The actual reference to the component.

Method Detail

getID

public int getID()

Retrieves the identifier of the component that this ComponentHandle represents.

Returns:

A constant, such as FOOTNOTE, that identifies the represented component.

getName

public java.lang.String getName()

Retrieves the name of the component that this ComponentHandle represents.

Returns:

The name of the represented component.

getComponent

public java.lang.Object getComponent()

Retrieves an actual reference to the component that this ComponentHandle represents.

Returns:

A reference to the represented component.

getComponentInfo

public abstract ComponentInfo getComponentInfo()

Retrieves the ComponentInfo for the component that this ComponentHandle represents. Concrete subclasses return appropriate subclasses of the ComponentInfo class. For example, a DataComponentHandle returns a DataComponentInfo object, which provides the row and column of the component.

Returns:

Information about the component that this ComponentHandle represents. Returns null if there is no ComponentInfo or if the ComponentInfo is null.

See Also:

DataComponentHandle

equals

public boolean equals(java.lang.Object o)

Overrides:

equals in class java.lang.Object

For internal use only. Application developers should not use this

Indicates whether the specified object is equivalent to this ComponentHandle.

setDataAccess

public void setDataAccess(DataAccess access)

This is for internal use. Application developers do not need to call this method.

Parameters:

access -