oracle.dss.dataView

Class ColumnComponentHandle

java.lang.Object

oracle.dss.dataView.ComponentHandle

oracle.dss.dataView.ColumnComponentHandle

All Implemented Interfaces:

java.io.Serializable

public class ColumnComponentHandle
extends ComponentHandle

Represents a a column in the databody of a crosstab or table. This is normally a selected column, or the column 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
ColumnComponentHandle(int id, java.lang.String name, java.lang.Object comp, ColumnComponentInfo info) Constructor that uses a ColumComponentInfo to specify the column.
ColumnComponentHandle(int id, java.lang.String name, java.lang.Object comp, int column) Constructor that uses a int to specify the column.

Method Summary

Modifier and Type	Method and Description
boolean	equals(java.lang.Object o)
int	getColumn() Retrieves the number of the column that this ColumnComponentHandle represents.
ComponentInfo	getComponentInfo() Retrieves the ColumnComponentInfo for the column that this ColumnComponentHandle represents.
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

ColumnComponentHandle

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

Constructor that uses a int to specify the column.

Parameters:

id - A constant, such as GridView.DATA_COLUMN, that identifies the component or kind of column that this ColumnComponentHandle represents. Other usable constants are Crosstab.COL_HIGHLIGHTER and Crosstab.ROW_GRABBER.

name - The name of the represented component.

comp - The actual reference to the component.

column - The column that this component represents. Column numbers start at zero.

ColumnComponentHandle

public ColumnComponentHandle(int id,
                             java.lang.String name,
                             java.lang.Object comp,
                             ColumnComponentInfo info)

Constructor that uses a ColumComponentInfo to specify the column.

Parameters:

id - A constant, such as GridView.DATA_COLUMN, that identifies the component or kind of column that this ColumnComponentHandle represents. Other usable constants are Crosstab.COL_HIGHLIGHTER and Crosstab.ROW_GRABBER.

name - The name of the represented component.

comp - The actual reference to the component.

info - The ColumnComponentInfo that specifies the column.

Method Detail

getColumn

public int getColumn()

Retrieves the number of the column that this ColumnComponentHandle represents. This method gets the information from the ColumnComponentInfo. Column numbers begin at zero.

Returns:

The column number.

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 the column that this ColumnComponentHandle represents. Column numbers begin at zero.

Overrides:

toString in class java.lang.Object

Returns:

The String representation of this object.

getComponentInfo

public ComponentInfo getComponentInfo()

Retrieves the ColumnComponentInfo for the column that this ColumnComponentHandle represents.

Specified by:

getComponentInfo in class ComponentHandle

Returns:

Information about the represented column. The ColumnComponentInfo 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 ColumnComponentHandle.