oracle.dss.dataView

Class DataRangeComponentHandle

java.lang.Object

oracle.dss.dataView.ComponentHandle

oracle.dss.dataView.DataRangeComponentHandle

All Implemented Interfaces:

java.io.Serializable

public class DataRangeComponentHandle
extends ComponentHandle

Represents a range of cells in the databody of a table or crosstab. This is normally a selected range, or the range of data cells that you want to select programmatically.

See Also:

Serialized Form

Field Summary

Fields inherited from class oracle.dss.dataView.ComponentHandle

m_dataAccess

Constructor Summary

Constructors

Constructor and Description
DataRangeComponentHandle(int id, java.lang.String name, java.lang.Object comp, DataComponentInfo[] rclist) Constructor.

Method Summary

Methods

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
ComponentInfo	getComponentInfo() Returns the DataComponentInfo for the first cell in the range.
DataComponentInfo[]	getLocationList() Retrieves the array of DataComponentInfo objects for this DataRangeComponentHandle.
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

DataRangeComponentHandle

public DataRangeComponentHandle(int id,
                        java.lang.String name,
                        java.lang.Object comp,
                        DataComponentInfo[] rclist)

Constructor.

Parameters:

id - The constant GridView.DATA_CELL_RANGE, which identifies this as a handle for a range of data cells.

name - The name of the represented component.

comp - The actual reference to the component.

rclist - Information about the row and column for each cell in the range.

Method Detail

getLocationList

public DataComponentInfo[] getLocationList()

Retrieves the array of DataComponentInfo objects for this DataRangeComponentHandle. The array contains a DataComponentInfo for each cell in the range.

Returns:

An array of DataComponentInfo objects.

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, the number of cells in the range, the row and column number of the first cell, and the row and column of the and last cell in the range. Row and column numbers begin at zero.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Returns the DataComponentInfo for the first cell in the range. The first cell is at the intersection of the first row and the first column.

Specified by:

getComponentInfo in class ComponentHandle

Returns:

The DataComponentInfo for the cell in the range. The DataComponentInfo 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 DataRangeComponentHandle.