oracle.dss.util
Class DrillComponentInfo

java.lang.Object
  oracle.dss.util.ComponentInfo
      oracle.dss.util.DrillComponentInfo

All Implemented Interfaces:

java.io.Serializable, java.lang.Cloneable

public class DrillComponentInfo
extends ComponentInfo

Information about the location of a drilling component in an edge.

See Also:

Serialized Form

Constructor Summary

DrillComponentInfo(int edge, int layer)
Constructor.

Method Summary

java.lang.Object	clone() Clones this DrillComponentInfo.
boolean	equals(java.lang.Object o) Indicates whether the specified object is equivalent to this DrillComponentInfo.
int	getEdge() Retrieves the edge that the component is on.
int	getLayer() Retrieves the layer of the component.
QDR	getQDR(DataAccess dataAccess, int flags) Retrieves a QDR for this DrillComponentInfo.
int	hashCode()
java.lang.String	toString() Generates as String representation of this DrillComponentInfo.

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

DrillComponentInfo

public DrillComponentInfo(int edge,
                          int layer)

Constructor.

Parameters:

edge - The edge that the component is on.

layer - The layer within edge. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.

Method Detail

clone

public java.lang.Object clone()

Clones this DrillComponentInfo.

Specified by:

clone in class ComponentInfo

Returns:

The clone of this DrillComponentInfo.

getEdge

public int getEdge()

Retrieves the edge that the component is on.

Returns:

A constant that represents the edge. 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 component. The layer identifies the location of the dimension or dimension member; 0 is the outer-most dimension on the edge.

Returns:

The layer of the component.

equals

public boolean equals(java.lang.Object o)

Indicates whether the specified object is equivalent to this DrillComponentInfo. DrillComponentInfo objects are equivalent if they refer to the same edge and layer.

Overrides:

equals in class java.lang.Object

Parameters:

o - The object to compare with this DrillComponentInfo.

Returns:

true if both objects refer to the same edge and layer. false if not or if o is not an DrillComponentInfo.

getQDR

public QDR getQDR(DataAccess dataAccess,
                  int flags)

Retrieves a QDR for this DrillComponentInfo.

Specified by:

getQDR in class ComponentInfo

Parameters:

dataAccess - The DataAccess that provided the data for the component that this DrillComponentInfo 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 header cell that this DrillComponentInfo describes.

See Also:

DataAccess.QDR_WITH_PAGE, DataAccess.QDR_WITHOUT_PAGE

hashCode

public int hashCode()

Specified by:

hashCode in class ComponentInfo

For internal use only. Application developers should not use this

toString

public java.lang.String toString()

Generates as String representation of this DrillComponentInfo. The String identifies the edge and layer of the component.

Overrides:

toString in class java.lang.Object

Returns:

The edge number and the layer, in a String.