Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


oracle.dss.util
Class ColumnComponentInfo

java.lang.Object
  |
  +--oracle.dss.util.ComponentInfo
        |
        +--oracle.dss.util.ColumnComponentInfo
All Implemented Interfaces:
java.lang.Cloneable

public class ColumnComponentInfo
extends ComponentInfo

Column information about a DataView component. Used for components that have data associated with them.


Constructor Summary
ColumnComponentInfo(int column)
          Constructor.

 

Method Summary
 java.lang.Object clone()
          Clones this ColumnComponentInfo.
 boolean equals(java.lang.Object o)
          Indicates whether the specified object is equivalent to this ColumnComponentInfo.
 int getColumn()
          Retrieves the column number.
 QDR getQDR(DataAccess dataAccess, int flags)
          Retrieves a QDR for this ColumnComponentInfo.
 void setColumn(int col)
          Sets the column.
 java.lang.String toString()
          Produces a String that identifies the column.

 

Methods inherited from class java.lang.Object
getClass, hashCode, notify, notifyAll, wait, wait, wait

 

Constructor Detail

ColumnComponentInfo

public ColumnComponentInfo(int column)
Constructor.
Parameters:
column - The column that the component is in.
Method Detail

clone

public java.lang.Object clone()
Clones this ColumnComponentInfo.
Overrides:
clone in class ComponentInfo
Returns:
The clone of this ColumnComponentInfo.

setColumn

public void setColumn(int col)
Sets the column. This method allows reuse of this ColumnComponentInfo.
Parameters:
col - The column for which you want to use this ColumnComponentInfo.

getColumn

public int getColumn()
Retrieves the column number. Column numbers start at zero.
Returns:
The column number.

equals

public boolean equals(java.lang.Object o)
Indicates whether the specified object is equivalent to this ColumnComponentInfo. ColumnComponentInfo objects are equivalent if they refer to the same column.
Overrides:
equals in class java.lang.Object
Parameters:
o - The object to compare with this ColumnComponentInfo.
Returns:
true if both objects refer to the same column, false if not or if o is not a ColumnComponentInfo.

getQDR

public QDR getQDR(DataAccess dataAccess,
                  int flags)
Retrieves a QDR for this ColumnComponentInfo. The QDR identifies the dimension members for the data column for which this ColumnComponentInfo provides information.

For example, say you have the following column header in a crosstab.

Boston Paris
January 2000 February 2000 January 2000 February 2000

In a ColumnComponentInfo for the first column in the databody that corresponds to this column header, the QDR limits Geography to Boston, and it limits Time to January 2000.

Overrides:
getQDR in class ComponentInfo
Parameters:
dataAccess - The DataAccess that provided the data for the column that this ColumnComponentInfo describes.
flags - A constant that identifies whether to include page edge information if the QDR is not for the page edge. Valid constants are listed in the See Also section.
Returns:
A QDR that identifies the column of data that this ColumnComponentInfo describes.
See Also:
DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

toString

public java.lang.String toString()
Produces a String that identifies the column.
Overrides:
toString in class java.lang.Object
Returns:
The column number, in a String.

Oracle™ Business Intelligence Beans Java API Reference
Release 10
g (9.0.4)
Part number B12159_01


Copyright © 2003, Oracle. All Rights Reserved.